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

[doxygen][2p] fix errors in 2p porousmediumflow implict

sequential gets an extra commit
parent db278586
......@@ -48,8 +48,8 @@ public:
/*!
* \brief Update the scv -> dofparameter map
*
* \param The finite volume grid geometry
* \param SpatialParams Class encapsulating the spatial parameters
* \param fvGridGeometry The finite volume grid geometry
* \param spatialParams Class encapsulating the spatial parameters
* \param x The current state of the solution vector
*/
template<class FVGridGeometry, class SolutionVector>
......
......@@ -140,12 +140,13 @@ public:
* Compute derivatives for the wetting and the non-wetting phase flux with respect to \f$p_w\f$
* and \f$S_n\f$.
*
* \param partialDerivatives The partial derivatives
* \param derivativeMatrices The partial derivatives
* \param problem The problem
* \param element The element
* \param fvGeometry The finite volume element geometry
* \param curVolVars The current volume variables
* \param scv The sub control volume
* \param curElemVolVars The current element volume variables
* \param elemFluxVarsCache The element flux variables cache
* \param scvf The sub control volume face
*/
template<class PartialDerivativeMatrices, class T = TypeTag>
std::enable_if_t<GetPropType<T, Properties::FVGridGeometry>::discMethod == DiscretizationMethod::cctpfa, void>
......@@ -258,12 +259,13 @@ public:
* Compute derivatives for the wetting and the non-wetting phase flux with respect to \f$p_w\f$
* and \f$S_n\f$.
*
* \param partialDerivatives The partial derivatives
* \param A The Jacobian Matrix
* \param problem The problem
* \param element The element
* \param fvGeometry The finite volume element geometry
* \param curVolVars The current volume variables
* \param scv The sub control volume
* \param curElemVolVars The current element volume variables
* \param elemFluxVarsCache The element flux variables cache
* \param scvf The sub control volume face
*/
template<class JacobianMatrix, class T = TypeTag>
std::enable_if_t<GetPropType<T, Properties::FVGridGeometry>::discMethod == DiscretizationMethod::box, void>
......@@ -420,6 +422,7 @@ public:
* \param derivativeMatrices The matrices containing the derivatives
* \param problem The problem
* \param element The element
* \param fvGeometry The finite volume element geometry
* \param curElemVolVars The current element volume variables
* \param elemFluxVarsCache The element flux variables cache
* \param scvf The sub control volume face
......@@ -498,6 +501,7 @@ public:
* \param derivativeMatrices The matrices containing the derivatives
* \param problem The problem
* \param element The element
* \param fvGeometry The finite volume element geometry
* \param curElemVolVars The current element volume variables
* \param elemFluxVarsCache The element flux variables cache
* \param scvf The sub control volume face
......
......@@ -45,7 +45,7 @@ public:
* Reconstruction is only done when using the box method
* and enableReconstruction = true.
*
* \param SpatialParams Class encapsulating the spatial parameters
* \param spatialParams Class encapsulating the spatial parameters
* \param element The finite element the scv is embedded in
* \param scv The sub-control volume for which the saturation is computed
* \param elemSol The solution at all dofs inside this element
......@@ -69,7 +69,7 @@ public:
/*!
* \brief Compute the non-wetting phase saturation in an scv
*
* \param SpatialParams Class encapsulating the spatial parameters
* \param spatialParams Class encapsulating the spatial parameters
* \param element The finite element the scv is embedded in
* \param scv The sub-control volume for which the saturation is computed
* \param elemSol The solution at all dofs inside this element
......
......@@ -111,13 +111,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.
*/
......
......@@ -173,7 +173,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
......@@ -189,8 +188,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
......@@ -205,8 +202,6 @@ 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
......@@ -218,8 +213,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
......
......@@ -96,7 +96,10 @@ public:
/*!
* \brief Returns the porosity \f$[-]\f$
*
* \param globalPos The global position
* \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 porosity
*/
template<class ElementSolution>
Scalar porosity(const Element& element,
......
......@@ -178,8 +178,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
......@@ -197,8 +195,6 @@ 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
......@@ -224,8 +220,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
......
......@@ -137,7 +137,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
......@@ -154,8 +153,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
......@@ -185,8 +182,6 @@ 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
......@@ -208,8 +203,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
......
......@@ -160,8 +160,7 @@ public:
/*!
* \brief The constructor
*
* \param timeManager The time manager
* \param gridView The grid view
* \param fvGridGeometry The fvGridGeometry
*/
InjectionProblem2PNI(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
......@@ -195,8 +194,6 @@ public:
/*!
* \brief Returns the source term
*
* \param values Stores the source values for the conservation equations in
* \f$ [ \textnormal{unit of primary variable} / (m^\textrm{dim} \cdot s )] \f$
* \param globalPos The global position
*/
NumEqVector sourceAtPos(const GlobalPosition &globalPos) const
......@@ -217,7 +214,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
......@@ -235,8 +231,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
......@@ -253,8 +247,6 @@ 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 global position
*
* The \a values store the mass flux of each phase normal to the boundary.
......@@ -297,8 +289,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
......
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