grid_dist_amr_key< dim > Class Template Reference

Amr grid distributed key. More...

Detailed Description

template<unsigned int dim>
class grid_dist_amr_key< dim >

Amr grid distributed key.

Template Parameters

dim	dimensionality

Definition at line 17 of file grid_dist_amr_key.hpp.

#include <grid_dist_amr_key.hpp>

Public Member Functions
	grid_dist_amr_key (size_t lvl, grid_dist_key_dx< dim > key)
const grid_dist_key_dx< dim > &	getKey () const
	Return the grid key.
grid_dist_key_dx< dim > &	getKeyRef ()
	Return the grid key (as reference)
size_t	getLvl () const
	Return the level.
void	setLvl (size_t lvl)
	Return the level.
grid_dist_amr_key< dim >	moveSpace (size_t d, size_t s)
	Create a new key moving the old one.

Private Attributes
size_t	lvl
	actual level
grid_dist_key_dx< dim >	key
	actual position in the distributed grid

Constructor & Destructor Documentation

grid_dist_amr_key()

template<unsigned int dim>

grid_dist_amr_key< dim >::grid_dist_amr_key ( size_t  lvl, grid_dist_key_dx< dim >  key  )

inline

\constructor

Parameters

lvl	level
key	distributed grid key
offsets	to move between levels

Definition at line 35 of file grid_dist_amr_key.hpp.

Member Function Documentation

getKey()

template<unsigned int dim>

const grid_dist_key_dx< dim > & grid_dist_amr_key< dim >::getKey ( ) const

inline

Return the grid key.

Returns

the distributed key

Definition at line 45 of file grid_dist_amr_key.hpp.

getKeyRef()

template<unsigned int dim>

grid_dist_key_dx< dim > & grid_dist_amr_key< dim >::getKeyRef ( )

inline

Return the grid key (as reference)

Returns

the distributed key

Definition at line 55 of file grid_dist_amr_key.hpp.

getLvl()

template<unsigned int dim>

size_t grid_dist_amr_key< dim >::getLvl ( ) const

inline

Return the level.

Returns

the level

Definition at line 66 of file grid_dist_amr_key.hpp.

moveSpace()

template<unsigned int dim>

grid_dist_amr_key< dim > grid_dist_amr_key< dim >::moveSpace ( size_t  d, size_t  s  )

inline

Create a new key moving the old one.

Parameters

s	dimension id
s	number of steps

Returns

new key

Definition at line 89 of file grid_dist_amr_key.hpp.

setLvl()

template<unsigned int dim>

void grid_dist_amr_key< dim >::setLvl ( size_t  lvl )

inline

Return the level.

Parameters

lvl	level to set

Definition at line 76 of file grid_dist_amr_key.hpp.

Field Documentation

key

template<unsigned int dim>

grid_dist_key_dx<dim> grid_dist_amr_key< dim >::key

private

actual position in the distributed grid

Definition at line 23 of file grid_dist_amr_key.hpp.

lvl

template<unsigned int dim>

size_t grid_dist_amr_key< dim >::lvl

private

actual level

Definition at line 20 of file grid_dist_amr_key.hpp.

---

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

• src/Amr/grid_dist_amr_key.hpp