From 68b0e4994ba9c37eb5904e68d3619b86f7f9c664 Mon Sep 17 00:00:00 2001
From: Ned Coltman <edward.coltman@iws.uni-stuttgart.de>
Date: Wed, 21 Jul 2021 09:22:07 +0200
Subject: [PATCH] [rans][problem] add function descriptions
---
dumux/freeflow/rans/problem.hh | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/dumux/freeflow/rans/problem.hh b/dumux/freeflow/rans/problem.hh
index 475c203f54..8cbe30f2b9 100644
--- a/dumux/freeflow/rans/problem.hh
+++ b/dumux/freeflow/rans/problem.hh
@@ -358,6 +358,11 @@ private:
return std::all_of(wallFaceAxis.begin(), wallFaceAxis.end(), [firstDir=wallFaceAxis[0]](auto dir){ return (dir == firstDir);} ) ;
}
+ /*!
+ * \brief Use the boundary search algorithm to find the shortest distance to a wall for each element
+ *
+ * Also store the wall element's index, and its direction in the case of flat wall bounded problems
+ */
void findWallDistances_()
{
WallDistance wallInformation(this->gridGeometry(), WallDistance<GridGeometry>::atElementCenters,
@@ -398,6 +403,9 @@ private:
}
}
+ /*!
+ * \brief Store all direct neighbor indicies for each element
+ */
void findNeighborIndices_()
{
// search for neighbor Idxs
--
GitLab