Commit a376bbd8 authored by Johannes Hommel's avatar Johannes Hommel Committed by Simon Scholz
Browse files

[doxygen] reduced erros in common, discretization, and geomechanics

parent b21ce41f
......@@ -446,8 +446,10 @@ public:
* the tolerance
* - Mark all neighbors of 'red' elements also 'red'
*
* \param assembler the assembler
* \param distanceFromLastLinearization The distance from the last linearization
* \param threshold Reassemble only if the distance from the last
* linearization is above this value.
* linearization is above this value.
*/
void computeColors(const Assembler& assembler,
const std::vector<Scalar>& distanceFromLastLinearization,
......
......@@ -338,7 +338,7 @@ public:
* \note Algorithm based on the one from "Real-Time Collision Detection" by Christer Ericson,
* published by Morgan Kaufmann Publishers, (c) 2005 Elsevier Inc. (Chapter 5.3.6)
* \param geo1/geo2 The geometries to intersect
* \param intersection If the geometries collide intersection holds the corner points of
* \param is If the geometries collide, is holds the corner points of
* the intersection object in global coordinates.
*/
template<int dimIntersection>
......
......@@ -499,7 +499,6 @@ namespace InterpolationPolicy { struct Linear; }
* \brief a generic function to interpolate given a set of parameters and an interpolation point
* \param params the parameters used for interpolation (depends on the policy used)
* \param ip the interpolation point
* \param policy the interpolation policy
*/
template <class Policy = InterpolationPolicy::Linear, class Scalar, class Parameter>
Scalar interpolate(Scalar ip, Parameter&& params)
......@@ -520,7 +519,7 @@ struct Linear
/*!
* \brief interpolate linearly between two given values
* \param ip the interpolation point in [0,1]
* \param array with the lower and upper bound
* \param params array with the lower and upper bound
*/
template<class Scalar>
static constexpr Scalar interpolate(Scalar ip, const std::array<Scalar, 2>& params)
......
......@@ -41,6 +41,7 @@ public:
/*!
* \brief Computes the epsilon used for numeric differentiation
* \param value The value of the variable with respect to which we are differentiating
* \param baseEps The step width which we are using for differentiation
*/
template<class Scalar>
static Scalar epsilon(const Scalar value, const Scalar baseEps = 1e-10)
......
......@@ -78,7 +78,7 @@ public:
* \brief Initialize the parameter tree
* \param argc number of command line argument (forwarded from main)
* \param argv command line argument (forwarded from main)
* \param a function that sets parameters of the default runtim parameter tree
* \param defaultParams a function that sets parameters of the default runtime parameter tree
* \param parameterFileName the file name of the input file
* \param usage the usage function to print if the help option was passed on the command line
* \note the default parameter tree is initialized in the following way
......
......@@ -87,6 +87,7 @@ public:
* \param element The finite element
* \param fvGeometry The finite-volume geometry
* \param scv The sub control volume
* \param pvIdx The primary variable index
*/
bool isDirichletCell(const Element& element,
const FVElementGeometry& fvGeometry,
......@@ -129,6 +130,9 @@ public:
*
* This is the method for the case where the Neumann condition is
* potentially solution dependent
* \param element The finite element
* \param fvGeometry The finite-volume geometry
* \param elemVolVars All volume variables for the element
* \param elemFaceVars All face variables for the element
* \param scvf The sub control volume face
*
......
......@@ -128,7 +128,7 @@ public:
*
* \param eg Geometry of the element the facet is embedded in
* \param refElement Reference element of the element the facet is embedded in
* \param indexInInside The local index of the facet in the element
* \param indexInElement The local index of the facet in the element
* \param numCorners The number of corners on the facet
*/
template<class ElementGeometry, class ReferenceElement>
......@@ -156,7 +156,7 @@ public:
* \brief Returns the corners of the sub control volume face constructed
* in a corner (vertex) of an intersection.
*
* \param scvfCornerPositions Container with all scvf corners of the intersection
* \param p Container with all scvf corners of the intersection
* \param numIntersectionCorners Number of corners of the intersection (required in 3d)
* \param cornerIdx Local vertex index on the intersection
*/
......@@ -411,7 +411,7 @@ public:
* \brief Returns the corners of the sub control volume face constructed
* in a corner (vertex) of an intersection.
*
* \param scvfCornerPositions Container with all scvf corners of the intersection
* \param p Container with all scvf corners of the intersection
* \param numIntersectionCorners Number of corners of the intersection
* \param cornerIdx Local vertex index on the intersection
*/
......
......@@ -41,7 +41,7 @@ namespace Dumux
*
* \param scvf The sub-control volume face
* \param scv The neighboring sub-control volume
* \param K The tensor living in the neighboring scv
* \param T The tensor living in the neighboring scv
* \param extrusionFactor The extrusion factor of the scv
*/
template< class SubControlVolumeFace, class SubControlVolume, class Tensor >
......
......@@ -35,7 +35,7 @@ namespace Dumux {
* \brief Helper function to create a PrimaryVariables object from CellCenterPrimaryVariables
* \tparam PrimaryVariables The type of the desired primary variables object
* \tparam CellCenterPrimaryVariables The type of the cell center (input) primary variables object
* \param cellCenterPrimaryVariables The cell center (input) primary variables object
* \param cellCenterPriVars The cell center (input) primary variables object
*/
template<class PrimaryVariables, class CellCenterPrimaryVariables>
PrimaryVariables makePriVarsFromCellCenterPriVars(const CellCenterPrimaryVariables& cellCenterPriVars)
......@@ -71,7 +71,7 @@ auto elementSolution(PrimaryVariables&& priVars)
* \brief Helper function to create an elementSolution from cell center primary variables
* \tparam PrimaryVariables The type of the desired primary variables object
* \tparam CellCenterPrimaryVariables The type of the cell center (input) primary variables object
* \param cellCenterPrimaryVariables The cell center (input) primary variables object
* \param cellCenterPriVars The cell center (input) primary variables object
*/
template<class PrimaryVariables, class CellCenterPrimaryVariables>
StaggeredElementSolution<PrimaryVariables> makeElementSolutionFromCellCenterPrivars(const CellCenterPrimaryVariables& cellCenterPriVars)
......
......@@ -114,7 +114,7 @@ public:
* \param element The current element
* \param fvGeometry The local finite volume geometry
* \param elemVolVars Primary/Secondary variables inside the element
* \param FluxVarsCache Contains data on shape functions at the integration point
* \param fluxVarsCache Contains data on shape functions at the integration point
*/
template< class ElemVolVars, class FluxVarsCache, int n = numFP, std::enable_if_t<(n > 0), int> = 0 >
Scalar effectivePorePressure(const Element& element,
......
......@@ -21,7 +21,7 @@
* \ingroup MultiDomain
* \ingroup PoroElastic
* \ingroup PorousMediumFlow
* \brief \copydoc Dumux::PMFlowFlowPoroMechanicsCouplingManager
* \brief Coupling manager for porous medium flow problems coupled to a poro-mechanical problem
*/
#ifndef DUMUX_POROMECHANICS_COUPLING_MANAGER_HH
......@@ -42,7 +42,9 @@ namespace Dumux {
* \ingroup MultiDomain
* \ingroup PoroElastic
* \ingroup PorousMediumFlow
* \brief Coupling manager for porous medium flow problems coupled to a poro-mechanical
* \brief Coupling manager for porous medium flow problems coupled to a poro-mechanical problem
*
* Coupling manager for porous medium flow problems coupled to a poro-mechanical
* problem both defined on the same grid. Coupling occurs via the change of porosity
* and permeability due to mechanical deformations and the influence of the pore
* pressure on the effecive stresses acting on the porous medium.
......
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