Commit fc1027a6 authored by Simon Scholz's avatar Simon Scholz
Browse files

[doxygen][2p1c][2pnc][2pncmin] fix errors in 2pXc compositional porousmediumflow models

Sequential will get an extra commit
parent 63e5383e
......@@ -155,7 +155,17 @@ public:
permeability_ = problem.spatialParams().permeability(element, scv, elemSol);
}
//! Update the fluidstate
/*!
* \brief Set complete fluid state
*
* \param elemSol A vector containing all primary variables connected to the element
* \param problem The object specifying the problem which ought to
* be simulated
* \param element An element which contains part of the control volume
* \param scv The sub-control volume
* \param fluidState A container with the current (physical) state of the fluid
* \param solidState A container with the current (physical) state of the solid
*/
template<class ElemSol, class Problem, class Element, class Scv>
void completeFluidState(const ElemSol& elemSol,
const Problem& problem,
......
......@@ -154,13 +154,15 @@ public:
}
/*!
* \brief Complete the fluid state
* \brief Set complete fluid state
*
* \param elemSol A vector containing all primary variables connected to the element
* \param problem The problem
* \param element The element
* \param scv The sub control volume
* \param fluidState The fluid state
* \param problem The object specifying the problem which ought to
* be simulated
* \param element An element which contains part of the control volume
* \param scv The sub-control volume
* \param fluidState A container with the current (physical) state of the fluid
* \param solidState A container with the current (physical) state of the solid
*
* Set temperature, saturations, capillary pressures, viscosities, densities and enthalpies.
*/
......
......@@ -177,13 +177,14 @@ public:
}
/*!
* \brief Complete the fluid state
* \brief Set complete fluid state
*
* \param elemSol A vector containing all primary variables connected to the element
* \param problem The problem
* \param element The element
* \param scv The sub control volume
* \param fluidState The fluid state
* \param problem The object specifying the problem which ought to be simulated
* \param element An element which contains part of the control volume
* \param scv The sub-control volume
* \param fluidState A container with the current (physical) state of the fluid
* \param solidState A container with the current (physical) state of the solid
*
* Set temperature, saturations, capillary pressures, viscosities, densities and enthalpies.
*/
......
......@@ -88,7 +88,7 @@ struct UseBlockingOfSpuriousFlow<TypeTag, TTag::InjectionProblem> { static const
* \ingroup TwoPOneCTests
* \brief Non-isothermal 2D problem where steam is injected on the lower left side of the domain.
*
* This problem uses the \ref TwoPOneC model.
* This problem uses the \ref TwoPOneCModel .
*
* */
template <class TypeTag>
......@@ -190,8 +190,6 @@ public:
* potentially solution dependent and requires some quantities that
* are specific to the fully-implicit method.
*
* \param values The neumann values for the conservation equations in units of
* \f$ [ \textnormal{unit of conserved quantity} / (m^2 \cdot s )] \f$
* \param element The finite element
* \param fvGeometry The finite-volume geometry
* \param elemVolVars All volume variables for the element
......
......@@ -63,7 +63,7 @@ public:
/*!
* \brief The constructor
*
* \param gridView The grid view
* \param fvGridGeometry The finite volume grid geometry
*/
InjectionProblemSpatialParams(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
......@@ -117,8 +117,8 @@ public:
/*!
* \brief Function for defining which phase is to be considered as the wetting phase.
*
* \return the wetting phase index
* \param globalPos The position of the center of the element
* \return the wetting phase index
*/
template<class FluidSystem>
int wettingPhaseAtPos(const GlobalPosition& globalPos) const
......
......@@ -127,7 +127,7 @@ public:
* The model is able to use either mole or mass fractions. The property useMoles can be set to either true or false in the
* problem file. Make sure that the according units are used in the problem setup. The default setting for useMoles is true.
*
* This problem uses the \ref TwoPTwoCModel.
* This problem uses the \ref TwoPTwoCModel .
*
* To run the simulation execute the following line in shell:
* <tt>./test_box2p2c</tt> or
......@@ -186,8 +186,7 @@ public:
/*!
* \brief The constructor
*
* \param timeManager The time manager
* \param gridView The grid view
* \param fvGridGeometry The finite volume grid geometry
*/
InjectionProblem(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
......@@ -247,7 +246,6 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment
*
* \param values Stores the value of the boundary type
* \param globalPos The global position
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
......@@ -264,8 +262,6 @@ public:
* \brief Evaluates the boundary conditions for a Dirichlet
* boundary segment
*
* \param values Stores the Dirichlet values for the conservation equations in
* \f$ [ \textnormal{unit of primary variable} ] \f$
* \param globalPos The global position
*/
PrimaryVariables dirichletAtPos(const GlobalPosition &globalPos) const
......@@ -277,14 +273,10 @@ public:
* \brief Evaluates the boundary conditions for a Neumann
* boundary segment in dependency on the current solution.
*
* \param values Stores the Neumann values for the conservation equations in
* \f$ [ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$
* \param element The finite element
* \param fvGeometry The finite volume geometry of the element
* \param intersection The intersection between element and boundary
* \param scvIdx The local index of the sub-control volume
* \param boundaryFaceIdx The index of the boundary face
* \param elemVolVars All volume variables for the element
* \param scvf The sub control volume face
*
* This method is used for cases, when the Neumann condition depends on the
* solution and requires some quantities that are specific to the fully-implicit method.
......@@ -320,8 +312,6 @@ public:
/*!
* \brief Evaluates the initial values for a control volume
*
* \param values Stores the initial values for the conservation equations in
* \f$ [ \textnormal{unit of primary variables} ] \f$
* \param globalPos The global position
*/
PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const
......@@ -335,8 +325,6 @@ private:
*
* The internal method for the initial condition
*
* \param values Stores the initial values for the conservation equations in
* \f$ [ \textnormal{unit of primary variables} ] \f$
* \param globalPos The global position
*/
PrimaryVariables initial_(const GlobalPosition &globalPos) const
......
......@@ -67,7 +67,7 @@ public:
/*!
* \brief The constructor
*
* \param gridView The grid view
* \param fvGridGeometry The finite volume grid geometry
*/
InjectionSpatialParams(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
......
......@@ -41,7 +41,7 @@
namespace Dumux {
/*!
* \ingroup TwoPTwoCTests
* \briefProblem where air is injected in a unsaturated porous medium. This test compares a mpnc problem with a 2p2c problem
* \brief Problem where air is injected in a unsaturated porous medium. This test compares a mpnc problem with a 2p2c problem
*/
template <class TypeTag>
class TwoPTwoCComparisonProblem;
......@@ -126,8 +126,7 @@ public:
/*!
* \brief The constructor
*
* \param timeManager The time manager
* \param gridView The grid view
* \param fvGridGeometry The finite volume grid geometry
*/
TwoPTwoCComparisonProblem(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
......@@ -163,7 +162,6 @@ public:
/*!
* \brief Returns the temperature \f$ K \f$
*
* \param globalPos The global position
*/
Scalar temperature() const
{ return temperature_; }
......@@ -200,13 +198,10 @@ public:
* \brief Evaluates 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 element The finite element
* \param fvGeometry The finite volume geometry of the element
* \param intersection The intersection between element and boundary
* \param scvIdx The local index of the sub-control volume
* \param boundaryFaceIdx The index of the boundary face
* \param elemVolVars The element volume variables
* \param scvf The sub-control volume face
*
* Negative values mean influx.
*/
......@@ -229,7 +224,6 @@ public:
/*!
* \brief Evaluate the initial value for a control volume.
*
* \param values The initial 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
......
......@@ -36,7 +36,6 @@ namespace Dumux {
/**
* \ingroup MPNCModel
* \ingroup ImplicitTestProblems
* \brief Definition of the spatial params properties for the obstacle problem
*
*/
......@@ -103,7 +102,7 @@ public:
/*!
* \brief Define the porosity \f$[-]\f$ of the soil
*
* \param pos The global position of the sub-control volume.
* \param globalPos The global position of the sub-control volume.
* \return the material parameters object
*/
Scalar porosityAtPos(const GlobalPosition& globalPos) const
......@@ -114,7 +113,7 @@ public:
/*!
* \brief Function for defining the parameters needed by constitutive relationships (kr-sw, pc-sw, etc.).
*
* \param pos The global position of the sub-control volume.
* \param globalPos The global position of the sub-control volume.
* \return the material parameters object
*/
const MaterialLawParams& materialLawParamsAtPos(const GlobalPosition& globalPos) const
......@@ -129,7 +128,7 @@ public:
* \brief Function for defining which phase is to be considered as the wetting phase.
*
* \return the wetting phase index
* \param globalPos The position of the center of the element
* \param globalPos The global position of the sub-control volume.
*/
template<class FluidSystem>
int wettingPhaseAtPos(const GlobalPosition& globalPos) const
......@@ -139,6 +138,7 @@ private:
/*!
* \brief Returns whether a given global position is in the
* fine-permeability region or not.
* \param pos The global position of the sub-control volume.
*/
static bool isFineMaterial_(const GlobalPosition &pos)
{
......
......@@ -83,7 +83,6 @@ struct UseMoles<TypeTag, TTag::WaterAir> { static constexpr bool value = true; }
/*!
* \ingroup TwoPTwoCModel
* \ingroup ImplicitTestProblems
* \brief Non-isothermal gas injection problem where a gas (e.g. air)
* is injected into a fully water saturated medium. During
* buoyancy driven upward migration the gas passes a high
......@@ -164,8 +163,7 @@ public:
/*!
* \brief The constructor.
*
* \param timeManager The time manager
* \param gridView The grid view
* \param fvGridGeometry The finite volume grid geometry
*/
WaterAirProblem(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
......@@ -209,7 +207,6 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment.
*
* \param values 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
......@@ -274,7 +271,6 @@ public:
/*!
* \brief Evaluate the initial value for a control volume.
*
* \param values The initial values for the primary variables
* \param globalPos The position for which the initial condition should be evaluated
*
* For this method, the \a values parameter stores primary
......
......@@ -37,7 +37,6 @@ namespace Dumux {
/*!
* \ingroup TwoPTwoCModel
* \ingroup ImplicitTestProblems
* \brief Definition of the spatial parameters for the water-air problem
*/
template<class FVGridGeometry, class Scalar>
......@@ -68,7 +67,7 @@ public:
/*!
* \brief The constructor
*
* \param gridView The grid view
* \param fvGridGeometry The finite volume grid geometry
*/
WaterAirSpatialParams(std::shared_ptr<const FVGridGeometry> fvGridGeometry) : ParentType(fvGridGeometry)
{
......
......@@ -125,8 +125,7 @@ public:
/*!
* \brief The constructor
*
* \param timeManager The time manager
* \param gridView The grid view
* \param fvGridGeometry The finite volume grid geometry
*/
TwoPNCDiffusionProblem(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
......@@ -177,7 +176,6 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment
*
* \param values Stores the value of the boundary type
* \param globalPos The global position
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
......@@ -191,8 +189,6 @@ public:
* \brief Evaluates the boundary conditions for a Dirichlet
* boundary segment
*
* \param values Stores the Dirichlet values for the conservation equations in
* \f$ [ \textnormal{unit of primary variable} ] \f$
* \param globalPos The global position
*/
PrimaryVariables dirichletAtPos(const GlobalPosition &globalPos) const
......@@ -215,8 +211,9 @@ public:
* For this method, the \a priVars parameter stores the mass flux
* in normal direction of each component. Negative values mean
* influx.
* \param globalPos The global position
*
* The units must be according to either using mole or mass fractions. (mole/(m^2*s) or kg/(m^2*s))
* \note The units must be according to either using mole or mass fractions. (mole/(m^2*s) or kg/(m^2*s))
*/
NumEqVector neumannAtPos(const GlobalPosition& globalPos) const
{
......@@ -234,8 +231,6 @@ public:
/*!
* \brief Evaluates the initial values for a control volume
*
* \param values Stores the initial values for the conservation equations in
* \f$ [ \textnormal{unit of primary variables} ] \f$
* \param globalPos The global position
*/
PrimaryVariables initialAtPos(const GlobalPosition &globalPos) const
......@@ -251,8 +246,6 @@ private:
*
* The internal method for the initial condition
*
* \param values Stores the initial values for the conservation equations in
* \f$ [ \textnormal{unit of primary variables} ] \f$
* \param globalPos The global position
*/
PrimaryVariables initial_(const GlobalPosition &globalPos) const
......
......@@ -66,7 +66,7 @@ public:
/*!
* \brief The constructor
*
* \param gridView The grid view
* \param fvGridGeometry The finite volume grid geometry
*/
TwoPNCDiffusionSpatialParams(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry), K_(0)
......
......@@ -137,8 +137,7 @@ public:
/*!
* \brief The constructor
*
* \param timeManager The time manager
* \param gridView The grid view
* \param fvGridGeometry The finite volume grid geometry
*/
FuelCellProblem(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
......
......@@ -65,7 +65,7 @@ public:
/*!
* \brief The constructor
*
* \param gridView The grid view
* \param fvGridGeometry The finite volume grid geometry
*/
FuelCellSpatialParams(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry), K_(0)
......
......@@ -341,8 +341,6 @@ public:
* potentially solution dependent and requires some quantities that
* are specific to the fully-implicit method.
*
* \param values The source and sink values for the conservation equations in units of
* \f$ [ \textnormal{unit of conserved quantity} / (m^3 \cdot s )] \f$
* \param element The finite element
* \param fvGeometry The finite-volume geometry
* \param elemVolVars All volume variables for the element
......
......@@ -118,6 +118,7 @@ public:
*
* \param element The finite volume element
* \param scv The sub-control volume
* \param elemSol The element solution
*
* Solution dependent permeability function
*/
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment