OpenFPM_pdata  4.1.0
Project that contain the implementation of distributed structures
grid_dist_lin_dx Class Reference

Distributed linearized key. More...

Detailed Description

Distributed linearized key.

Definition at line 194 of file grid_dist_key.hpp.

#include <grid_dist_key.hpp>

Public Member Functions

void setSub (size_t sub)
 Set the local grid. More...
 
size_t getSub () const
 Get the local grid. More...
 
size_t getKey () const
 Get the key. More...
 
size_t & getKeyRef ()
 Get the reference key. More...
 
bool operator== (const grid_dist_lin_dx &key_t)
 
 grid_dist_lin_dx (int g_c, size_t key)
 Constructor set the sub-domain grid and the position in local coordinates. More...
 
 grid_dist_lin_dx ()
 Constructor.
 
std::string to_string ()
 convert the key to string More...
 

Private Attributes

size_t g_c
 grid list counter
 
size_t key
 Local grid iterator.
 

Constructor & Destructor Documentation

◆ grid_dist_lin_dx()

grid_dist_lin_dx::grid_dist_lin_dx ( int  g_c,
size_t  key 
)
inline

Constructor set the sub-domain grid and the position in local coordinates.

Parameters
g_csub-domain
keykey

Definition at line 270 of file grid_dist_key.hpp.

Member Function Documentation

◆ getKey()

size_t grid_dist_lin_dx::getKey ( ) const
inline

Get the key.

Returns
the local key

Definition at line 229 of file grid_dist_key.hpp.

◆ getKeyRef()

size_t& grid_dist_lin_dx::getKeyRef ( )
inline

Get the reference key.

Returns
the local key

Definition at line 240 of file grid_dist_key.hpp.

◆ getSub()

size_t grid_dist_lin_dx::getSub ( ) const
inline

Get the local grid.

Returns
the id of the local grid

Definition at line 219 of file grid_dist_key.hpp.

◆ setSub()

void grid_dist_lin_dx::setSub ( size_t  sub)
inline

Set the local grid.

Parameters
sublocal grid

Definition at line 209 of file grid_dist_key.hpp.

◆ to_string()

std::string grid_dist_lin_dx::to_string ( )
inline

convert the key to string

Definition at line 282 of file grid_dist_key.hpp.


The documentation for this class was generated from the following file: