From 98f1c51a5b44360823cc75fccd58d124f2bcabd9 Mon Sep 17 00:00:00 2001 From: Edward 'Ned' Coltman Date: Tue, 17 Jul 2018 16:41:20 +0200 Subject: [PATCH 1/7] remove wrong documentation in the runtime params exercise --- exercises/exercise-runtimeparams/injection2pproblem.hh | 9 --------- .../exercise-runtimeparams/injection2pproblem.hh | 9 --------- 2 files changed, 18 deletions(-) diff --git a/exercises/exercise-runtimeparams/injection2pproblem.hh b/exercises/exercise-runtimeparams/injection2pproblem.hh index d06d888..cdc33ec 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-runtimeparams/injection2pproblem.hh b/exercises/solution/exercise-runtimeparams/injection2pproblem.hh index 5fb1999..953e36e 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 From cb6750437cb7ed25ec11861167649ad40c0e1668 Mon Sep 17 00:00:00 2001 From: Edward 'Ned' Coltman Date: Tue, 17 Jul 2018 16:41:55 +0200 Subject: [PATCH 2/7] remove bad documentation in the grids exercise --- exercises/exercise-grids/injection2pproblem.hh | 9 --------- exercises/solution/exercise-grids/injection2pproblem.hh | 9 --------- 2 files changed, 18 deletions(-) diff --git a/exercises/exercise-grids/injection2pproblem.hh b/exercises/exercise-grids/injection2pproblem.hh index f1dd004..ab11ae9 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/solution/exercise-grids/injection2pproblem.hh b/exercises/solution/exercise-grids/injection2pproblem.hh index 91a384d..0ac137c 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 { -- GitLab From 62c9f6aef7f55bff4e5eb076234a0ecb6a7d6b73 Mon Sep 17 00:00:00 2001 From: Edward 'Ned' Coltman Date: Tue, 17 Jul 2018 16:43:13 +0200 Subject: [PATCH 3/7] removed the bad documentation in ine basic exercise --- exercises/exercise-basic/injection2p2cproblem.hh | 9 --------- exercises/exercise-basic/injection2pniproblem.hh | 16 +--------------- exercises/exercise-basic/injection2pproblem.hh | 16 +--------------- .../exercise-basic/injection2pniproblem.hh | 16 +--------------- 4 files changed, 3 insertions(+), 54 deletions(-) diff --git a/exercises/exercise-basic/injection2p2cproblem.hh b/exercises/exercise-basic/injection2p2cproblem.hh index 95ea53d..53ea143 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 { @@ -237,9 +231,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 fb2bbe0..b765aa1 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 of the integration point of the boundary segment. */ 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 30099c5..d0c7a38 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 of the integration point of the boundary segment. */ 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/solution/exercise-basic/injection2pniproblem.hh b/exercises/solution/exercise-basic/injection2pniproblem.hh index 95c63a1..1a9983b 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 global position */ 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 { -- GitLab From 5bc9850e9eeba549e427e97f09c6685e3d999efe Mon Sep 17 00:00:00 2001 From: Edward 'Ned' Coltman Date: Tue, 17 Jul 2018 16:43:13 +0200 Subject: [PATCH 4/7] removed the bad documentation in the basic exercise --- exercises/exercise-basic/injection2p2cproblem.hh | 9 --------- exercises/exercise-basic/injection2pniproblem.hh | 16 +--------------- exercises/exercise-basic/injection2pproblem.hh | 16 +--------------- .../exercise-basic/injection2pniproblem.hh | 16 +--------------- 4 files changed, 3 insertions(+), 54 deletions(-) diff --git a/exercises/exercise-basic/injection2p2cproblem.hh b/exercises/exercise-basic/injection2p2cproblem.hh index 95ea53d..53ea143 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 { @@ -237,9 +231,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 fb2bbe0..b765aa1 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 of the integration point of the boundary segment. */ 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 30099c5..d0c7a38 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 of the integration point of the boundary segment. */ 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/solution/exercise-basic/injection2pniproblem.hh b/exercises/solution/exercise-basic/injection2pniproblem.hh index 95c63a1..1a9983b 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 global position */ 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 { -- GitLab From 69bff6ee345010c2043e02230cea5b9b7e26f577 Mon Sep 17 00:00:00 2001 From: Martin Schneider Date: Tue, 17 Jul 2018 16:52:13 +0200 Subject: [PATCH 5/7] Further improvements of docu for basic ex --- exercises/exercise-basic/injection2p2cproblem.hh | 7 +------ exercises/exercise-basic/injection2pniproblem.hh | 2 +- exercises/exercise-basic/injection2pproblem.hh | 2 +- 3 files changed, 3 insertions(+), 8 deletions(-) diff --git a/exercises/exercise-basic/injection2p2cproblem.hh b/exercises/exercise-basic/injection2p2cproblem.hh index 53ea143..39b0ab5 100644 --- a/exercises/exercise-basic/injection2p2cproblem.hh +++ b/exercises/exercise-basic/injection2p2cproblem.hh @@ -215,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 { diff --git a/exercises/exercise-basic/injection2pniproblem.hh b/exercises/exercise-basic/injection2pniproblem.hh index b765aa1..77e4176 100644 --- a/exercises/exercise-basic/injection2pniproblem.hh +++ b/exercises/exercise-basic/injection2pniproblem.hh @@ -214,7 +214,7 @@ public: * \brief Evaluate the source term for all phases within a given * sub-control-volume. * - * \param globalPos The position of the integration point of the boundary segment. + * \param globalPos The position for which the source term should be evaluated */ NumEqVector sourceAtPos(const GlobalPosition &globalPos) const { diff --git a/exercises/exercise-basic/injection2pproblem.hh b/exercises/exercise-basic/injection2pproblem.hh index d0c7a38..aae8751 100644 --- a/exercises/exercise-basic/injection2pproblem.hh +++ b/exercises/exercise-basic/injection2pproblem.hh @@ -215,7 +215,7 @@ public: * \brief Evaluate the source term for all phases within a given * sub-control-volume. * - * \param globalPos The position of the integration point of the boundary segment. + * \param globalPos The position for which the source term should be evaluated */ NumEqVector sourceAtPos(const GlobalPosition &globalPos) const { -- GitLab From 29f0f5d511ac437039ec41572b2e95edec79635b Mon Sep 17 00:00:00 2001 From: Martin Schneider Date: Tue, 17 Jul 2018 16:54:11 +0200 Subject: [PATCH 6/7] Cleanup of docu for ex-mainfile --- exercises/exercise-mainfile/1pproblem.hh | 4 ---- 1 file changed, 4 deletions(-) diff --git a/exercises/exercise-mainfile/1pproblem.hh b/exercises/exercise-mainfile/1pproblem.hh index 32d4d5b..3a8f3ae 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 { -- GitLab From 0675d4b4f03776071cd1d2d0268152326e130f38 Mon Sep 17 00:00:00 2001 From: Martin Schneider Date: Tue, 17 Jul 2018 17:03:37 +0200 Subject: [PATCH 7/7] Cleanup of solutions --- .../exercise-basic/injection2pniproblem.hh | 2 +- .../solution/exercise-mainfile/1pproblem.hh | 16 ++++++++++------ 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/exercises/solution/exercise-basic/injection2pniproblem.hh b/exercises/solution/exercise-basic/injection2pniproblem.hh index 1a9983b..c8b8225 100644 --- a/exercises/solution/exercise-basic/injection2pniproblem.hh +++ b/exercises/solution/exercise-basic/injection2pniproblem.hh @@ -203,7 +203,7 @@ public: * \brief Evaluate the source term for all phases within a given * sub-control-volume. * - * \param globalPos The global position + * \param globalPos The position for which the source term should be evaluated */ NumEqVector sourceAtPos(const GlobalPosition &globalPos) const { diff --git a/exercises/solution/exercise-mainfile/1pproblem.hh b/exercises/solution/exercise-mainfile/1pproblem.hh index 063ae7c..b484f75 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); +SET_TYPE_PROP(OnePIncompressible, LocalResidual, OnePIncompressibleLocalResidual); // the fluid system for compressible tests @@ -114,17 +114,24 @@ class OnePTestProblem : public PorousMediumFlowProblem 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 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 { -- GitLab