From e1acd85825f4bd70255211c15e2343dfa675c299 Mon Sep 17 00:00:00 2001
From: Sebastian Eibl <sebastian.eibl@fau.de>
Date: Fri, 24 Nov 2017 16:01:00 +0100
Subject: [PATCH] made SCIterator doku clearer
---
src/core/grid_generator/SCIterator.h | 15 ++++++++++++++-
1 file changed, 14 insertions(+), 1 deletion(-)
diff --git a/src/core/grid_generator/SCIterator.h b/src/core/grid_generator/SCIterator.h
index 942f83f24..39fde5c03 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> >
--
GitLab