From 328513f23580971700ae30bfe5dce88d48aa2fac Mon Sep 17 00:00:00 2001
From: Roman Winter <rwinter@shrek.iws.uni-stuttgart.de>
Date: Mon, 2 Nov 2020 11:27:56 +0100
Subject: [PATCH] [cleanup] changed description for fluidmatrixinterations
---
exercises/exercise-basic/spatialparams.hh | 6 +-----
.../exercise-biomineralization/biominspatialparams.hh | 6 +-----
exercises/exercise-coupling-ff-pm/2pspatialparams.hh | 6 +-----
exercises/exercise-fluidsystem/spatialparams.hh | 8 ++------
exercises/exercise-fractures/README.md | 4 ++--
exercises/exercise-fractures/fracturespatialparams.hh | 5 +----
exercises/exercise-fractures/matrixspatialparams.hh | 6 +-----
exercises/exercise-grids/spatialparams.hh | 6 +-----
exercises/exercise-properties/spatialparams.hh | 6 +-----
exercises/exercise-runtimeparams/spatialparams.hh | 6 +-----
exercises/solution/exercise-basic/spatialparams.hh | 6 +-----
.../exercise-biomineralization/biominspatialparams.hh | 6 +-----
.../exercise-coupling-ff-pm/2pspatialparams.hh | 6 +-----
.../solution/exercise-fluidsystem/spatialparams.hh | 10 +++-------
.../exercise-fractures/fracturespatialparams.hh | 7 ++-----
.../solution/exercise-fractures/matrixspatialparams.hh | 8 ++------
exercises/solution/exercise-grids/spatialparams.hh | 6 +-----
.../solution/exercise-properties/spatialparams.hh | 6 +-----
.../solution/exercise-runtimeparams/spatialparams.hh | 6 +-----
19 files changed, 25 insertions(+), 95 deletions(-)
diff --git a/exercises/exercise-basic/spatialparams.hh b/exercises/exercise-basic/spatialparams.hh
index 354caeda..e3dac534 100644
--- a/exercises/exercise-basic/spatialparams.hh
+++ b/exercises/exercise-basic/spatialparams.hh
@@ -108,11 +108,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
- *
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
diff --git a/exercises/exercise-biomineralization/biominspatialparams.hh b/exercises/exercise-biomineralization/biominspatialparams.hh
index e147f8fe..ab63115c 100644
--- a/exercises/exercise-biomineralization/biominspatialparams.hh
+++ b/exercises/exercise-biomineralization/biominspatialparams.hh
@@ -245,11 +245,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
- *
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
diff --git a/exercises/exercise-coupling-ff-pm/2pspatialparams.hh b/exercises/exercise-coupling-ff-pm/2pspatialparams.hh
index 7a6f7360..9727e1f5 100644
--- a/exercises/exercise-coupling-ff-pm/2pspatialparams.hh
+++ b/exercises/exercise-coupling-ff-pm/2pspatialparams.hh
@@ -85,11 +85,7 @@ public:
{ return alphaBJ_; }
/*!
- * \brief Returns the parameters for the material law at a given location
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
- *
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
diff --git a/exercises/exercise-fluidsystem/spatialparams.hh b/exercises/exercise-fluidsystem/spatialparams.hh
index a9390531..1da703d6 100644
--- a/exercises/exercise-fluidsystem/spatialparams.hh
+++ b/exercises/exercise-fluidsystem/spatialparams.hh
@@ -28,7 +28,7 @@
// include parent spatialparameters
#include <dumux/material/spatialparams/fv.hh>
-// include material laws
+//inlclude fluid matrix interaction relationship
#include <dumux/material/fluidmatrixinteractions/2p/brookscorey.hh>
#include <dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh>
@@ -107,11 +107,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
- *
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
diff --git a/exercises/exercise-fractures/README.md b/exercises/exercise-fractures/README.md
index e5778b02..e8a07c7e 100644
--- a/exercises/exercise-fractures/README.md
+++ b/exercises/exercise-fractures/README.md
@@ -131,7 +131,7 @@ Furthermore, modify the function `dirichletAtPos(...)` in `matrixproblem.hh` suc
In this part, we want to change the parameterization of the fractures such that they act as both hydraulic and capillary barriers. In the `fracturespatialparams.hh` file you will see that the spatial parameters class already contains a set of parameters with the post-fix _Barrier_, which are read in from the input file in the class constructor.
-Use these as return values for porosity, permeability and material law parameters. Take a look at the results.
+Use these as return values for porosity, permeability and fluid-matrix interaction parameters. Take a look at the results.
You will see that only little nitrogen enters the domain, but if you display the pressure distribution in the matrix, you will notice that we cannot observe the pressure distribution we would expect. With the fracture permeabilities being this much lower than the matrix permeability, we would expect substantial pressure drops to be visible across them.
@@ -193,7 +193,7 @@ int getElementDomainMarker(const Element& element) const
The domain markers are also already added to the output (see `main.cc`, search for `// add domain markers to output`). To visualize them, open any of your previously produced results with _Paraview_ and take a look at them by selecting __domainMarker__.
-Adjust the functions for permeability, porosity and material law parameters in the `fracturespatialparams.hh` file such that they are selected depending on the domain marker of the elements. You will see in the results that the pressure jump across the first vertical fracture is now lower than before, because there are highly permeable fractures crossing it, allowing for a pressure release into the other parts of the domain.
+Adjust the functions for permeability, porosity and fluid-matrix interaction parameters in the `fracturespatialparams.hh` file such that they are selected depending on the domain marker of the elements. You will see in the results that the pressure jump across the first vertical fracture is now lower than before, because there are highly permeable fractures crossing it, allowing for a pressure release into the other parts of the domain.
## Additional task:
diff --git a/exercises/exercise-fractures/fracturespatialparams.hh b/exercises/exercise-fractures/fracturespatialparams.hh
index 85113fb0..61bdf4fc 100644
--- a/exercises/exercise-fractures/fracturespatialparams.hh
+++ b/exercises/exercise-fractures/fracturespatialparams.hh
@@ -101,10 +101,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law for the sub-control volume
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
+ * \brief Returns the fluid-matrix interaction law for the sub-control volume
*
* \param element The current finite element
* \param scv The sub-control volume
diff --git a/exercises/exercise-fractures/matrixspatialparams.hh b/exercises/exercise-fractures/matrixspatialparams.hh
index b6c77c8e..939e488d 100644
--- a/exercises/exercise-fractures/matrixspatialparams.hh
+++ b/exercises/exercise-fractures/matrixspatialparams.hh
@@ -79,11 +79,7 @@ public:
{ return porosity_; }
/*!
- * \brief Returns the parameters for the material law at a given location
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
- *
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
diff --git a/exercises/exercise-grids/spatialparams.hh b/exercises/exercise-grids/spatialparams.hh
index ea7e3084..433e3f6b 100644
--- a/exercises/exercise-grids/spatialparams.hh
+++ b/exercises/exercise-grids/spatialparams.hh
@@ -109,11 +109,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
- *
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
diff --git a/exercises/exercise-properties/spatialparams.hh b/exercises/exercise-properties/spatialparams.hh
index fa106e87..90af3c6f 100644
--- a/exercises/exercise-properties/spatialparams.hh
+++ b/exercises/exercise-properties/spatialparams.hh
@@ -91,11 +91,7 @@ public:
{ return 0.4; }
/*!
- * \brief Returns the parameters for the material law at a given location
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
- *
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
diff --git a/exercises/exercise-runtimeparams/spatialparams.hh b/exercises/exercise-runtimeparams/spatialparams.hh
index 4a0327a6..a6b67613 100644
--- a/exercises/exercise-runtimeparams/spatialparams.hh
+++ b/exercises/exercise-runtimeparams/spatialparams.hh
@@ -109,11 +109,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
- *
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
diff --git a/exercises/solution/exercise-basic/spatialparams.hh b/exercises/solution/exercise-basic/spatialparams.hh
index 75d073b7..b6c1e80d 100644
--- a/exercises/solution/exercise-basic/spatialparams.hh
+++ b/exercises/solution/exercise-basic/spatialparams.hh
@@ -108,11 +108,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
- *
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
diff --git a/exercises/solution/exercise-biomineralization/biominspatialparams.hh b/exercises/solution/exercise-biomineralization/biominspatialparams.hh
index 1f70ef5d..fed4a8d6 100644
--- a/exercises/solution/exercise-biomineralization/biominspatialparams.hh
+++ b/exercises/solution/exercise-biomineralization/biominspatialparams.hh
@@ -245,11 +245,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
- *
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
diff --git a/exercises/solution/exercise-coupling-ff-pm/2pspatialparams.hh b/exercises/solution/exercise-coupling-ff-pm/2pspatialparams.hh
index 7a6f7360..9727e1f5 100644
--- a/exercises/solution/exercise-coupling-ff-pm/2pspatialparams.hh
+++ b/exercises/solution/exercise-coupling-ff-pm/2pspatialparams.hh
@@ -85,11 +85,7 @@ public:
{ return alphaBJ_; }
/*!
- * \brief Returns the parameters for the material law at a given location
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
- *
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
diff --git a/exercises/solution/exercise-fluidsystem/spatialparams.hh b/exercises/solution/exercise-fluidsystem/spatialparams.hh
index befc4d56..48f87a50 100644
--- a/exercises/solution/exercise-fluidsystem/spatialparams.hh
+++ b/exercises/solution/exercise-fluidsystem/spatialparams.hh
@@ -28,7 +28,7 @@
// include parent spatialparameters
#include <dumux/material/spatialparams/fv.hh>
-// include material laws
+//inlclude fluid matrix interaction relationship
#include <dumux/material/fluidmatrixinteractions/2p/brookscorey.hh>
#include <dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh>
@@ -106,11 +106,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
- *
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
@@ -157,7 +153,7 @@ private:
Dune::FieldMatrix<Scalar, dim, dim> K_;
Dune::FieldMatrix<Scalar, dim, dim> KLens_;
- // Object that holds the values/parameters of the selected material law.
+ // Object that holds the values/parameters of the selected fluid matrix interaction relationship
const PcKrSwCurve pcKrSwCurve_;
const PcKrSwCurve lensPcKrSwCurve_;
};
diff --git a/exercises/solution/exercise-fractures/fracturespatialparams.hh b/exercises/solution/exercise-fractures/fracturespatialparams.hh
index 264c0b66..81bc286b 100644
--- a/exercises/solution/exercise-fractures/fracturespatialparams.hh
+++ b/exercises/solution/exercise-fractures/fracturespatialparams.hh
@@ -53,7 +53,7 @@ class FractureSpatialParams
using Element = typename GridView::template Codim<0>::Entity;
using GlobalPosition = typename Element::Geometry::GlobalCoordinate;
- // use a regularized van-genuchten material law
+ // use a van-genuchten fluid matrix interaction relationship
using PcKrSwCurve = FluidMatrix::VanGenuchtenDefault<Scalar>;
// we identify those fractures as barriers, that have a domain marker
@@ -131,10 +131,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law for the sub-control volume
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
+ * \brief Returns the fluid-matrix interaction law for the sub-control volume
*
* \param element The current finite element
* \param scv The sub-control volume
diff --git a/exercises/solution/exercise-fractures/matrixspatialparams.hh b/exercises/solution/exercise-fractures/matrixspatialparams.hh
index e8f45aa8..1f049007 100644
--- a/exercises/solution/exercise-fractures/matrixspatialparams.hh
+++ b/exercises/solution/exercise-fractures/matrixspatialparams.hh
@@ -52,7 +52,7 @@ class MatrixSpatialParams
using Element = typename GridView::template Codim<0>::Entity;
using GlobalPosition = typename Element::Geometry::GlobalCoordinate;
- // use a regularized van-genuchten material law
+ // use a van-genuchten fluid matrix interaction relationship
using PcKrSwCurve = FluidMatrix::VanGenuchtenDefault<Scalar>;
public:
@@ -80,11 +80,7 @@ public:
{ return porosity_; }
/*!
- * \brief Returns the parameters for the material law at a given location
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
- *
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
diff --git a/exercises/solution/exercise-grids/spatialparams.hh b/exercises/solution/exercise-grids/spatialparams.hh
index ea7e3084..433e3f6b 100644
--- a/exercises/solution/exercise-grids/spatialparams.hh
+++ b/exercises/solution/exercise-grids/spatialparams.hh
@@ -109,11 +109,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
- *
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
diff --git a/exercises/solution/exercise-properties/spatialparams.hh b/exercises/solution/exercise-properties/spatialparams.hh
index fa106e87..90af3c6f 100644
--- a/exercises/solution/exercise-properties/spatialparams.hh
+++ b/exercises/solution/exercise-properties/spatialparams.hh
@@ -91,11 +91,7 @@ public:
{ return 0.4; }
/*!
- * \brief Returns the parameters for the material law at a given location
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
- *
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
diff --git a/exercises/solution/exercise-runtimeparams/spatialparams.hh b/exercises/solution/exercise-runtimeparams/spatialparams.hh
index 617cd87a..869a826b 100644
--- a/exercises/solution/exercise-runtimeparams/spatialparams.hh
+++ b/exercises/solution/exercise-runtimeparams/spatialparams.hh
@@ -109,11 +109,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
- *
- * This method is not actually required by the Richards model, but provided
- * for the convenience of the RichardsLensProblem
- *
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
--
GitLab