From d6a0d7694403ca36cd5a8ecaf18980244667e333 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dennis=20Gl=C3=A4ser?= <dennis.glaeser@iws.uni-stuttgart.de>
Date: Fri, 20 Oct 2023 14:42:05 +0200
Subject: [PATCH] [examples][shallowwater][properties] cleanup
---
examples/shallowwaterfriction/properties.hh | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/examples/shallowwaterfriction/properties.hh b/examples/shallowwaterfriction/properties.hh
index bb06974a95..849acbf5dc 100644
--- a/examples/shallowwaterfriction/properties.hh
+++ b/examples/shallowwaterfriction/properties.hh
@@ -45,12 +45,10 @@
// are inherited. These other type tag definitions can be found in the included
// headers `dumux/freeflow/shallowwater/model.hh` and `dumux/discretization/cctpfa.hh`.
// [[codeblock]]
-// We enter the namespace Dumux::Properties in order to import the entire Dumux namespace for general use:
namespace Dumux::Properties {
-
namespace TTag {
struct RoughChannel { using InheritsFrom = std::tuple<ShallowWater, CCTpfaModel>; };
-}
+} // end namespace TTag
// [[/codeblock]]
// ### Property specializations
@@ -82,9 +80,11 @@ struct SpatialParams<TypeTag, TTag::RoughChannel>
};
// [[/codeblock]]
-// Finally, we enable caching for the grid geometry. The cache
-// stores values that were already calculated for later usage.
-// This makes the simulation run faster but it uses more memory.
+// Finally, we enable caching for the grid geometry. When this feature
+// is enabled, the entire finite-volume grid is precomputed and stored
+// instead of preparing element-local geometries on the fly when assembling
+// the linear system. This speeds up the simulation at the cost of a larger
+// memory footprint.
template<class TypeTag>
struct EnableGridGeometryCache<TypeTag, TTag::RoughChannel>
{ static constexpr bool value = true; };
--
GitLab