Commit 43cd6fbd authored by Bernd Flemisch's avatar Bernd Flemisch
Browse files

completed documentation class list

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4680 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 0ad29bb1
......@@ -44,9 +44,8 @@ NEW_PROP_TAG(Scalar);
// specialize member functions of template classes because of some
// weird reason I didn't really get...
/*!
* \internal
*/
//!< \cond INTERNAL
template <typename BoxFVElementGeometry, int dim>
class _BoxFVElemGeomHelper
{
......@@ -57,9 +56,6 @@ public:
};
};
/*!
* \internal
*/
template <typename BoxFVElementGeometry>
class _BoxFVElemGeomHelper<BoxFVElementGeometry, 1>
{
......@@ -73,9 +69,6 @@ public:
}
};
/*!
* \internal
*/
template <typename BoxFVElementGeometry>
class _BoxFVElemGeomHelper<BoxFVElementGeometry, 2>
{
......@@ -110,9 +103,6 @@ public:
}
};
/*!
* \internal
*/
template <typename BoxFVElementGeometry>
class _BoxFVElemGeomHelper<BoxFVElementGeometry, 3>
{
......@@ -286,6 +276,9 @@ public:
}
}
};
//!< \endcond
// END HACK
/////////////////////
......@@ -567,7 +560,7 @@ public:
bool inner;
};
struct SubControlVolumeFace
struct SubControlVolumeFace //! interior face of a sub control volume
{
int i,j; //!< scvf seperates corner i and j of elem
FV ipLocal; //!< integration point in local coords
......@@ -577,7 +570,8 @@ public:
Dune::FieldVector<Scalar, maxNC> shapeValue; //!< value of shape functions at ip
};
struct BoundaryFace {
struct BoundaryFace //! boundary face of a sub control volume
{
FV ipLocal; //!< integration point in local coords
FV ipGlobal; //!< integration point in global coords
Scalar area; //!< area of boundary face
......
......@@ -28,7 +28,7 @@ namespace Dumux {
namespace PDELab {
/*
/*!
* \brief An assembler for the Jacobian matrix based on PDELab.
*/
template<class TypeTag>
......
......@@ -96,7 +96,7 @@ public:
}
};
// extract type of container element
//! extract type of container element
template<class C>
struct Value
{
......
......@@ -31,8 +31,6 @@ namespace Dumux {
namespace PDELab {
/*!
* \file
*
* \brief A local operator for PDELab which wraps the box models.
*/
template<class TypeTag>
......
......@@ -27,10 +27,8 @@
namespace Dumux
{
//! \cond INTERNAL
/*!
* \internal
*
* \brief The common code for all 3rd order polynomial splines with
* more than two sampling points.
*/
......@@ -150,6 +148,8 @@ protected:
BlockVector m_;
};
//! \endcond
}
#endif
......@@ -44,6 +44,10 @@ NEW_PROP_TAG(ConstraintsTrafo);
namespace PDELab {
/*!
* \brief exchanges matrix entries for parallel computations
*/
template<class TypeTag>
class Exchanger
{
......@@ -67,6 +71,7 @@ class Exchanger
typedef typename Dune::GenericReferenceElement<CoordScalar, dim> ReferenceElement;
public:
Exchanger(const Problem& problem)
: gridView_(problem.gridView()), vertexMapper_(problem.vertexMapper()), borderIndices_(0)
{
......@@ -96,6 +101,9 @@ public:
}
}
/*!
* \brief matrix entry for the MatEntryExchange class
*/
struct MatEntry
{
IdType first;
......@@ -104,7 +112,9 @@ public:
MatEntry () {}
};
// A DataHandle class to exchange matrix entries
/*!
* \brief A DataHandle class to exchange matrix entries
*/
class MatEntryExchange
: public Dune::CommDataHandleIF<MatEntryExchange,MatEntry>
{
......@@ -242,7 +252,9 @@ private:
std::vector<int> borderIndices_;
};
// wrapped sequential preconditioner
/*!
* \brief Wrapper for a sequential preconditioner
*/
template<class CC, class GFS, class P>
class NonoverlappingWrappedPreconditioner
: public Dune::Preconditioner<typename P::domain_type,typename P::range_type>
......@@ -313,6 +325,9 @@ private:
const Dune::PDELab::ParallelISTLHelper<GFS>& helper;
};
/*!
* \brief backend for an ISTL parallel ILU preconditioned BiCGSTAB solver
*/
template<class TypeTag>
class ISTLBackend_NoOverlap_BCGS_ILU
{
......@@ -400,6 +415,9 @@ private:
Exchanger<TypeTag> exchanger_;
};
/*!
* \brief backend for an ISTL parallel Pardiso preconditioned loop solver
*/
template<class TypeTag>
class ISTLBackend_NoOverlap_Loop_Pardiso
{
......
......@@ -108,7 +108,7 @@ public:
{ this->set(points, m0, m1); }
};
/*
/*!
* \brief Specialization of a spline with the number of sampling
* points only known at run time.
*
......@@ -128,8 +128,6 @@ public:
s''(x_n) & = 0
\f}
*/
template<class Scalar>
class Spline<Scalar, -1> : public VariableLengthSpline_<Scalar>
{
......
......@@ -29,8 +29,8 @@
namespace Dumux
{
//! \cond INTERNAL
/*!
* \internal
*
* \brief The common code for all 3rd order polynomial splines.
*/
......@@ -589,6 +589,8 @@ protected:
{ return asImp_().numSamples(); }
};
//! \endcond
}
#endif
......@@ -28,10 +28,8 @@
namespace Dumux
{
//! \cond INTERNAL
/*
* \internal
*
* \brief The common code for all 3rd order polynomial splines with
* where the number of sampling points only known at run-time.
*/
......@@ -209,7 +207,7 @@ protected:
Vector yPos_;
Vector m_;
};
//! \endcond
}
#endif
......@@ -41,9 +41,11 @@
namespace Dumux
{
//! \ingroup MPFA2p
//! Base class for defining an instance of a numerical diffusion model.
/*! An interface for defining a numerical diffusion model for the
/*! \ingroup MPFA2p
*
* \brief MPFA-O method for the pressure equation
*
* An interface for defining a numerical diffusion model for the
* solution of equations of the form
* \f$ - \text{div}\, (\lambda K \text{grad}\, p ) = 0, \f$,
* \f$p = g\f$ on \f$\Gamma_1\f$, and
......
......@@ -28,7 +28,10 @@
namespace Dumux
{
//! \ingroup MPFA2p
/*! \ingroup MPFA2p
*
* \brief velocity calculation for the MPFA-O method
*/
template<class TypeTag> class FVMPFAOVelocity2P: public FVMPFAOPressure2P<TypeTag>
{
typedef FVMPFAOVelocity2P<TypeTag> ThisType;
......
......@@ -36,9 +36,11 @@
namespace Dumux
{
//! \ingroup mimetic
//! mimetic Diffusion Model
/*! Provides a mimetic implementation for the evaluation
/*! \ingroup mimetic
*
* \brief mimetic method for the pressure equation
*
* Provides a mimetic implementation for the evaluation
* of equations of the form
* \f[\text{div}\, \boldsymbol{v}_{total} = q.\f]
* The definition of the total velocity \f$\boldsymbol{v}_total\f$ depends on the kind of pressure chosen. This could be a wetting (w) phase pressure leading to
......
......@@ -50,7 +50,7 @@ namespace Properties
}
/*
/*!
* \brief A collection of functions for output purposes.
* These output files are meant for visualization with another program (matlab, gnuplot...)
*/
......
......@@ -23,7 +23,11 @@
namespace Dumux
{
template <class Scalar, class ComponentT> class GasPhase
/*!
* \brief gaseous phase consisting of a single component
*/
template <class Scalar, class ComponentT>
class GasPhase
{
public:
typedef ComponentT Component;
......
......@@ -23,7 +23,11 @@
namespace Dumux
{
template <class Scalar, class ComponentT> class LiquidPhase
/*!
* \brief liquid phase consisting of a single component
*/
template <class Scalar, class ComponentT>
class LiquidPhase
{
public:
typedef ComponentT Component;
......
......@@ -105,8 +105,8 @@ SET_PROP_DEFAULT(NewtonUseLineSearch)
};
};
//! \cond INTERNAL
/*!
* \internal
* \brief Writes the intermediate solutions during
* the Newton scheme
*/
......@@ -166,7 +166,6 @@ private:
};
/*!
* \internal
* \brief Writes the intermediate solutions during
* the Newton scheme.
*
......@@ -201,6 +200,7 @@ struct NewtonConvergenceWriter<TypeTag, false>
void endTimestep()
{ };
};
//! \endcond
/*!
* \brief A reference implementation of a newton controller specific
......
......@@ -34,6 +34,7 @@
#include <iostream>
#include <boost/format.hpp>
//! \cond INTERNAL
////////////////////////
// helper class for grid instantiation
////////////////////////
......@@ -132,6 +133,7 @@ public:
};
};
//! \endcond
////////////////////////
// the main function
......
......@@ -24,26 +24,31 @@
namespace Dumux
{
template<int dim>
struct ElementLayout
/*!
* \brief calculate errors for a FVCA5 benchmark problem
*/
struct BenchmarkResult
{
private:
template<int dim>
struct ElementLayout
{
bool contains (Dune::GeometryType gt)
{
return gt.dim() == dim;
}
};
};
template<int dim>
struct FaceLayout
{
template<int dim>
struct FaceLayout
{
bool contains (Dune::GeometryType gt)
{
return gt.dim() == dim-1;
}
};
};
struct BenchmarkResult
{
public:
double relativeL2Error;
double ergrad;
double ervell2;
......@@ -308,8 +313,31 @@ struct BenchmarkResult
}
};
/*!
* \brief calculate errors for a FVCA5 benchmark problem
*/
struct ResultEvaluation
{
private:
template<int dim>
struct ElementLayout
{
bool contains (Dune::GeometryType gt)
{
return gt.dim() == dim;
}
};
template<int dim>
struct FaceLayout
{
bool contains (Dune::GeometryType gt)
{
return gt.dim() == dim-1;
}
};
public:
double relativeL2Error;
double ergrad;
double ervell2;
......
......@@ -91,8 +91,10 @@ SET_TYPE_PROP(TestProblemOneP, Problem, Dumux::TestProblemOneP<TTAG(TestProblemO
}
/*!
* \ingroup DecoupledProblems
*/
* \ingroup DecoupledProblems
*
* \brief test problem for the decoupled one-phase model.
*/
template<class TypeTag = TTAG(TestProblemOneP)>
class TestProblemOneP: public DiffusionProblem1P<TypeTag, TestProblemOneP<TypeTag> >
{
......
......@@ -43,6 +43,7 @@
namespace Dumux
{
//! \cond INTERNAL
struct FileNames
{
enum
......@@ -50,6 +51,7 @@ struct FileNames
TPFAName = 0, MPFAName = 1, MimeticName = 2
};
};
//! \endcond
template<class TypeTag>
class TestDiffusionProblem;
......@@ -140,8 +142,10 @@ SET_TYPE_PROP(MimeticPressure2PTestProblem, Problem, Dumux::TestDiffusionProblem
}
/*!
* \ingroup DecoupledProblems
*/
* \ingroup DecoupledProblems
*
* \brief test problem for diffusion models from the FVCA5 benchmark.
*/
template<class TypeTag = TTAG(DiffusionTestProblem)>
class TestDiffusionProblem: public DiffusionProblem2P<TypeTag, TestDiffusionProblem<TypeTag> >
{
......
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