Commit aa2a1769 by Sina Ackermann Committed by Simon Emmert

### [doxygen] Adapt documentation for all 3p related tests

parent af703b06
 ... ... @@ -18,8 +18,8 @@ *****************************************************************************/ /*! * \file * * \brief test for the 3pni CC model * \ingroup ThreePTests * \brief Test for the 3pni CC model. */ #include #include "problem.hh" ... ...
 ... ... @@ -41,11 +41,7 @@ #include "spatialparams.hh" namespace Dumux { /** * \ingroup ThreePTests * \brief Definition of a 3pni problem: * Component transport of nitrogen dissolved in the water phase. */ template class ThreePNIConductionProblem; ... ... @@ -87,12 +83,14 @@ struct SpatialParams * \ingroup ThreePModel * \ingroup ImplicitTestProblems * * \brief Test for the ThreePModel in combination with the NI model for a conduction problem: * \brief Test for the ThreePModel 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. * * 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[ ... ... @@ -151,13 +149,13 @@ public: temperatureExact_.resize(fvGridGeometry->numDofs()); } //! 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()); ... ... @@ -242,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 bc type should be evaluated */ ... ... @@ -257,8 +254,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 position of the integration point of the boundary segment. * ... ... @@ -278,12 +274,12 @@ public: // \{ /*! * \brief Evaluate the source term for all phases within a given * sub-control-volume. * \brief Evaluates the source term for all phases within a given * sub-controlvolume. * * \param globalPos The position for which the source should be evaluated * * Returns the rate mass of a component is generated or annihilate * Returns the rate mass of a component is generated or annihilated * per volume unit. Positive values mean that mass is created, * negative ones mean that it vanishes. * ... ... @@ -295,7 +291,7 @@ public: } /*! * \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 * ... ...
 ... ... @@ -21,6 +21,7 @@ * \ingroup ThreePTests * \brief Definition of the spatial parameters for the 3pni problems. */ #ifndef DUMUX_THREEPNI_SPATIAL_PARAMS_HH #define DUMUX_THREEPNI_SPATIAL_PARAMS_HH ... ... @@ -53,7 +54,7 @@ class ThreePNISpatialParams using GlobalPosition = typename Element::Geometry::GlobalCoordinate; public: // export permeability type //! Export permeability type using PermeabilityType = Scalar; using MaterialLaw = EffToAbsLaw; ... ...
 ... ... @@ -18,8 +18,8 @@ *****************************************************************************/ /*! * \file * * \brief test for the 3pni CC model * \ingroup ThreePTests * \brief Test for the 3pni CC model. */ #include #include "problem.hh" ... ...
 ... ... @@ -19,8 +19,7 @@ /** * \file * \ingroup ThreePTests * \brief Definition of a 1p2cni problem: * Component transport of nitrogen dissolved in the water phase. * \brief Test for the ThreePModel in combination with the NI model for a convection problem. */ #ifndef DUMUX_3PNI_CONVECTION_PROBLEM_HH #define DUMUX_3PNI_CONVECTION_PROBLEM_HH ... ... @@ -43,8 +42,7 @@ namespace Dumux { /** * \ingroup ThreePTests * \brief Definition of a 1p2cni problem: * Component transport of nitrogen dissolved in the water phase. * \brief Test for the ThreePModel in combination with the NI model for a convection problem. */ template class ThreePNIConvectionProblem; ... ... @@ -83,18 +81,20 @@ struct SpatialParams } // end namespace Properties /*! * \ingroup ThreePModel * \ingroup ImplicitTestProblems * \ingroup ThreePTests * * \brief Test for the ThreePModel in combination with the NI model for a convection problem. * * \brief Test for the ThreePModel in combination with the NI model for a convection problem: * The simulation domain is a tube where water with an elevated temperature is injected * at a constant rate on the left hand side. * * Initially the domain is fully saturated with water at a constant temperature. * On the left hand side water is injected at a constant rate and on the right hand side * a Dirichlet boundary with constant pressure, saturation and temperature is applied. * On the left hand side water is injected at a constant rate 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 where a retarded front velocity is calculated as follows: * The results are compared to an analytical solution where a retarded front * velocity is calculated as follows: \f[ v_{Front}=\frac{q S_{water}}{\phi S_{total}} \f] ... ... @@ -168,7 +168,7 @@ public: 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()); ... ... @@ -253,8 +253,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 * ... ... @@ -265,14 +264,13 @@ 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 * Negative values mean influx. * Negative values mean influx. */ NumEqVector neumann(const Element &element, const FVElementGeometry& fvGeometry, ... ... @@ -300,7 +298,7 @@ public: // \{ /*! * \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 * ... ...
 ... ... @@ -18,8 +18,8 @@ *****************************************************************************/ /*! * \file * * \brief Test for the three-phase CC model * \ingroup ThreePTests * \brief Test for the three-phase CC model. */ #include #include "problem.hh" ... ...
 ... ... @@ -44,11 +44,7 @@ namespace Dumux { /*! * \ingroup ThreePTests * \brief Isothermal NAPL infiltration problem: LNAPL contaminates * the unsaturated and the saturated groundwater zone. */ template class InfiltrationThreePProblem; ... ... @@ -99,7 +95,7 @@ struct SpatialParams * \brief Isothermal NAPL infiltration problem: LNAPL contaminates * the unsaturated and the saturated groundwater zone. * * The 2D domain of this test problem is 500 m long and 10 m deep, where * The 2D domain of this test problem is 500m long and 10m deep, where * the lower part represents a slightly inclined groundwater table, and the * upper part is the vadose zone. * A LNAPL (Non-Aqueous Phase Liquid which is lighter than water) infiltrates ... ... @@ -117,7 +113,7 @@ struct SpatialParams * This problem uses the \ref ThreePModel. * * This problem should typically be simulated for 30 days. * A good choice for the initial time step size is 60 s. * A good choice for the initial time step size is 60s. * To adjust the simulation time it is necessary to edit the file naplinfiltrationexercise.input * * To run the simulation execute the following line in shell: ... ... @@ -151,11 +147,6 @@ class InfiltrationThreePProblem : public PorousMediumFlowProblem using GlobalPosition = typename Element::Geometry::GlobalCoordinate; public: /*! * \brief The constructor * * \param fvGridGeometry The finite volume grid geometry */ InfiltrationThreePProblem(std::shared_ptr fvGridGeometry) : ParentType(fvGridGeometry) { ... ... @@ -222,8 +213,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 * ... ... @@ -236,8 +226,7 @@ public: return values; } /*! * \brief Evaluate the boundary conditions for a neumann * boundary segment. * \brief Evaluates the boundary conditions for a Neumann boundary segment. * * \param globalPos The position of the integration point of the boundary segment. * ... ...
 ... ... @@ -36,7 +36,6 @@ namespace Dumux { /*! * \ingroup ThreePTests * * \brief Definition of the spatial parameters for the infiltration problem */ template ... ... @@ -56,18 +55,13 @@ class InfiltrationThreePSpatialParams using EffectiveLaw = RegularizedParkerVanGen3P; public: // export permeability type //! Export permeability type using PermeabilityType = Scalar; //get the material law from the property system //! Get the material law from the property system using MaterialLaw = EffToAbsLaw; using MaterialLawParams = typename MaterialLaw::Params; /*! * \brief The constructor * * \param fvGridGeometry The finite volume grid geometry */ InfiltrationThreePSpatialParams(std::shared_ptr fvGridGeometry) : ParentType(fvGridGeometry) { ... ... @@ -121,7 +115,7 @@ public: * \param element The element * \param scv The sub control volume * \param elemSol The element solution vector * \return the intrinsic permeability * \return The intrinsic permeability */ template PermeabilityType permeability(const Element& element, ... ...
 ... ... @@ -18,8 +18,8 @@ *****************************************************************************/ /*! * \file * * \brief Test for the three-phase three-component box model * \ingroup ThreePThreeCTests * \brief Test for the three-phase three-component box model. */ #include #include ... ...
 ... ... @@ -165,11 +165,6 @@ class ColumnProblem : public PorousMediumFlowProblem using SubControlVolumeFace = typename FVElementGeometry::SubControlVolumeFace; public: /*! * \brief The constructor * * \param fvGridGeometry The finite volume grid geometry */ ColumnProblem(std::shared_ptr fvGridGeometry) : ParentType(fvGridGeometry) { ... ... @@ -214,8 +209,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 * ... ... @@ -227,8 +221,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 position for which the bc type should be evaluated * ... ... @@ -254,7 +247,7 @@ public: /*! * \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 * ... ... @@ -268,9 +261,11 @@ public: /*! * \brief Append all quantities of interest which can be derived * \brief Appends all quantities of interest which can be derived * from the solution of the current time step to the VTK * writer. Adjust this in case of anisotropic permeabilities. * writer. * * Adjust this in case of anisotropic permeabilities. */ template void addVtkFields(VTKWriter& vtk) ... ...
 ... ... @@ -34,7 +34,7 @@ namespace Dumux { /*! * \ingroup ThreePThreeCModel * \brief Definition of the spatial parameters for the column problem * \brief Definition of the spatial parameters for the column problem. */ template class ColumnSpatialParams ... ... @@ -57,11 +57,6 @@ public: using MaterialLawParams = typename MaterialLaw::Params; using PermeabilityType = Scalar; /*! * \brief The constructor * * \param fvGridGeometry The finite volume grid geometry */ ColumnSpatialParams(std::shared_ptr fvGridGeometry) : ParentType(fvGridGeometry) { ... ... @@ -107,7 +102,7 @@ public: * \param element The current element * \param scv The sub-control volume inside the element. * \param elemSol The solution at the dofs connected to the element. * \return permeability * \return The permeability */ template PermeabilityType permeability(const Element& element, ... ... @@ -120,7 +115,7 @@ public: return coarseK_; } /*! \brief Define the porosity in [-]. /*! \brief Defines the porosity in [-]. * * \param globalPos The global position where we evaluate */ ... ... @@ -135,7 +130,7 @@ public: * \param element The current element * \param scv The sub-control volume inside the element. * \param elemSol The solution at the dofs connected to the element. * \return the material parameters object * \return The material parameters object */ template const MaterialLawParams& materialLawParams(const Element& element, ... ... @@ -150,13 +145,13 @@ public: } /*! * \brief User-defined solid heat capacity. * \brief Returns the user-defined solid heat capacity. * * \param element The current element * \param scv The sub-control volume inside the element. * \param elemSol The solution at the dofs connected to the element. * \param solidState The solid state * \return the solid heat capacity * \return The solid heat capacity */ template Scalar solidHeatCapacity(const Element& element, ... ...
 ... ... @@ -18,8 +18,8 @@ *****************************************************************************/ /*! * \file * * \brief Test for the three-phase three-component box model * \ingroup ThreePThreeCTests * \brief Test for the three-phase three-component box model. */ #include #include ... ...
 ... ... @@ -22,6 +22,7 @@ * \brief Isothermal NAPL infiltration problem: LNAPL contaminates * the unsaturated and the saturated groundwater zone. */ #ifndef DUMUX_INFILTRATION_THREEPTHREEC_PROBLEM_HH #define DUMUX_INFILTRATION_THREEPTHREEC_PROBLEM_HH ... ... @@ -143,11 +144,6 @@ class InfiltrationThreePThreeCProblem : public PorousMediumFlowProblem using GlobalPosition = typename Element::Geometry::GlobalCoordinate; public: /*! * \brief The constructor * * \param fvGridGeometry The finite volume grid geometry */ InfiltrationThreePThreeCProblem(std::shared_ptr fvGridGeometry) : ParentType(fvGridGeometry) { ... ... @@ -208,8 +204,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 * ... ... @@ -219,8 +214,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. * * \param globalPos The position for which the bc type should be evaluated * ... ... @@ -252,7 +246,7 @@ public: // \{ /*! * \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 * ... ...
 ... ... @@ -20,9 +20,9 @@ * \file * \ingroup ThreePThreeCTests * \brief Definition of the spatial parameters for the kuevette problem * which uses the isothermal two-phase two component * fully implicit model. * which uses the isothermal two-phase two component fully implicit model. */ #ifndef DUMUX_INFILTRATION_THREEPTHREEC_SPATIAL_PARAMETERS_HH #define DUMUX_INFILTRATION_THREEPTHREEC_SPATIAL_PARAMETERS_HH ... ... @@ -60,11 +60,6 @@ public: using MaterialLawParams = typename MaterialLaw::Params; using PermeabilityType = Scalar; /*! * \brief The constructor * * \param fvGridGeometry The finite volume grid geometry */ InfiltrationThreePThreeCSpatialParams(std::shared_ptr fvGridGeometry) : ParentType(fvGridGeometry) { ... ... @@ -97,7 +92,7 @@ public: * \param element The current element * \param scv The sub-control volume inside the element. * \param elemSol The solution at the dofs connected to the element. * \return permeability * \return The permeability */ template PermeabilityType permeability(const Element& element, ... ... @@ -122,7 +117,7 @@ public: /*! * \brief return the parameter object for the material law which depends on the position * \brief Returns the parameter object for the material law which depends on the position * * \param globalPos The position for which the material law should be evaluated */ ... ...
 ... ... @@ -18,8 +18,8 @@ *****************************************************************************/ /*! * \file * * \brief Test for the three-phase three-component box model * \ingroup ThreePThreeCTests * \brief Test for the three-phase three-component box model. */ #include #include ... ...
 ... ... @@ -89,7 +89,7 @@ struct FluidSystem * trapped NAPL contamination. * * The domain is a quasi-two-dimensional container (kuevette). Its dimensions * are 1.5 m x 0.74 m. The top and bottom boundaries are closed, the right * are 1.5m x 0.74m. The top and bottom boundaries are closed, the right * boundary is a Dirichlet boundary allowing fluids to escape. From the left, * an injection of a hot water-air mixture is applied (Neumann boundary condition * for the mass components and the enthalpy), aimed at remediating an initial ... ... @@ -106,7 +106,7 @@ struct FluidSystem * This problem uses the \ref ThreePThreeCModel and \ref NIModel model. * * To see the basic effect and the differences to scenarios with pure steam or * pure air injection, it is sufficient to simulated for about 2-3 hours (10000 s). * pure air injection, it is sufficient to simulate for about 2-3 hours (10000 s). * Complete remediation of the domain requires much longer (about 10 days simulated time). * To adjust the simulation time it is necessary to edit the input file. * ... ... @@ -156,11 +156,6 @@ class KuevetteProblem : public PorousMediumFlowProblem using GlobalPosition = typename SubControlVolumeFace::GlobalPosition; public: /*! * \brief The constructor. * * \param fvGridGeometry The finite volumes grid geometry */ KuevetteProblem(std::shared_ptr fvGridGeometry) : ParentType(fvGridGeometry) { ... ... @@ -205,8 +200,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 * ... ... @@ -218,8 +212,7 @@ public: } /*! * \brief Evaluate the boundary conditions for a neumann * boundary segment. * \brief Evaluates the boundary conditions for a N eumann boundary segment. * * \param element The finite element * \param fvGeometry The finite-volume geometry in the box scheme ... ... @@ -256,7 +249,7 @@ public: // \{ /*! * \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 * ... ... @@ -269,9 +262,11 @@ public: } /*! * \brief Append all quantities of interest which can be derived * \brief Appends all quantities of interest which can be derived * from the solution of the current time step to the VTK * writer. Adjust this in case of anisotropic permeabilities. * writer. * * Adjust this in case of anisotropic permeabilities. */ template void addVtkFields(VTKWriter& vtk) ... ...
 ... ... @@ -21,6 +21,7 @@ * \ingroup ThreePThreeCTests * \brief Definition of the spatial parameters for the kuevette problem. */ #ifndef DUMUX_KUEVETTE3P3CNI_SPATIAL_PARAMS_HH #define DUMUX_KUEVETTE3P3CNI_SPATIAL_PARAMS_HH ... ... @@ -60,11 +61,6 @@ public: using MaterialLawParams = typename MaterialLaw::Params; using PermeabilityType = Scalar; /*! * \brief The constructor * * \param fvGridGeometry The finite volume grid geometry */ KuevetteSpatialParams(std::shared_ptr fvGridGeometry) : ParentType(fvGridGeometry) { ... ... @@ -107,7 +103,7 @@ public: * \param element The current element * \param scv The sub-control volume inside the element. * \param elemSol The solution at the dofs connected to the element. * \return permeability * \return The permeability */ template PermeabilityType permeability(const Element& element, ... ... @@ -140,7 +136,7 @@ public: * \param element The current element * \param scv The sub-control volume inside the element. * \param elemSol The solution at the dofs connected to the element. * \return the material parameters object * \return The material parameters object */ template const MaterialLawParams& materialLawParams(const Element& element, ... ...
 ... ... @@ -18,8 +18,8 @@ *****************************************************************************/ /*! * \file * \ingroup OnePTests * \brief Test for the three-phase three-component box model * \ingroup ThreePWaterOilTests * \brief Test for the three-phase three-component box model. */ #include #include ... ...
 ... ... @@ -19,7 +19,7 @@ /*! * \file * \ingroup ThreePWaterOilTests * \brief Non-isothermal SAGD problem * \brief Non-isothermal SAGD problem. */ #ifndef DUMUX_SAGDPROBLEM_HH #define DUMUX_SAGDPROBLEM_HH ... ... @@ -39,11 +39,6 @@ namespace Dumux { /*! * \file * \ingroup ThreePWaterOilTests * \brief Non-isothermal SAGD problem */ template class SagdProblem; ... ... @@ -94,13 +89,10 @@ struct SolidSystem /*! * \ingroup ThreePWaterOilBoxModel * \ingroup ImplicitTestProblems * \brief Non-isothermal problem where ... * * This problem uses the \ref ThreePWaterOilModel. * * */ * \file * \ingroup ThreePWaterOilTests