Commit 5f1f690b authored by Simon Scholz's avatar Simon Scholz
Browse files

[doxygen][co2] fix errors in co2 porousmediumflow

parent 1bb73815
......@@ -149,13 +149,15 @@ public:
/*!
* \brief Complete the fluid state
*
* \note TODO: This is a lot of copy paste from the 2p2c: factor out code!
*
* \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.
*/
......
......@@ -134,8 +134,7 @@ struct UseMoles<TypeTag, TTag::HeterogeneousNI> { static constexpr bool value =
} // end namespace Properties
/*!
* \ingroup CO2Model
* \ingroup ImplicitTestProblems
* \ingroup CO2Tests
* \brief Definition of a problem, where CO2 is injected in a reservoir.
*
* The domain is sized 200m times 100m and consists of four layers, a
......@@ -220,8 +219,8 @@ public:
/*!
* \brief The constructor
*
* \param timeManager The time manager
* \param gridView The grid view
* \param fvGridGeometry The finite volume grid geometry
* \param spatialParams The spatial params
*/
template<class SpatialParams>
HeterogeneousProblem(std::shared_ptr<const FVGridGeometry> fvGridGeometry, std::shared_ptr<SpatialParams> spatialParams)
......@@ -331,7 +330,7 @@ public:
/*!
* \brief Returns the temperature within the domain.
*
* \param globalPos The position
* \param globalPos The global position
*
* This problem assumes a geothermal gradient with
* a surface temperature of 10 degrees Celsius.
......@@ -385,7 +384,7 @@ public:
* \brief Evaluates the boundary conditions for a Dirichlet
* boundary segment
*
* \param returns the Dirichlet values for the conservation equations in
* \return the Dirichlet values for the conservation equations in
* \f$ [ \textnormal{unit of primary variable} ] \f$
* \param globalPos The global position
*/
......@@ -400,8 +399,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
......@@ -413,7 +410,7 @@ public:
*/
NumEqVector neumann(const Element& element,
const FVElementGeometry& fvGeometry,
const ElementVolumeVariables& elemVolvars,
const ElementVolumeVariables& elemVolVars,
const SubControlVolumeFace& scvf) const
{
const auto boundaryId = scvf.boundaryFlag();
......@@ -443,7 +440,7 @@ public:
/*!
* \brief Evaluates the initial values at a position
*
* \returns the initial values for the conservation equations in
* \return the initial values for the conservation equations in
* \f$ [ \textnormal{unit of primary variables} ] \f$
* \param globalPos The global position
*/
......@@ -460,8 +457,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
......
......@@ -37,8 +37,7 @@
namespace Dumux {
/*!
* \ingroup CO2Model
* \ingroup ImplicitTestProblems
* \ingroup CO2Tests
* \brief Definition of the spatial parameters for the heterogeneous
* problem which uses the non-isothermal or isothermal CO2
* fully implicit model.
......@@ -68,7 +67,8 @@ public:
/*!
* \brief The constructor
*
* \param gridView The grid view
* \param fvGridGeometry The finite volume grid geometry
* \param gridData The grid data
*/
HeterogeneousSpatialParams(std::shared_ptr<const FVGridGeometry> fvGridGeometry,
std::shared_ptr<const GridData<Grid>> gridData)
......@@ -115,6 +115,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 instrinsic permeability
*/
template<class ElementSolution>
......@@ -131,7 +132,7 @@ public:
* \brief Function for defining the (intrinsic) permeability \f$[m^2]\f$
* \note It is possibly solution dependent.
*
* \param eIdx the element index
* \param eIdx The element index
*/
PermeabilityType permeability(std::size_t eIdx) 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