Commit fb2a953c authored by Kilian Weishaupt's avatar Kilian Weishaupt

Merge branch 'cleanup/doxygen-for-3.3' into 'master'

Doxygen for 3.3

Closes #920

See merge request !2258
parents b94d0fc1 ec03d839
......@@ -265,6 +265,10 @@
* \brief Models linear elastic deformation of a solid. Takes fluid pressure into account.
* For a detailed model decription see geomechanics/poroelastic/model.hh
*/
/*!
* \defgroup Geometry Geometry
* \brief Basic geometries in DuMu<sup>x</sup>
*/
/* ***************** Discretization ******************/
/*!
......@@ -524,11 +528,6 @@
* \defgroup Common Common
* \brief Common classes, functions, properties and concepts
*/
/*!
* \ingroup Common
* \defgroup Geometry Geometry
* \brief Basic geometries in DuMu<sup>x</sup>
*/
/*!
* \ingroup Common
* \defgroup Properties Properties
......
......@@ -537,7 +537,8 @@ struct LinearTable
/*!
* \brief interpolate linearly in a piecewise linear function (tabularized function)
* \param ip the interpolation point
* \param table the table as a pair of sorted vectors (have to be same size)
* \param range positions of values
* \param values values to interpolate from
* \note if the interpolation point is out of bounds this will return the bounds
*/
template<class Scalar, class RandomAccessContainer0, class RandomAccessContainer1>
......
......@@ -158,7 +158,7 @@ public:
/*!
* \brief Evaluate the inverse function
* \param x the x-coordinate
* \param y the y-coordinate
* \note We extrapolate linearly if out of bounds
* \note Throws exception if inverse could not be found (e.g. not unique)
*/
......
......@@ -33,14 +33,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
class FreeflowNCFluxVariablesImpl;
/*!
* \ingroup FreeflowNCModel
* \brief The flux variables class for the multi-component free-flow model using the staggered grid discretization.
*/
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
class FreeflowNCFluxVariablesImpl;
template<class TypeTag>
class FreeflowNCFluxVariablesImpl<TypeTag, DiscretizationMethod::staggered>
: public NavierStokesFluxVariables<TypeTag>
......
......@@ -30,14 +30,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
class FreeflowNCResidualImpl;
/*!
* \ingroup FreeflowNCModel
* \brief Element-wise calculation of the multi-component free-flow residual for models using the staggered discretization
*/
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
class FreeflowNCResidualImpl;
template<class TypeTag>
class FreeflowNCResidualImpl<TypeTag, DiscretizationMethod::staggered>
: public NavierStokesResidual<TypeTag>
......
......@@ -43,14 +43,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
class NavierStokesFluxVariablesImpl;
/*!
* \ingroup NavierStokesModel
* \brief The flux variables class for the Navier-Stokes model using the staggered grid discretization.
*/
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
class NavierStokesFluxVariablesImpl;
template<class TypeTag>
class NavierStokesFluxVariablesImpl<TypeTag, DiscretizationMethod::staggered>
: public FluxVariablesBase<GetPropType<TypeTag, Properties::Problem>,
......
......@@ -42,14 +42,15 @@ template<int radialAxis>
static constexpr bool isRotationalExtrusion<RotationalExtrusion<radialAxis>> = true;
} // end namespace Impl
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
class NavierStokesResidualImpl;
/*!
* \ingroup NavierStokesModel
* \brief Element-wise calculation of the Navier-Stokes residual for models using the staggered discretization
*/
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
class NavierStokesResidualImpl;
template<class TypeTag>
class NavierStokesResidualImpl<TypeTag, DiscretizationMethod::staggered>
: public StaggeredLocalResidual<TypeTag>
......
......@@ -73,7 +73,7 @@
* \f[ c_\text{w2} = 0.3 \f]
* \f[ c_\text{w3} = 2 \f]
* \f[ \kappa = 0.41 \f]
* \f[ \sigma_{\tilde{\nu}}} = 2/3 \f]
* \f[ \sigma_{\tilde{\nu}} = 2/3 \f]
*/
#ifndef DUMUX_ONEEQ_MODEL_HH
......
......@@ -34,15 +34,16 @@
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseFluxVariables, DiscretizationMethod discMethod>
class OneEqFluxVariablesImpl;
/*!
* \ingroup OneEqModel
* \brief The flux variables class for the one-equation model by Spalart-Allmaras
* using the staggered grid discretization.
*/
// forward declaration
template<class TypeTag, class BaseFluxVariables, DiscretizationMethod discMethod>
class OneEqFluxVariablesImpl;
template<class TypeTag, class BaseFluxVariables>
class OneEqFluxVariablesImpl<TypeTag, BaseFluxVariables, DiscretizationMethod::staggered>
: public BaseFluxVariables
......
......@@ -31,15 +31,16 @@
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod>
class OneEqResidualImpl;
/*!
* \ingroup OneEqModel
* \brief Element-wise calculation of the residual for one-equation turbulence models
* using the staggered discretization
*/
// forward declaration
template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod>
class OneEqResidualImpl;
template<class TypeTag, class BaseLocalResidual>
class OneEqResidualImpl<TypeTag, BaseLocalResidual, DiscretizationMethod::staggered>
: public BaseLocalResidual
......
......@@ -34,14 +34,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseFluxVariables, DiscretizationMethod discMethod>
class KEpsilonFluxVariablesImpl;
/*!
* \ingroup KEpsilonModel
* \brief The flux variables class for the k-epsilon model using the staggered grid discretization.
*/
// forward declaration
template<class TypeTag, class BaseFluxVariables, DiscretizationMethod discMethod>
class KEpsilonFluxVariablesImpl;
template<class TypeTag, class BaseFluxVariables>
class KEpsilonFluxVariablesImpl<TypeTag, BaseFluxVariables, DiscretizationMethod::staggered>
: public BaseFluxVariables
......
......@@ -31,14 +31,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod>
class KEpsilonResidualImpl;
/*!
* \ingroup KEpsilonModel
* \brief Element-wise calculation of the residual for k-epsilon models using the staggered discretization
*/
// forward declaration
template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod>
class KEpsilonResidualImpl;
template<class TypeTag, class BaseLocalResidual>
class KEpsilonResidualImpl<TypeTag, BaseLocalResidual, DiscretizationMethod::staggered>
: public BaseLocalResidual
......
......@@ -34,14 +34,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseFluxVariables, DiscretizationMethod discMethod>
class KOmegaFluxVariablesImpl;
/*!
* \ingroup KOmegaModel
* \brief The flux variables class for the k-omega model using the staggered grid discretization.
*/
// forward declaration
template<class TypeTag, class BaseFluxVariables, DiscretizationMethod discMethod>
class KOmegaFluxVariablesImpl;
template<class TypeTag, class BaseFluxVariables>
class KOmegaFluxVariablesImpl<TypeTag, BaseFluxVariables, DiscretizationMethod::staggered>
: public BaseFluxVariables
......
......@@ -31,14 +31,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod>
class KOmegaResidualImpl;
/*!
* \ingroup KOmegaModel
* \brief Element-wise calculation of the residual for k-omega models using the staggered discretization
*/
// forward declaration
template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod>
class KOmegaResidualImpl;
template<class TypeTag, class BaseLocalResidual>
class KOmegaResidualImpl<TypeTag, BaseLocalResidual, DiscretizationMethod::staggered>
: public BaseLocalResidual
......
......@@ -61,7 +61,7 @@
* \f].
*
* The auxiliary and dampening functions are defined as:
* \f[ D_\varepsilon = 2 \nu \nicefrac{k}{y^2} \f]
* \f[ D_\varepsilon = 2 \nu \frac{k}{y^2} \f]
* \f[ E_\text{k} = -2 \nu \frac{\tilde{\varepsilon}}{y^2} \exp \left( -0.5 y^+ \right) \f]
* \f[ f_1 = 1 \f]
* \f[ f_2 = 1 - 0.22 \exp \left( - \left( \frac{\mathit{Re}_\text{t}}{6} \right)^2 \right) \f]
......
......@@ -34,14 +34,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseFluxVariables, DiscretizationMethod discMethod>
class LowReKEpsilonFluxVariablesImpl;
/*!
* \ingroup LowReKEpsilonModel
* \brief The flux variables class for the low-Reynolds k-epsilon model using the staggered grid discretization.
*/
// forward declaration
template<class TypeTag, class BaseFluxVariables, DiscretizationMethod discMethod>
class LowReKEpsilonFluxVariablesImpl;
template<class TypeTag, class BaseFluxVariables>
class LowReKEpsilonFluxVariablesImpl<TypeTag, BaseFluxVariables, DiscretizationMethod::staggered>
: public BaseFluxVariables
......
......@@ -31,14 +31,15 @@
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod>
class LowReKEpsilonResidualImpl;
/*!
* \ingroup LowReKEpsilonModel
* \brief Element-wise calculation of the residual for low-Reynolds k-epsilon models using the staggered discretization
*/
// forward declaration
template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod>
class LowReKEpsilonResidualImpl;
template<class TypeTag, class BaseLocalResidual>
class LowReKEpsilonResidualImpl<TypeTag, BaseLocalResidual, DiscretizationMethod::staggered>
: public BaseLocalResidual
......
......@@ -320,9 +320,8 @@ auto createPVNameFunction(const std::string& paramGroup = "")
* \brief load a solution vector from file
* \note Supports the following file extensions: *.vtu *.vtp *.pvtu, *.pvtp
* \param sol the solution vector to read from file
* \param loadedSolutionSize the dimension of the loaded solution's primary variables
* \param fileName the file name of the file to read from
* \param pvNameFunc a function with the signature std::string(int pvIdx)
* \param targetPvNameFunc a function with the signature std::string(int pvIdx)
* in case the primary variables have a state the signature is std::string(int pvIdx, int state)
* \param gridGeometry the grid geometry of the discretization method used
*/
......
......@@ -75,7 +75,7 @@ public:
/*!
* \brief Constructor
* \param rStep characteristic relative integration length in r-direction (real number between 0 and 1)
* \param zSamples characteristic relative integration length in z-direction (real number between 0 and 1)
* \param zStep characteristic relative integration length in z-direction (real number between 0 and 1)
* \note Use this constructor to achieve a non-balanced (away from 1) aspect ratio between r and z-direction
*/
CylinderIntegration(const Scalar rStep, const Scalar zStep)
......
......@@ -55,12 +55,12 @@
* if a fluid phase is not present, the sum of the mole fractions of
* this fluid phase is smaller than \f$1\f$, i.e.
* \f[
* \forall \alpha: S_\alpha = 0 \implies \sum_\kappa x_\alpha^\kappa \leq 1
* \forall \alpha: S_\alpha = 0 \Rightarrow \sum_\kappa x_\alpha^\kappa \leq 1
* \f]
*
* Also, if a fluid phase may be present at a given spatial location
* its saturation must be positive:
* \f[ \forall \alpha: \sum_\kappa x_\alpha^\kappa = 1 \implies S_\alpha \geq 0 \f]
* \f[ \forall \alpha: \sum_\kappa x_\alpha^\kappa = 1 \Rightarrow S_\alpha \geq 0 \f]
*
* Since at any given spatial location, a phase is always either
* present or not present, one of the strict equalities on the
......
Markdown is supported
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