Commit 5d78ed31 authored by Gabi Seitz's avatar Gabi Seitz
Browse files

[doxygen] add missing class documentations

parent 6bb5defd
......@@ -278,6 +278,10 @@ void print(std::ostream &os = std::cout)
const char *getString_(const char *foo = 0)
{ return foo; }
/*!
* \ingroup Parameter
* \brief Class sorting params and runTimeParams
*/
template <class TypeTag>
class Param
{
......
......@@ -49,6 +49,10 @@ NEW_PROP_TAG(TimeManager);
} // end namespace Properties
// forward declarations
/*!
* \ingroup Common
* \brief A point helper class
*/
template<class TypeTag>
class PointSourceHelper;
......
......@@ -32,7 +32,9 @@
namespace Dumux
{
/*!
* \brief An SCSG element mapper that sorts the indices in order to optimize the matrix sparsity pattern
*/
template<class GridView, int codimension>
class ReorderingDofMapper
: public Dune::Mapper<typename GridView::Grid, ReorderingDofMapper<GridView, codimension>, typename GridView::IndexSet::IndexType>
......
......@@ -386,6 +386,8 @@ public:
typedef Dune::FieldVector<Scalar, numEq> type;
};
/*! @copydoc Properties::NonoverlappingSolverTraits
*/
template <class TypeTag, class MType, class VType, bool isParallel>
class ElasticTwoPSolverTraits
: public NonoverlappingSolverTraits<MType, VType, isParallel>
......@@ -394,6 +396,8 @@ public:
typedef typename GET_PROP_TYPE(TypeTag, JacobianMatrix) JacobianMatrix;
};
/*! @copydoc Properties::NonoverlappingSolverTraits
*/
template <class TypeTag, class MType, class VType>
class ElasticTwoPSolverTraits<TypeTag, MType, VType, true>
: public NonoverlappingSolverTraits<MType, VType, true>
......
......@@ -501,6 +501,9 @@ class FractureMapper
typedef typename GET_PROP_TYPE(TypeTag, GridCreator) GridCreator;
public:
// mapper: one data element in every entity
/*!
* \brief Maps one data element in every entity
*/
template<int dim>
struct FaceLayout
{
......
......@@ -52,6 +52,8 @@ namespace Properties
//! The type traits required for using the AMG backend
NEW_PROP_TAG(AmgTraits);
/*! \brief Non-overlapping solver traits for parallel computing
*/
template <class MType, class VType, bool isParallel>
class NonoverlappingSolverTraits
{
......@@ -63,6 +65,8 @@ public:
};
#if HAVE_MPI
/*! \brief Non-overlapping solver traits for parallel computing if MPI available
*/
template <class MType, class VType>
class NonoverlappingSolverTraits<MType, VType, true>
{
......@@ -95,7 +99,8 @@ public:
typedef typename SolverTraits::ScalarProduct ScalarProduct;
typedef typename SolverTraits::Smoother Smoother;
};
/*! \brief Overlapping solver traits for parallel computing
*/
template <class MType, class VType, bool isParallel>
class OverlappingSolverTraits
{
......@@ -107,6 +112,8 @@ public:
};
#if HAVE_MPI
/*! \brief Non-overlapping solver traits for parallel computing if MPI available
*/
template <class MType, class VType>
class OverlappingSolverTraits<MType, VType, true>
{
......
......@@ -39,7 +39,9 @@ extern "C"
namespace Dumux
{
/*!
* \brief An interface to the scotch library for matrix reordering
*/
template<class IndexType>
class ScotchBackend
{
......
......@@ -45,6 +45,11 @@ class DUNE_DEPRECATED_MSG("CompositionFromFugacities2pncmin is deprecated. Use C
: public CompositionFromFugacities<Scalar, FluidSystem>
{ };
/*!
* \ingroup ConstraintSolver
* \brief Calculates the chemical equilibrium from the component
* fugacities in a phase.
*/
template <class Scalar, class FluidSystem>
class DUNE_DEPRECATED_MSG("compositionFromFugacities2pncmin is deprecated. Use CompositionFromFugacities instead.")
compositionFromFugacities2pncmin
......
......@@ -30,7 +30,9 @@
namespace Dumux
{
/*!
* \brief Contains the phase indices
*/
struct JohansenIndices
{
static const int wPhaseIdx = 0;
......
......@@ -28,7 +28,9 @@
namespace Dumux
{
/*!
* \brief Indices for the wetting and the non-wetting Phase
*/
struct SomertonIndices
{
static constexpr int wPhaseIdx = 0;
......
......@@ -28,7 +28,9 @@
namespace Dumux
{
/*!
* \brief Indices for three permanent phases
*/
struct SimpleThreePIndices
{
static const int wPhaseIdx = 0;
......
......@@ -116,6 +116,9 @@ public:
typedef Dune::FieldVector<Scalar, 2> TimeStepFluxType;
protected:
/**
* \brief Data for local timestepping
*/
struct LocalTimesteppingData
{
Dune::FieldVector<EntryType, 2*dim> faceFluxes;
......
......@@ -39,6 +39,7 @@ namespace Dumux
/*!
* \ingroup TwoPMincModel
* \brief Adaption of the fully implicit scheme to the two-phase flow model.
*/
template<class TypeTag >
class TwoPMincModel : public TwoPModel<TypeTag>
......
......@@ -218,7 +218,11 @@ protected:
Scalar moleFraction_[numPhases][numComponents];
};
/*!
* \ingroup MPNCModel
* \ingroup ImplicitFluxVariables
* \brief Variables for the diffusive fluxes in the MpNc model
*/
template<class TypeTag>
class MPNCFluxVariablesDiffusion<TypeTag, false>
{
......
......@@ -144,6 +144,11 @@ protected:
Scalar diffCoeffG_[numComponents][numComponents];
};
/*!
* \brief Variables for the disabled diffusive fluxes in the MpNc model within
* a finite volume.
*/
// dummy class for the case where diffusion is disabled
template<class TypeTag>
class MPNCVolumeVariablesDiffusion<TypeTag, false>
......
......@@ -34,7 +34,7 @@ namespace Dumux
/*!
* \ingroup MPNCModel
* \ingroup ImplicitFluxVariables
* \brief Variables for the enthalpy fluxes in the MpNc model
* \brief Variables for the enthalpy fluxes in the MpNc model for the isothermal case
*/
template <class TypeTag, bool enableEnergy/*=false*/, int numEnergyEquations/*=0*/>
class MPNCFluxVariablesEnergy
......@@ -81,6 +81,11 @@ public:
{}
};
/*!
* \ingroup MPNCModel
* \ingroup ImplicitFluxVariables
* \brief Variables for the enthalpy fluxes in the MpNc model
*/
template <class TypeTag>
class MPNCFluxVariablesEnergy<TypeTag, /*enableEnergy=*/true, /*numEnergyEquations=*/1>
{
......
......@@ -119,7 +119,10 @@ public:
}
};
/*!
* \brief Specialization of the energy module for the nonisothermal case.
*
*/
template <class TypeTag>
class MPNCLocalResidualEnergy<TypeTag, /*enableEnergy=*/true, /*numEnergyEquations=*/ 1 >
{
......
......@@ -36,7 +36,7 @@
namespace Dumux {
/*!
* \brief A MpNc specific controller for the newton solver, which knows
* \brief A MpNc specific controller for the newton solver assuming local thermal equilibrium, which knows
* 'physically meaningful' solution.
*/
template <class TypeTag, bool enableKinetic /* = false */>
......@@ -97,6 +97,10 @@ private:
};
/*!
* \brief A MpNc specific controller for the newton solver, which knows
* 'physically meaningful' solution.
*/
template <class TypeTag>
class MpNcNewtonChop<TypeTag, /*enableKinetic=*/true>
{
......
......@@ -40,6 +40,11 @@ namespace Dumux
////////////////////////////////////////////////////////////////////////////////////////////////////
// specialization for the case of kinetic mass AND energy transfer
////////////////////////////////////////////////////////////////////////////////////////////////////
/*!
* \brief Volume variables required for the modules which require the specific interfacial
* area between fluid phases. This is the specialization for the case of kinetic
* mass AND energy transfer
*/
template <class TypeTag, bool enableKinetic >
class MPNCVolumeVariablesIA<TypeTag, enableKinetic, /*numEnergyEqs=*/3>
{
......@@ -332,6 +337,11 @@ private:
/////////////////////////////////////////////////////////////////////////////////////////////////////////////
// specialization for the case of NO kinetic mass but kinteic energy transfer of a fluid mixture and solid
/////////////////////////////////////////////////////////////////////////////////////////////////////////////
/*!
* \brief Volume variables required for the modules which require the specific interfacial
* area between fluid phases. This is the specialization for the case of NO kinetic
* mass but kinteic energy transfer of a fluid mixture and solid
*/
template <class TypeTag>
class MPNCVolumeVariablesIA<TypeTag, /*enableKinetic=*/false, /*numEnergyEqs=*/2>
{
......@@ -471,6 +481,11 @@ private:
////////////////////////////////////////////////////////////////////////////////////////////////////
// specialization for the case of (only) kinetic mass transfer
////////////////////////////////////////////////////////////////////////////////////////////////////
/*!
* \brief Volume variables required for the modules which require the specific interfacial
* area between fluid phases. This is the specialization specialization for the case
* of (only) kinetic mass transfer
*/
template <class TypeTag>
class MPNCVolumeVariablesIA<TypeTag, /*enableKinetic=*/true, /*numEnergyEqs=*/0>
{
......
......@@ -47,6 +47,11 @@ namespace Properties
#endif
}
/*!
*
* \brief Bounding box tree tests
*/
template<class TypeTag>
class BBoxTreeTests
{
......
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