diff --git a/src/core/grid_generator/SCIterator.h b/src/core/grid_generator/SCIterator.h index 942f83f2458e9a955ad5822106dfcd05b6ddc1b0..39fde5c03c7ef024db2d728a59e3fd3ecad875c4 100644 --- a/src/core/grid_generator/SCIterator.h +++ b/src/core/grid_generator/SCIterator.h @@ -29,8 +29,21 @@ namespace walberla { namespace grid_generator { -/// Helper class to generate points in a simple cubic structure within a certain domain +/// Helper class to generate points in a simple cubic structure within a certain domain. +/// The lattice is fixed by a point of reference (x). +/// \code +/// . . . . . . . . +/// +-----+ +/// . . . .|. . .|. +/// | | +/// . . . .|. . .|. +/// +-----+ +/// . . . . . . . . /// +/// . x . . . . . . +/// +/// . . . . . . . . +/// \endcode /// Usage: /// \code for (auto it = SCIterator::begin(...); it != SCIterator::end(); ++it) \endcode class SCIterator : public std::iterator< std::forward_iterator_tag, Vector3<real_t> >