diff --git a/test/porousmediumflow/richards/implicit/analytical/main.cc b/test/porousmediumflow/richards/implicit/analytical/main.cc index ac9468b2661fd6fab506a2798f09ebf6232c2212..3a43e8a3d752a97a241946fedc26f4b4bfebc709 100644 --- a/test/porousmediumflow/richards/implicit/analytical/main.cc +++ b/test/porousmediumflow/richards/implicit/analytical/main.cc @@ -18,9 +18,10 @@ *****************************************************************************/ /*! * \file - * + * \ingroup RichardsTests * \brief Test for the Richards CC model. */ + #include #include "problem.hh" diff --git a/test/porousmediumflow/richards/implicit/analytical/problem.hh b/test/porousmediumflow/richards/implicit/analytical/problem.hh index 3ae5eb6304736a0f654c044f86cd3b7ff7bd41d0..8eccbf85a7ca9eff178888300af61659dc95a859 100644 --- a/test/porousmediumflow/richards/implicit/analytical/problem.hh +++ b/test/porousmediumflow/richards/implicit/analytical/problem.hh @@ -19,12 +19,13 @@ /*! * \file * \ingroup RichardsTests - * \brief A one-dimensional infiltration problem with a smoth, given solution. + * \brief A one-dimensional infiltration problem with a smooth, given solution. * * The source term is calculated analytically. Thus, this example can be used - * to calclate the L2 error and to show convergence for grid and time-step + * to calculate the L2 error and to show convergence for grid and time-step * refinement. */ + #ifndef DUMUX_RICHARDS_ANALYTICALPROBLEM_HH #define DUMUX_RICHARDS_ANALYTICALPROBLEM_HH @@ -46,10 +47,10 @@ namespace Dumux { /*! * \ingroup RichardsTests - * \brief A one-dimensional infiltration problem with a smoth, given solution. + * \brief A one-dimensional infiltration problem with a smooth, given solution. * * The source term is calculated analytically. Thus, this example can be used - * to calclate the L2 error and to show convergence for grid and time-step + * to calculate the L2 error and to show convergence for grid and time-step * refinement. */ template @@ -124,11 +125,6 @@ class RichardsAnalyticalProblem : public PorousMediumFlowProblem using Geometry = typename GridView::template Codim<0>::Entity::Geometry; public: - /*! - * \brief Constructor - * - * \param fvGridGeometry The finite volume grid geometry - */ RichardsAnalyticalProblem(std::shared_ptr fvGridGeometry) : ParentType(fvGridGeometry) { @@ -171,12 +167,12 @@ public: { return pnRef_; } /*! - * \brief Evaluate the source values for a control volume. + * \brief Evaluates the source values for a control volume. * * For this method, the \a values parameter stores primary * variables. For this test case, the analytical solution is * used to calculate the source term. See the Matlab script - * Richards.m which uses Matlab's Symbolic Toolbox to calclate + * Richards.m which uses Matlab's Symbolic Toolbox to calculate * the source term. * * \param globalPos The position for which the source term is set @@ -189,7 +185,7 @@ public: const Scalar pwBottom = 95641.1; // linear model with complex solution - // calcluated with Matlab script "Richards.m" + // calculated with Matlab script "Richards.m" using std::pow; using std::tanh; @@ -231,8 +227,7 @@ public: } /*! - * \brief Evaluate the boundary conditions for a dirichlet - * boundary segment. + * \brief Evaluates the boundary conditions for a Dirichlet boundary segment. * * \param globalPos The position for which the Dirichlet value is set * @@ -254,8 +249,7 @@ public: } /*! - * \brief Evaluate the boundary conditions for a neumann - * boundary segment. + * \brief Evaluates the boundary conditions for a Neumann boundary segment. * * For this method, the \a values parameter stores the mass flux * in normal direction of each phase. Negative values mean influx. @@ -274,7 +268,7 @@ public: // \{ /*! - * \brief Evaluate the initial values for a control volume. + * \brief Evaluates the initial values for a control volume. * * For this method, the \a values parameter stores primary * variables. @@ -292,9 +286,9 @@ public: // \} /*! - * \brief Evaluate the analytical solution. + * \brief Evaluates the analytical solution. * - * \param values The dirichlet values for the primary variables + * \param values The Dirichlet values for the primary variables * \param time The time at which the solution should be evaluated * \param globalPos The position for which the Dirichlet value is set * @@ -322,7 +316,7 @@ public: * \note Works for cell-centered FV only because the numerical * approximation is only evaluated in the cell center (once). * To extend this function to the box method the evaluation - * has to be extended to box' subvolumes. + * has to be extended to box' sub-volumes. */ Scalar calculateL2Error(const SolutionVector& curSol) { @@ -361,7 +355,7 @@ public: } /*! - * \brief Write the relevant secondary variables of the current + * \brief Writes the relevant secondary variables of the current * solution into an VTK output file. */ void writeOutput(const SolutionVector& curSol) @@ -381,13 +375,13 @@ public: private: - // evalutates if global position is at lower boundary + // evaluates if global position is at lower boundary bool onLowerBoundary_(const GlobalPosition &globalPos) const { return globalPos[1] < this->fvGridGeometry().bBoxMin()[1] + eps_; } - // evalutates if global position is at upper boundary + // evaluates if global position is at upper boundary bool onUpperBoundary_(const GlobalPosition &globalPos) const { return globalPos[1] > this->fvGridGeometry().bBoxMax()[1] - eps_; diff --git a/test/porousmediumflow/richards/implicit/analytical/spatialparams.hh b/test/porousmediumflow/richards/implicit/analytical/spatialparams.hh index 470c7be40450e318f67851668d7be84dddc7f5a5..7e941f4ac2c25a2ba0e9e85ef78836a2235fd05f 100644 --- a/test/porousmediumflow/richards/implicit/analytical/spatialparams.hh +++ b/test/porousmediumflow/richards/implicit/analytical/spatialparams.hh @@ -19,8 +19,9 @@ /*! * \file * \ingroup RichardsTests - * \brief spatial parameters for the RichardsAnalyticalProblem + * \brief Spatial parameters for the RichardsAnalyticalProblem. */ + #ifndef DUMUX_RICHARDS_ANALYTICAL_SPATIAL_PARAMETERS_HH #define DUMUX_RICHARDS_ANALYTICAL_SPATIAL_PARAMETERS_HH @@ -38,7 +39,7 @@ namespace Dumux { /*! * \ingroup RichardsModel * \ingroup ImplicitTestProblems - * \brief The spatial parameters for the RichardsAnalyticalProblem + * \brief The spatial parameters for the RichardsAnalyticalProblem. */ template class RichardsAnalyticalSpatialParams diff --git a/test/porousmediumflow/richards/implicit/lens/main.cc b/test/porousmediumflow/richards/implicit/lens/main.cc index a55c0dc0216c7be600703245f56cdc6e8e0a7c2d..99c6dca832cae0162f498fe68da18bb1b2dbb476 100644 --- a/test/porousmediumflow/richards/implicit/lens/main.cc +++ b/test/porousmediumflow/richards/implicit/lens/main.cc @@ -18,9 +18,10 @@ *****************************************************************************/ /*! * \file - * + * \ingroup RichardsTests * \brief Test for the Richards box model. */ + #include #include diff --git a/test/porousmediumflow/richards/implicit/lens/problem.hh b/test/porousmediumflow/richards/implicit/lens/problem.hh index 376dd9fec2ea502dd17711c08eb88104eed00d77..729507f725a1d06d3aca562373fa9ea2d847b4b2 100644 --- a/test/porousmediumflow/richards/implicit/lens/problem.hh +++ b/test/porousmediumflow/richards/implicit/lens/problem.hh @@ -23,6 +23,7 @@ * embedded into a high-permeability domain which uses the * Richards box model. */ + #ifndef DUMUX_RICHARDS_LENSPROBLEM_HH #define DUMUX_RICHARDS_LENSPROBLEM_HH @@ -46,12 +47,6 @@ namespace Dumux { -/*! - * \ingroup RichardsTests - * \brief A water infiltration problem with a low-permeability lens - * embedded into a high-permeability domain which uses the - * Richards box model. - */ template class RichardsLensProblem; @@ -99,9 +94,9 @@ struct SpatialParams * bottom boundary is closed (Neumann 0 boundary), the top boundary * (Neumann 0 boundary) is also closed except for infiltration * section, where water is infiltrating into an initially unsaturated - * porous medium. This problem is very similar the the LensProblem + * porous medium. This problem is very similar to the LensProblem * which uses the TwoPBoxModel, with the main difference being that - * the domain is initally fully saturated by gas instead of water and + * the domain is initially fully saturated by gas instead of water and * water instead of a %DNAPL infiltrates from the top. * * This problem uses the \ref RichardsModel @@ -138,11 +133,6 @@ class RichardsLensProblem : public PorousMediumFlowProblem using GlobalPosition = typename Element::Geometry::GlobalCoordinate; public: - /*! - * \brief Constructor - * - * \param fvGridGeometry The finite volume grid geometry - */ RichardsLensProblem(std::shared_ptr fvGridGeometry) : ParentType(fvGridGeometry) { @@ -203,8 +193,7 @@ public: } /*! - * \brief Evaluate the boundary conditions for a dirichlet - * boundary segment. + * \brief Evaluates the boundary conditions for a Dirichlet boundary segment. * * \param globalPos The position for which the Dirichlet value is set * @@ -216,8 +205,7 @@ public: } /*! - * \brief Evaluate the boundary conditions for a neumann - * boundary segment. + * \brief Evaluates the boundary conditions for a Neumann boundary segment. * * For this method, the \a values parameter stores the mass flux * in normal direction of each phase. Negative values mean influx. @@ -238,7 +226,7 @@ public: // \{ /*! - * \brief Evaluate the initial values for a control volume. + * \brief Evaluates the initial values for a control volume. * * For this method, the \a values parameter stores primary * variables. diff --git a/test/porousmediumflow/richards/implicit/lens/spatialparams.hh b/test/porousmediumflow/richards/implicit/lens/spatialparams.hh index a593a989a711504d0814eeeb198feccc231569a0..960739e5cc588967ca89f11635a1dac629f9a1bb 100644 --- a/test/porousmediumflow/richards/implicit/lens/spatialparams.hh +++ b/test/porousmediumflow/richards/implicit/lens/spatialparams.hh @@ -19,8 +19,9 @@ /*! * \file * \ingroup RichardsTests - * \brief spatial parameters for the RichardsLensProblem + * \brief Spatial parameters for the RichardsLensProblem. */ + #ifndef DUMUX_RICHARDS_LENS_SPATIAL_PARAMETERS_HH #define DUMUX_RICHARDS_LENS_SPATIAL_PARAMETERS_HH @@ -34,7 +35,7 @@ namespace Dumux { /*! * \ingroup RichardsTests - * \brief The spatial parameters for the RichardsLensProblem + * \brief The spatial parameters for the RichardsLensProblem. */ template class RichardsLensSpatialParams @@ -101,7 +102,7 @@ public: { return 0.4; } /*! - * \brief Returns the parameters for the material law at a given location + * \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 @@ -120,6 +121,14 @@ public: return materialLawParamsAtPos(globalPos); } + /*! + * \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 + * + * \param globalPos The global coordinates for the given location + */ const MaterialLawParams& materialLawParamsAtPos(const GlobalPosition& globalPos) const { if (isInLens_(globalPos)) diff --git a/test/porousmediumflow/richards/implicit/nonisothermal/conduction/main.cc b/test/porousmediumflow/richards/implicit/nonisothermal/conduction/main.cc index 8bf8b46a0b3f5e29bc09042e835cf2ce88a39f6d..aef275531c746e5cbc16aee46f0f82b0cb20a2e2 100644 --- a/test/porousmediumflow/richards/implicit/nonisothermal/conduction/main.cc +++ b/test/porousmediumflow/richards/implicit/nonisothermal/conduction/main.cc @@ -18,9 +18,10 @@ *****************************************************************************/ /*! * \file - * + * \ingroup RichardsTests * \brief Test for the Richards box model. */ + #include #include "problem.hh" diff --git a/test/porousmediumflow/richards/implicit/nonisothermal/conduction/problem.hh b/test/porousmediumflow/richards/implicit/nonisothermal/conduction/problem.hh index 4cf97a8629a5fcf49c1bc03b9dfd06be868d1b44..1ebd8108e1b5283a5a2f347f0153105c10fea678 100644 --- a/test/porousmediumflow/richards/implicit/nonisothermal/conduction/problem.hh +++ b/test/porousmediumflow/richards/implicit/nonisothermal/conduction/problem.hh @@ -20,8 +20,9 @@ * \file * \ingroup RichardsTests * \brief Test for the RichardsModel in combination with the NI model for a conduction problem: - * The simulation domain is a tube where with an elevated temperature on the left hand side. + * The simulation domain is a tube with an elevated temperature on the left hand side. */ + #ifndef DUMUX_RICHARDS_CONDUCTION_PROBLEM_HH #define DUMUX_RICHARDS_CONDUCTION_PROBLEM_HH @@ -43,7 +44,7 @@ namespace Dumux { /** * \ingroup RichardsTests * \brief Test for the RichardsModel in combination with the NI model for a conduction problem: - * The simulation domain is a tube where with an elevated temperature on the left hand side. + * The simulation domain is a tube with an elevated temperature on the left hand side. */ template class RichardsNIConductionProblem; @@ -82,11 +83,12 @@ struct SpatialParams * \ingroup RichardsTests * * \brief Test for the RichardsModel in combination with the NI model for a conduction problem: - * The simulation domain is a tube where with an elevated temperature on the left hand side. + * The simulation domain is a tube with an elevated temperature on the left hand side. * * Initially the domain is fully saturated with water at a constant temperature. - * On the left hand side there is a Dirichlet boundary condition with an increased temperature and on the right hand side - * a Dirichlet boundary with constant pressure, saturation and temperature is applied. + * On the left hand side there is a Dirichlet boundary condition with an increased temperature + * and on the right hand side a Dirichlet boundary with constant pressure, saturation + * and temperature is applied. * * The results are compared to an analytical solution for a diffusion process: \f[ @@ -142,18 +144,13 @@ public: temperatureExact_.resize(fvGridGeometry->numDofs()); } - /*! - * \brief Append all quantities of interest which can be derived - * from the solution of the current time step to the VTK - * writer. - */ - //! get the analytical temperature + //! Get the analytical temperature const std::vector& getExactTemperature() { return temperatureExact_; } - //! udpate the analytical temperature + //! Udpate the analytical temperature void updateExactTemperature(const SolutionVector& curSol, Scalar time) { const auto someElement = *(elements(this->fvGridGeometry().gridView()).begin()); @@ -237,8 +234,7 @@ public: } /*! - * \brief Evaluate the boundary conditions for a dirichlet - * boundary segment. + * \brief Evaluates the boundary conditions for a Dirichlet boundary segment. * * \param globalPos The position for which the bc type should be evaluated * @@ -257,8 +253,7 @@ public: } /*! - * \brief Evaluate the boundary conditions for a Neumann - * boundary segment. + * \brief Evaluates the boundary conditions for a Neumann boundary segment. * * \param globalPos The global position where we evaluate * @@ -281,7 +276,7 @@ public: /*! * \brief Returns the reference pressure [Pa] of the non-wetting - * fluid phase within a finite volume + * fluid phase within a finite volume. * * This problem assumes a constant reference pressure of 1 bar. */ @@ -289,7 +284,7 @@ public: { return 1e5; }; /*! - * \brief Evaluate the initial value for a control volume. + * \brief Evaluates the initial value for a control volume. * * \param globalPos The position for which the initial condition should be evaluated * diff --git a/test/porousmediumflow/richards/implicit/nonisothermal/convection/main.cc b/test/porousmediumflow/richards/implicit/nonisothermal/convection/main.cc index 8bf8b46a0b3f5e29bc09042e835cf2ce88a39f6d..aef275531c746e5cbc16aee46f0f82b0cb20a2e2 100644 --- a/test/porousmediumflow/richards/implicit/nonisothermal/convection/main.cc +++ b/test/porousmediumflow/richards/implicit/nonisothermal/convection/main.cc @@ -18,9 +18,10 @@ *****************************************************************************/ /*! * \file - * + * \ingroup RichardsTests * \brief Test for the Richards box model. */ + #include #include "problem.hh" diff --git a/test/porousmediumflow/richards/implicit/nonisothermal/convection/problem.hh b/test/porousmediumflow/richards/implicit/nonisothermal/convection/problem.hh index 524f8b356dbc5b03e55059823674c13fca87a15a..769708d59699b8acb1706242b4d0c20edd1f9511 100644 --- a/test/porousmediumflow/richards/implicit/nonisothermal/convection/problem.hh +++ b/test/porousmediumflow/richards/implicit/nonisothermal/convection/problem.hh @@ -23,6 +23,7 @@ * The simulation domain is a tube where water with an elevated temperature is injected * at a constant rate on the left hand side. */ + #ifndef DUMUX_RICHARDS_CONVECTION_PROBLEM_HH #define DUMUX_RICHARDS_CONVECTION_PROBLEM_HH @@ -141,7 +142,7 @@ public: RichardsNIConvectionProblem(std::shared_ptr fvGridGeometry) : ParentType(fvGridGeometry) { - //initialize fluid system + // initialize fluid system FluidSystem::init(); name_ = getParam("Problem.Name"); @@ -153,19 +154,13 @@ public: temperatureExact_.resize(fvGridGeometry->numDofs()); } - - /*! - * \brief Append all quantities of interest which can be derived - * from the solution of the current time step to the VTK - * writer. - */ - //! get the analytical temperature + //! Get the analytical temperature const std::vector& getExactTemperature() { return temperatureExact_; } - //! udpate the analytical temperature + //! Update the analytical temperature void updateExactTemperature(const SolutionVector& curSol, Scalar time) { const auto someElement = *(elements(this->fvGridGeometry().gridView()).begin()); @@ -250,8 +245,7 @@ public: } /*! - * \brief Evaluate the boundary conditions for a dirichlet - * boundary segment. + * \brief Evaluates the boundary conditions for a Dirichlet boundary segment. * * \param globalPos The position for which the bc type should be evaluated * @@ -263,13 +257,12 @@ public: } /*! - * \brief Evaluate the boundary conditions for a neumann - * boundary segment. + * \brief Evaluates the boundary conditions for a Neumann boundary segment. * * \param element The finite element * \param fvGeometry The finite-volume geometry in the box scheme * \param elemVolVars The element volume variables - * \param scvf The subcontrolvolume face + * \param scvf The sub-control volume face * Negative values mean influx. */ NumEqVector neumann(const Element &element, @@ -299,7 +292,7 @@ public: /*! * \brief Returns the reference pressure [Pa] of the non-wetting - * fluid phase within a finite volume + * fluid phase within a finite volume. * * This problem assumes a constant reference pressure of 1 bar. */ @@ -307,7 +300,7 @@ public: { return 1e5; }; /*! - * \brief Evaluate the initial value for a control volume. + * \brief Evaluates the initial value for a control volume. * * \param globalPos The position for which the initial condition should be evaluated * @@ -341,5 +334,5 @@ private: std::vector temperatureExact_; }; -} //end namespace +} // end namespace #endif // DUMUX_RICHARDSNI_CONVECTION_PROBLEM_HH diff --git a/test/porousmediumflow/richards/implicit/nonisothermal/evaporation/main.cc b/test/porousmediumflow/richards/implicit/nonisothermal/evaporation/main.cc index 2bb32ae4cc4c489ea5123698f0b7b12e1984d004..0a1b0c6692587c9de0a728e62673f4c0865f47f5 100644 --- a/test/porousmediumflow/richards/implicit/nonisothermal/evaporation/main.cc +++ b/test/porousmediumflow/richards/implicit/nonisothermal/evaporation/main.cc @@ -18,9 +18,10 @@ *****************************************************************************/ /*! * \file - * + * \ingroup RichardsTests * \brief Test for the Richards box model. */ + #include #include "problem.hh" diff --git a/test/porousmediumflow/richards/implicit/nonisothermal/evaporation/problem.hh b/test/porousmediumflow/richards/implicit/nonisothermal/evaporation/problem.hh index 395bcc8a92c0dd9c8a8e8acaf53222e3534ae0e7..82743f55adbb4eb875ceb86d586a08c5cfcf7bd1 100644 --- a/test/porousmediumflow/richards/implicit/nonisothermal/evaporation/problem.hh +++ b/test/porousmediumflow/richards/implicit/nonisothermal/evaporation/problem.hh @@ -22,6 +22,7 @@ * \brief Test for the extended richards problem: * The simulation domain is a tube a constant evaporation rate is set at the top and the soil gradually dries out. */ + #ifndef DUMUX_RICHARDS_EVAPORATION_PROBLEM_HH #define DUMUX_RICHARDS_EVAPORATION_PROBLEM_HH @@ -42,7 +43,7 @@ namespace Dumux { /** * \ingroup RichardsTests - * \brief Test for the RichardsModel in combination with the NI model for an evaporation. + * \brief Test for the RichardsModel in combination with the NI model for evaporation. */ template class RichardsNIEvaporationProblem; @@ -131,7 +132,7 @@ public: RichardsNIEvaporationProblem(std::shared_ptr fvGridGeometry) : ParentType(fvGridGeometry) { - //initialize fluid system + // initialize fluid system FluidSystem::init(); name_ = getParam("Problem.Name"); @@ -182,8 +183,7 @@ public: } /*! - * \brief Evaluate the boundary conditions for a dirichlet - * boundary segment. + * \brief Evaluates the boundary conditions for a Dirichlet boundary segment. * * \param globalPos The position for which the bc type should be evaluated * @@ -195,8 +195,7 @@ public: } /*! - * \brief Evaluate the boundary conditions for a neumann - * boundary segment. + * \brief Evaluates the boundary conditions for a Neumann boundary segment. * * \param element The finite element * \param fvGeometry The finite-volume geometry in the box scheme @@ -234,7 +233,7 @@ public: /*! * \brief Returns the reference pressure [Pa] of the non-wetting - * fluid phase within a finite volume + * fluid phase within a finite volume. * * This problem assumes a constant reference pressure of 1 bar. */ @@ -242,7 +241,7 @@ public: { return 1e5; }; /*! - * \brief Evaluate the initial value for a control volume. + * \brief Evaluates the initial value for a control volume. * * \param globalPos The position for which the initial condition should be evaluated * diff --git a/test/porousmediumflow/richards/implicit/nonisothermal/spatialparams.hh b/test/porousmediumflow/richards/implicit/nonisothermal/spatialparams.hh index 370e8c46681668a0a87658cac009823ef734af63..93c5c9f80542f340d68aa99f246726352fe4d7d4 100644 --- a/test/porousmediumflow/richards/implicit/nonisothermal/spatialparams.hh +++ b/test/porousmediumflow/richards/implicit/nonisothermal/spatialparams.hh @@ -21,6 +21,7 @@ * \ingroup RichardsTests * \brief Definition of the spatial parameters for the non-isothermal Richards problems. */ + #ifndef DUMUX_RICHARDSNI_SPATIAL_PARAMS_HH #define DUMUX_RICHARDSNI_SPATIAL_PARAMS_HH @@ -76,7 +77,7 @@ public: } /*! - * \brief Define the intrinsic permeability \f$\mathrm{[m^2]}\f$. + * \brief Defines the intrinsic permeability \f$\mathrm{[m^2]}\f$. * * \param globalPos The global position where we evaluate */ @@ -86,7 +87,7 @@ public: } /*! - * \brief Define the porosity \f$\mathrm{[-]}\f$. + * \brief Defines the porosity \f$\mathrm{[-]}\f$. * * \param globalPos The global position where we evaluate */ @@ -96,7 +97,8 @@ public: } /*! - * \brief return the parameter object for the Brooks-Corey material law which depends on the position + * \brief Returns the parameter object for the Brooks-Corey material law + * which depends on the position * * \param globalPos The global position where we evaluate */ diff --git a/test/porousmediumflow/richardsnc/implicit/main.cc b/test/porousmediumflow/richardsnc/implicit/main.cc index 1b16cf920e7793f3ca8d75abf8ff580904effb68..06fab0e8e759d5c5ed48abd4d140d37839741325 100644 --- a/test/porousmediumflow/richardsnc/implicit/main.cc +++ b/test/porousmediumflow/richardsnc/implicit/main.cc @@ -18,9 +18,10 @@ *****************************************************************************/ /*! * \file - * - * \brief Test for the Richards CC model. + * \ingroup RichardsNCTests + * \brief Test for the RichardsNC CC model. */ + #include #include "problem.hh" diff --git a/test/porousmediumflow/richardsnc/implicit/problem.hh b/test/porousmediumflow/richardsnc/implicit/problem.hh index 05bf9c2bd8c1769d8efc8cd7ba64fa6a299af54f..fcb13a3acc48f5de8187534c209a1e10d4c3ecf7 100644 --- a/test/porousmediumflow/richardsnc/implicit/problem.hh +++ b/test/porousmediumflow/richardsnc/implicit/problem.hh @@ -86,12 +86,13 @@ struct PointSource { using type = SolDependen * Richards model. * * The domain is box shaped. Left and right boundaries are Dirichlet - * boundaries with fixed water pressure (hydostatic, gradient from right to left), + * boundaries with fixed water pressure (hydrostatic, gradient from right to left), * bottom boundary is closed (Neumann 0 boundary), the top boundary * (Neumann 0 boundary) is also closed. Water is extracted at a point in * the middle of the domain. + * This problem is very similar to the LensProblem * which uses the TwoPBoxModel, with the main difference being that - * the domain is initally fully saturated by gas instead of water and + * the domain is initially fully saturated by gas instead of water and * water instead of a %DNAPL infiltrates from the top. * * This problem uses the \ref RichardsNCModel @@ -132,11 +133,6 @@ class RichardsWellTracerProblem : public PorousMediumFlowProblem using GlobalPosition = typename SubControlVolume::GlobalPosition; public: - /*! - * \brief Constructor - * - * \param fvGridGeometry The finite volume grid geometry - */ RichardsWellTracerProblem(std::shared_ptr fvGridGeometry) : ParentType(fvGridGeometry) { @@ -244,8 +240,7 @@ public: } /*! - * \brief Evaluate the boundary conditions for a dirichlet - * boundary segment. + * \brief Evaluates the boundary conditions for a Dirichlet boundary segment. * * \param globalPos The position for which the Dirichlet value is set * @@ -255,8 +250,7 @@ public: { return initial_(globalPos); } /*! - * \brief Evaluate the boundary conditions for a neumann - * boundary segment. + * \brief Evaluates the boundary conditions for a Neumann boundary segment. * * For this method, the \a values parameter stores the mass flux * in normal direction of each phase. Negative values mean influx. @@ -272,8 +266,7 @@ public: // \{ /*! - * \brief Applies a vector of point sources. The point sources - * are possibly solution dependent. + * \brief Applies a vector of point sources which are possibly solution dependent. * * \param pointSources A vector of PointSource s that contain source values for all phases and space positions. @@ -305,7 +298,7 @@ public: } /*! - * \brief Evaluate the initial values for a control volume. + * \brief Evaluates the initial values for a control volume. * * For this method, the \a values parameter stores primary * variables. @@ -330,7 +323,7 @@ private: }(); PrimaryVariables values(0.0); - //! hydrostatic pressure profile + //! Hydrostatic pressure profile values[pressureIdx] = (nonWettingReferencePressure() - pcTop_) - 9.81*1000*(globalPos[dimWorld-1] - this->fvGridGeometry().bBoxMax()[dimWorld-1]); values[compIdx] = xTracer; diff --git a/test/porousmediumflow/richardsnc/implicit/spatialparams.hh b/test/porousmediumflow/richardsnc/implicit/spatialparams.hh index 8c5b4905f417317c411eb3fc83d42083f1338144..b99dcc7c42504584a932b1be2f339b311cb76361 100644 --- a/test/porousmediumflow/richardsnc/implicit/spatialparams.hh +++ b/test/porousmediumflow/richardsnc/implicit/spatialparams.hh @@ -19,8 +19,9 @@ /*! * \file * \ingroup RichardsNCTests - * \brief spatial parameters for the RichardsWellTracerProblem + * \brief The spatial parameters for the RichardsWellTracerProblem. */ + #ifndef DUMUX_RICHARDS_LENS_SPATIAL_PARAMETERS_HH #define DUMUX_RICHARDS_LENS_SPATIAL_PARAMETERS_HH @@ -38,7 +39,7 @@ namespace Dumux { /*! * \ingroup RichardsModel * \ingroup ImplicitTestProblems - * \brief The spatial parameters for the RichardsWellTracerProblem + * \brief The spatial parameters for the RichardsWellTracerProblem. */ template class RichardsWellTracerSpatialParams