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

[doxygen][1p] fix errors in 1p porousmediumflow

parent 3ce10edb
......@@ -71,7 +71,7 @@ public:
* \brief Constructs a DiffusionProblem1P object
*
* \param timeManager the time manager
* \param gridView The grid view
* \param grid The grid
*/
DiffusionProblem1P(TimeManager& timeManager, Grid& grid)
: ParentType(timeManager, grid), gravity_(0)
......@@ -86,7 +86,7 @@ public:
* \brief Constructs a DiffusionProblem1P object
*
* \param timeManager the time manager
* \param gridView The grid view
* \param grid The grid
* \param spatialParams SpatialParams instantiation
*/
DiffusionProblem1P(TimeManager& timeManager, Grid& grid, SpatialParams &spatialParams)
......@@ -101,7 +101,7 @@ public:
/*!
* \brief The constructor
*
* \param gridView The grid view
* \param grid The grid
*/
DiffusionProblem1P(Grid& grid)
: ParentType(grid, false), gravity_(0)
......@@ -115,7 +115,7 @@ public:
/*!
* \brief The constructor
*
* \param gridView The grid view
* \param grid The grid
* \param spatialParams SpatialParams instantiation
*/
DiffusionProblem1P(Grid& grid, SpatialParams& spatialParams)
......
......@@ -96,6 +96,7 @@ public:
* \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,
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTests
* \brief test for the one-phase CC model
*/
#include <config.h>
......
......@@ -123,7 +123,6 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary control volume.
*
* \param values The boundary types for the conservation equations
* \param globalPos The position of the center of the finite volume
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
......@@ -143,7 +142,6 @@ public:
* \brief Evaluate the boundary conditions for a dirichlet
* control volume.
*
* \param values The dirichlet 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 variables.
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTests
* \brief test for the one-phase CC model
*/
#include <config.h>
......
......@@ -123,7 +123,6 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary control volume.
*
* \param values The boundary types for the conservation equations
* \param globalPos The position of the center of the finite volume
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
......@@ -143,7 +142,6 @@ public:
* \brief Evaluate the boundary conditions for a dirichlet
* control volume.
*
* \param values The dirichlet 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 variables.
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTests
* \brief test for the one-phase CC model
*/
#include <config.h>
......
......@@ -181,8 +181,7 @@ 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 vertex The vertex for which the boundary type is set
* \param globalPos The global position
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
{
......@@ -200,8 +199,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
......@@ -220,8 +217,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
......
......@@ -54,7 +54,7 @@ public:
/*!
* \brief The constructor
*
* \param gridView The grid view
* \param fvGridGeometry The fvGridGeometry
*/
FractureSpatialParams(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTests
* \brief test for the one-phase CC model
*/
#include <config.h>
......
......@@ -150,7 +150,6 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary control volume.
*
* \param values The boundary types for the conservation equations
* \param globalPos The position of the center of the finite volume
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
......@@ -170,7 +169,6 @@ public:
* \brief Evaluate the boundary conditions for a dirichlet
* control volume.
*
* \param values The dirichlet 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 variables.
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTests
* \brief test for the one-phase CC model
*/
#include <config.h>
......
......@@ -177,7 +177,6 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary control volume.
*
* \param values The boundary types for the conservation equations
* \param globalPos The position of the center of the finite volume
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
......@@ -196,7 +195,6 @@ public:
* \brief Evaluate the boundary conditions for a dirichlet
* control volume.
*
* \param values The dirichlet 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 variables.
......
......@@ -110,7 +110,7 @@ public:
/*!
* \brief This method allows the generation of a statistical field using gstat
*
* \param gridView The GridView used by the problem
* \param gg The finite-volume grid Geometry used by the problem
*/
void initRandomField(const FVGridGeometry& gg)
{
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTests
* \brief test for the one-phase CC model
*/
#include <config.h>
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTests
* \brief test for the 1pni CC model
*/
#include <config.h>
......
......@@ -219,7 +219,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
......@@ -238,7 +237,6 @@ public:
* \brief Evaluate the boundary conditions for a dirichlet
* boundary segment.
*
* \param values The dirichlet values for the primary variables
* \param globalPos The position for which the bc type should be evaluated
*
* For this method, the \a values parameter stores primary variables.
......@@ -261,7 +259,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
......
......@@ -234,7 +234,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
......@@ -253,7 +252,6 @@ public:
* \brief Evaluate the boundary conditions for a dirichlet
* control volume.
*
* \param values The dirichlet 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 variables.
......@@ -267,14 +265,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.
......@@ -283,12 +277,12 @@ public:
*/
NumEqVector neumann(const Element& element,
const FVElementGeometry& fvGeometry,
const ElementVolumeVariables& elemVolvars,
const ElementVolumeVariables& elemVolVars,
const SubControlVolumeFace& scvf) const
{
NumEqVector values(0.0);
const auto globalPos = scvf.ipGlobal();
const auto& volVars = elemVolvars[scvf.insideScvIdx()];
const auto& volVars = elemVolVars[scvf.insideScvIdx()];
if(globalPos[0] < eps_)
{
......@@ -308,7 +302,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
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTests
* \brief test for the one-phase CC model
*/
#include <config.h>
......
......@@ -130,7 +130,6 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary control volume.
*
* \param values The boundary types for the conservation equations
* \param globalPos The position of the center of the finite volume
*/
BoundaryTypes boundaryTypesAtPos(const GlobalPosition &globalPos) const
......@@ -174,7 +173,6 @@ public:
* \brief Evaluate the boundary conditions for a Dirichlet
* control volume.
*
* \param values The Dirichlet 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 variables.
......
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