From 5b029f4c14faacf54a127bb8c7ce765c1c0dbd50 Mon Sep 17 00:00:00 2001
From: Ned Coltman <edward.coltman@iws.uni-stuttgart.de>
Date: Tue, 17 Jul 2018 17:09:50 +0200
Subject: [PATCH] Cleanup/problem documentation
---
exercises/exercise-basic/injection2p2cproblem.hh | 16 +---------------
exercises/exercise-basic/injection2pniproblem.hh | 16 +---------------
exercises/exercise-basic/injection2pproblem.hh | 16 +---------------
exercises/exercise-grids/injection2pproblem.hh | 9 ---------
exercises/exercise-mainfile/1pproblem.hh | 4 ----
.../exercise-runtimeparams/injection2pproblem.hh | 9 ---------
.../exercise-basic/injection2pniproblem.hh | 16 +---------------
.../exercise-grids/injection2pproblem.hh | 9 ---------
.../solution/exercise-mainfile/1pproblem.hh | 16 ++++++++++------
.../exercise-runtimeparams/injection2pproblem.hh | 9 ---------
10 files changed, 14 insertions(+), 106 deletions(-)
diff --git a/exercises/exercise-basic/injection2p2cproblem.hh b/exercises/exercise-basic/injection2p2cproblem.hh
index 95ea53d1..39b0ab57 100644
--- a/exercises/exercise-basic/injection2p2cproblem.hh
+++ b/exercises/exercise-basic/injection2p2cproblem.hh
@@ -152,7 +152,6 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment.
*
- * \param bcTypes The boundary types for the conservation equations
* \param globalPos The position for which the bc type should be evaluated
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
@@ -181,12 +180,7 @@ public:
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
*
- * \param values Stores the Neumann values for the conservation equations in
- * \f$ [ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$
* \param globalPos The position of the integration point of the boundary segment.
- *
- * For this method, the \a values parameter stores the mass flux
- * in normal direction of each phase. Negative values mean influx.
*/
PrimaryVariables neumannAtPos(const GlobalPosition &globalPos) const
{
@@ -221,12 +215,7 @@ public:
* \brief Evaluate the source term for all phases within a given
* sub-control-volume.
*
- * For this method, the \a priVars parameter stores the rate mass
- * of a component is generated or annihilate per volume
- * unit. Positive values mean that mass is created, negative ones
- * mean that it vanishes.
- *
- * The units must be according to either using mole or mass fractions. (mole/(m^3*s) or kg/(m^3*s))
+ * \param globalPos The position for which the source term should be evaluated
*/
NumEqVector sourceAtPos(const GlobalPosition &globalPos) const
{
@@ -237,9 +226,6 @@ public:
* \brief Evaluate the initial value for a control volume.
*
* \param globalPos The position for which the initial condition should be evaluated
- *
- * For this method, the \a values parameter stores primary
- * variables.
*/
PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const
{
diff --git a/exercises/exercise-basic/injection2pniproblem.hh b/exercises/exercise-basic/injection2pniproblem.hh
index fb2bbe00..77e41762 100644
--- a/exercises/exercise-basic/injection2pniproblem.hh
+++ b/exercises/exercise-basic/injection2pniproblem.hh
@@ -147,7 +147,6 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment.
*
- * \param bcTypes The boundary types for the conservation equations
* \param globalPos The position for which the bc type should be evaluated
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
@@ -176,12 +175,7 @@ public:
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
*
- * \param values Stores the Neumann values for the conservation equations in
- * \f$ [ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$
* \param globalPos The position of the integration point of the boundary segment.
- *
- * For this method, the \a values parameter stores the mass flux
- * in normal direction of each phase. Negative values mean influx.
*/
PrimaryVariables neumannAtPos(const GlobalPosition &globalPos) const
{
@@ -220,12 +214,7 @@ public:
* \brief Evaluate the source term for all phases within a given
* sub-control-volume.
*
- * For this method, the \a priVars parameter stores the rate mass
- * of a component is generated or annihilate per volume
- * unit. Positive values mean that mass is created, negative ones
- * mean that it vanishes.
- *
- * The units must be according to either using mole or mass fractions. (mole/(m^3*s) or kg/(m^3*s))
+ * \param globalPos The position for which the source term should be evaluated
*/
NumEqVector sourceAtPos(const GlobalPosition &globalPos) const
{
@@ -236,9 +225,6 @@ public:
* \brief Evaluate the initial value for a control volume.
*
* \param globalPos The position for which the initial condition should be evaluated
- *
- * For this method, the \a values parameter stores primary
- * variables.
*/
PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const
{
diff --git a/exercises/exercise-basic/injection2pproblem.hh b/exercises/exercise-basic/injection2pproblem.hh
index 30099c50..aae87517 100644
--- a/exercises/exercise-basic/injection2pproblem.hh
+++ b/exercises/exercise-basic/injection2pproblem.hh
@@ -151,7 +151,6 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment.
*
- * \param bcTypes The boundary types for the conservation equations
* \param globalPos The position for which the bc type should be evaluated
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
@@ -182,12 +181,7 @@ public:
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
*
- * \param values Stores the Neumann values for the conservation equations in
- * \f$ [ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$
* \param globalPos The position of the integration point of the boundary segment.
- *
- * For this method, the \a values parameter stores the mass flux
- * in normal direction of each phase. Negative values mean influx.
*/
PrimaryVariables neumannAtPos(const GlobalPosition &globalPos) const
{
@@ -221,12 +215,7 @@ public:
* \brief Evaluate the source term for all phases within a given
* sub-control-volume.
*
- * For this method, the \a priVars parameter stores the rate mass
- * of a component is generated or annihilate per volume
- * unit. Positive values mean that mass is created, negative ones
- * mean that it vanishes.
- *
- * The units must be according to either using mole or mass fractions. (mole/(m^3*s) or kg/(m^3*s))
+ * \param globalPos The position for which the source term should be evaluated
*/
NumEqVector sourceAtPos(const GlobalPosition &globalPos) const
{
@@ -237,9 +226,6 @@ public:
* \brief Evaluate the initial value for a control volume.
*
* \param globalPos The position for which the initial condition should be evaluated
- *
- * For this method, the \a values parameter stores primary
- * variables.
*/
PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const
{
diff --git a/exercises/exercise-grids/injection2pproblem.hh b/exercises/exercise-grids/injection2pproblem.hh
index f1dd004c..ab11ae93 100644
--- a/exercises/exercise-grids/injection2pproblem.hh
+++ b/exercises/exercise-grids/injection2pproblem.hh
@@ -153,7 +153,6 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment.
*
- * \param bcTypes The boundary types for the conservation equations
* \param globalPos The position for which the bc type should be evaluated
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
@@ -184,12 +183,7 @@ public:
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
*
- * \param values Stores the Neumann values for the conservation equations in
- * \f$ [ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$
* \param globalPos The position of the integration point of the boundary segment.
- *
- * For this method, the \a values parameter stores the mass flux
- * in normal direction of each phase. Negative values mean influx.
*/
PrimaryVariables neumannAtPos(const GlobalPosition &globalPos) const
{
@@ -223,9 +217,6 @@ public:
* \brief Evaluate the initial value for a control volume.
*
* \param globalPos The position for which the initial condition should be evaluated
- *
- * For this method, the \a values parameter stores primary
- * variables.
*/
PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const
{
diff --git a/exercises/exercise-mainfile/1pproblem.hh b/exercises/exercise-mainfile/1pproblem.hh
index 32d4d5b8..3a8f3ae0 100644
--- a/exercises/exercise-mainfile/1pproblem.hh
+++ b/exercises/exercise-mainfile/1pproblem.hh
@@ -132,7 +132,6 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary control volume.
*
- * \param values The boundary types for the conservation equations
* \param globalPos The position of the center of the finite volume
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
@@ -152,10 +151,7 @@ public:
* \brief Evaluate the boundary conditions for a dirichlet
* control volume.
*
- * \param values The dirichlet values for the primary variables
* \param globalPos The center of the finite volume which ought to be set.
- *
- * For this method, the \a values parameter stores primary variables.
*/
PrimaryVariables dirichletAtPos(const GlobalPosition &globalPos) const
{
diff --git a/exercises/exercise-runtimeparams/injection2pproblem.hh b/exercises/exercise-runtimeparams/injection2pproblem.hh
index d06d8888..cdc33ece 100644
--- a/exercises/exercise-runtimeparams/injection2pproblem.hh
+++ b/exercises/exercise-runtimeparams/injection2pproblem.hh
@@ -153,7 +153,6 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment.
*
- * \param bcTypes The boundary types for the conservation equations
* \param globalPos The position for which the bc type should be evaluated
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
@@ -184,12 +183,7 @@ public:
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
*
- * \param values Stores the Neumann values for the conservation equations in
- * \f$ [ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$
* \param globalPos The position of the integration point of the boundary segment.
- *
- * For this method, the \a values parameter stores the mass flux
- * in normal direction of each phase. Negative values mean influx.
*/
PrimaryVariables neumannAtPos(const GlobalPosition &globalPos) const
{
@@ -224,9 +218,6 @@ public:
* \brief Evaluate the initial value for a control volume.
*
* \param globalPos The position for which the initial condition should be evaluated
- *
- * For this method, the \a values parameter stores primary
- * variables.
*/
PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const
{
diff --git a/exercises/solution/exercise-basic/injection2pniproblem.hh b/exercises/solution/exercise-basic/injection2pniproblem.hh
index 95c63a16..c8b82255 100644
--- a/exercises/solution/exercise-basic/injection2pniproblem.hh
+++ b/exercises/solution/exercise-basic/injection2pniproblem.hh
@@ -142,7 +142,6 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment.
*
- * \param bcTypes The boundary types for the conservation equations
* \param globalPos The position for which the bc type should be evaluated
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
@@ -171,12 +170,7 @@ public:
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
*
- * \param values Stores the Neumann values for the conservation equations in
- * \f$ [ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$
* \param globalPos The position of the integration point of the boundary segment.
- *
- * For this method, the \a values parameter stores the mass flux
- * in normal direction of each phase. Negative values mean influx.
*/
PrimaryVariables neumannAtPos(const GlobalPosition &globalPos) const
{
@@ -209,12 +203,7 @@ public:
* \brief Evaluate the source term for all phases within a given
* sub-control-volume.
*
- * For this method, the \a priVars parameter stores the rate mass
- * of a component is generated or annihilate per volume
- * unit. Positive values mean that mass is created, negative ones
- * mean that it vanishes.
- *
- * The units must be according to either using mole or mass fractions. (mole/(m^3*s) or kg/(m^3*s))
+ * \param globalPos The position for which the source term should be evaluated
*/
NumEqVector sourceAtPos(const GlobalPosition &globalPos) const
{
@@ -225,9 +214,6 @@ public:
* \brief Evaluate the initial value for a control volume.
*
* \param globalPos The position for which the initial condition should be evaluated
- *
- * For this method, the \a values parameter stores primary
- * variables.
*/
PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const
{
diff --git a/exercises/solution/exercise-grids/injection2pproblem.hh b/exercises/solution/exercise-grids/injection2pproblem.hh
index 91a384d5..0ac137c4 100644
--- a/exercises/solution/exercise-grids/injection2pproblem.hh
+++ b/exercises/solution/exercise-grids/injection2pproblem.hh
@@ -158,7 +158,6 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment.
*
- * \param bcTypes The boundary types for the conservation equations
* \param globalPos The position for which the bc type should be evaluated
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
@@ -189,12 +188,7 @@ public:
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
*
- * \param values Stores the Neumann values for the conservation equations in
- * \f$ [ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$
* \param globalPos The position of the integration point of the boundary segment.
- *
- * For this method, the \a values parameter stores the mass flux
- * in normal direction of each phase. Negative values mean influx.
*/
PrimaryVariables neumannAtPos(const GlobalPosition &globalPos) const
{
@@ -228,9 +222,6 @@ public:
* \brief Evaluate the initial value for a control volume.
*
* \param globalPos The position for which the initial condition should be evaluated
- *
- * For this method, the \a values parameter stores primary
- * variables.
*/
PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const
{
diff --git a/exercises/solution/exercise-mainfile/1pproblem.hh b/exercises/solution/exercise-mainfile/1pproblem.hh
index 063ae7c3..b484f75a 100644
--- a/exercises/solution/exercise-mainfile/1pproblem.hh
+++ b/exercises/solution/exercise-mainfile/1pproblem.hh
@@ -77,7 +77,7 @@ public:
// TODO: dumux-course-task
// set the OneP Incompressible local residual for the OnePIncompressible type tag. This provides an analytic jacobian to be used for the analytic solution. Change that by setting:
-//SET_TYPE_PROP(OnePIncompressible, LocalResidual, OnePIncompressibleLocalResidual<TypeTag>);
+SET_TYPE_PROP(OnePIncompressible, LocalResidual, OnePIncompressibleLocalResidual<TypeTag>);
// the fluid system for compressible tests
@@ -114,17 +114,24 @@ class OnePTestProblem : public PorousMediumFlowProblem<TypeTag>
using BoundaryTypes = typename GET_PROP_TYPE(TypeTag, BoundaryTypes);
static constexpr int dimWorld = GridView::dimensionworld;
using GlobalPosition = typename Element::Geometry::GlobalCoordinate;
+ using FluidSystem = typename GET_PROP_TYPE(TypeTag, FluidSystem);
public:
OnePTestProblem(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
- {}
+ {
+ FluidSystem::Component::init(/*tempMin=*/272.15,
+ /*tempMax=*/294.15,
+ /*numTemp=*/10,
+ /*pMin=*/1.0e4,
+ /*pMax=*/1.0e6,
+ /*numP=*/200);
+ }
/*!
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary control volume.
*
- * \param values The boundary types for the conservation equations
* \param globalPos The position of the center of the finite volume
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
@@ -144,10 +151,7 @@ public:
* \brief Evaluate the boundary conditions for a dirichlet
* control volume.
*
- * \param values The dirichlet values for the primary variables
* \param globalPos The center of the finite volume which ought to be set.
- *
- * For this method, the \a values parameter stores primary variables.
*/
PrimaryVariables dirichletAtPos(const GlobalPosition &globalPos) const
{
diff --git a/exercises/solution/exercise-runtimeparams/injection2pproblem.hh b/exercises/solution/exercise-runtimeparams/injection2pproblem.hh
index 5fb19997..953e36e7 100644
--- a/exercises/solution/exercise-runtimeparams/injection2pproblem.hh
+++ b/exercises/solution/exercise-runtimeparams/injection2pproblem.hh
@@ -159,7 +159,6 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment.
*
- * \param bcTypes The boundary types for the conservation equations
* \param globalPos The position for which the bc type should be evaluated
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
@@ -190,12 +189,7 @@ public:
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
*
- * \param values Stores the Neumann values for the conservation equations in
- * \f$ [ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$
* \param globalPos The position of the integration point of the boundary segment.
- *
- * For this method, the \a values parameter stores the mass flux
- * in normal direction of each phase. Negative values mean influx.
*/
PrimaryVariables neumannAtPos(const GlobalPosition &globalPos) const
{
@@ -230,9 +224,6 @@ public:
* \brief Evaluate the initial value for a control volume.
*
* \param globalPos The position for which the initial condition should be evaluated
- *
- * For this method, the \a values parameter stores primary
- * variables.
*/
PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const
{
--
GitLab