Commit e1acd858 authored by Sebastian Eibl's avatar Sebastian Eibl

made SCIterator doku clearer

parent 771931bf
Pipeline #5950 passed with stage
in 81 minutes and 43 seconds
......@@ -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> >
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment