template<unsigned int dim, typename stencil = no_stencil, typename warn = print_warning_on_adjustment<dim>>
class grid_key_dx_iterator_sub< dim, stencil, warn >
Declaration grid_key_dx_iterator_sub.
Grid key class iterator, iterate through a sub-grid defined by an hyper-cube
- Parameters
-
dim | dimensionality of the grid |
- Note
- if you have a grid you can get this object from getIteratorSub()
Sub grid iterator declaration and usage
Definition at line 77 of file grid_sm.hpp.
|
| grid_key_dx_iterator_sub () |
| Default constructor. More...
|
|
| grid_key_dx_iterator_sub (const grid_key_dx_iterator_sub< dim, stencil > &g_s_it) |
| Constructor from another grid_key_dx_iterator_sub. More...
|
|
template<typename T > |
| grid_key_dx_iterator_sub (const grid_sm< dim, T > &g, const grid_key_dx< dim > &start, const grid_key_dx< dim > &stop) |
| Constructor require a grid grid<dim,T> More...
|
|
template<typename T > |
| grid_key_dx_iterator_sub (const grid_sm< dim, T > &g, const grid_key_dx< dim > &start, const grid_key_dx< dim > &stop, const grid_key_dx< dim >(&stencil_pnt)[stencil::nsp]) |
| Constructor require a grid grid<dim,T> More...
|
|
| grid_key_dx_iterator_sub (const grid_key_dx< dim >(&stencil_pnt)[stencil::nsp]) |
| Constructor. More...
|
|
template<typename T > |
| grid_key_dx_iterator_sub (const grid_sm< dim, T > &g, const size_t m) |
| Constructor require a grid grid<dim,T> More...
|
|
template<typename T > |
| grid_key_dx_iterator_sub (const grid_sm< dim, T > &g, const size_t(&start)[dim], const size_t(&stop)[dim]) |
| Constructor require a grid grid<dim,T> More...
|
|
grid_key_dx_iterator_sub< dim,
stencil, warn > & | operator++ () |
| Get the next element. More...
|
|
grid_key_dx_iterator_sub< dim,
stencil, warn > & | operator+= (int nsteps) |
| increment the operator by more than one More...
|
|
bool | isNext () |
| Check if there is the next element. More...
|
|
grid_key_dx< dim > | get () const |
| Return the actual grid key iterator. More...
|
|
void | reinitialize (const grid_key_dx_iterator_sub< dim > &g_s_it) |
| Reinitialize the iterator. More...
|
|
size_t | getVolume () |
| Get the volume spanned by this sub-grid iterator. More...
|
|
void | reset () |
| Reset the iterator (it restart from the beginning) More...
|
|
const grid_sm< dim, void > & | getGridInfo () const |
| Return the grid information related to this grid. More...
|
|
const grid_key_dx< dim > & | getStart () const |
| Starting point. More...
|
|
const grid_key_dx< dim > & | getStop () const |
| Stop point. More...
|
|
template<unsigned int tot_add> |
void | private_sum () |
| Sum a template constant. More...
|
|
void | private_adjust (size_t tot_add) |
| Sum a template constant. More...
|
|
| grid_key_dx_iterator () |
| Default constructor. More...
|
|
| grid_key_dx_iterator (const grid_key_dx_iterator< dim > &g_it) |
| Constructor from a grid_key_dx_iterator<dim> More...
|
|
template<typename T > |
| grid_key_dx_iterator (const grid_sm< dim, T > &g, const grid_key_dx< dim >(&stencil_pnt)[stencil::nsp]) |
| Constructor require a grid_sm<dim,T> More...
|
|
| grid_key_dx_iterator (const grid_key_dx< dim >(&stencil_pnt)[stencil::nsp]) |
| Constructor. More...
|
|
template<typename T > |
| grid_key_dx_iterator (const grid_sm< dim, T > &g) |
| Constructor require a grid_sm<dim,T> More...
|
|
grid_key_dx_iterator< dim > | operator= (const grid_key_dx_iterator< dim > &key_it) |
| Constructor from another grid_key_dx_iterator. More...
|
|
grid_key_dx_iterator< dim,
stencil > & | operator++ () |
| Get the next element. More...
|
|
void | set (int d, size_t sz) |
| Set the dimension. More...
|
|
template<unsigned int id> |
size_t | getStencil () const |
| Get the actual position. More...
|
|
bool | isNext () |
| Check if there is the next element. More...
|
|
const grid_key_dx< dim > & | get () const |
| Get the actual key. More...
|
|
void | reinitialize (const grid_key_dx_iterator< dim > &key) |
| Reinitialize the grid_key_dx_iterator. More...
|
|
const grid_sm< dim, void > & | getGridInfo () const |
| Get the information about the grid. More...
|
|
void | reset () |
| Reset the iterator (it restart from the beginning) More...
|
|
void | calc_stencil_offset (const grid_key_dx< dim > &start_p) |
| Calculate the stencil offset. More...
|
|
grid_key_dx< dim > | getStart () |
| Return the starting point of the iteration. More...
|
|
grid_key_dx< dim > | getStop () |
| Return the stop point of the iteration. More...
|
|
size_t | getVolume () |
| Get the volume spanned by this sub-grid iterator. More...
|
|
template<unsigned int dim, typename stencil = no_stencil, typename warn = print_warning_on_adjustment<dim>>
Check if there is the next element.
Check if there is the next element
- Returns
- true if there is the next, false otherwise
we did not reach the end of the grid
we reach the end of the grid
Definition at line 503 of file grid_key_dx_iterator_sub.hpp.