Commit 689919e1 authored by Sina Ackermann's avatar Sina Ackermann Committed by Simon Scholz
Browse files

[doxygen] Add/modify documentation

parent 408f5140
...@@ -55,12 +55,10 @@ public: ...@@ -55,12 +55,10 @@ public:
int wettingPhase() const int wettingPhase() const
{ return phase0Idx; } { return phase0Idx; }
/*! /*****************************************************
* \name access functions * Generic access to fluid properties (No assumptions
* \todo doc me! * on thermodynamic equilibrium required)
*/ *****************************************************/
//@{
/*! /*!
* \brief Returns the saturation \f$S_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$. * \brief Returns the saturation \f$S_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
* *
...@@ -197,10 +195,11 @@ public: ...@@ -197,10 +195,11 @@ public:
return phaseMassFraction(phaseIdx); return phaseMassFraction(phaseIdx);
} }
/*! /*****************************************************
* \name Functions to set Data * Setter methods. Note that these are not part of the
*/ * generic FluidState interface but specific for each
//@{ * implementation...
*****************************************************/
/*! /*!
* \brief Sets the viscosity of a phase \f$\mathrm{[Pa*s]}\f$. * \brief Sets the viscosity of a phase \f$\mathrm{[Pa*s]}\f$.
* \param phaseIdx the index of the phase * \param phaseIdx the index of the phase
......
...@@ -20,6 +20,7 @@ ...@@ -20,6 +20,7 @@
* \file * \file
* *
* \brief Test for the instationary staggered grid Navier-Stokes model with analytical solution (Angeli et al., 2017) * \brief Test for the instationary staggered grid Navier-Stokes model with analytical solution (Angeli et al., 2017)
* The unsteady, 2D, incompressible Navier-Stokes equations for a zero source and a Newtonian flow is solved and compared to an analytical solution (sums/products of trigonometric functions). The velocities and pressures decay exponentially. The Dirichlet boundary conditions are time-dependent and consistent with the analytical solution.
*/ */
#include <config.h> #include <config.h>
......
...@@ -33,7 +33,10 @@ namespace Dumux { ...@@ -33,7 +33,10 @@ namespace Dumux {
/*! /*!
* \ingroup OnePTests * \ingroup OnePTests
* \brief Multidomain test problem for the incompressible one-phase model * \brief Multidomain test problem for the incompressible one-phase model
* \todo doc me! *
* Two possibilities to divide the model domain are given:
* half: a horizontal interface splits the domain in two equally sized subdomains
* lens: one subdomain is defined as a central lens, surrounded by the other subdomain
*/ */
template<class TypeTag, std::size_t tag> template<class TypeTag, std::size_t tag>
class OnePTestProblem class OnePTestProblem
......
...@@ -30,7 +30,6 @@ namespace FluidSystems { ...@@ -30,7 +30,6 @@ namespace FluidSystems {
/*! /*!
* \ingroup FluidSystems * \ingroup FluidSystems
* \brief A simple fluid system with one MaxwellStefan component. * \brief A simple fluid system with one MaxwellStefan component.
* \todo doc me!
*/ */
template<class Scalar> template<class Scalar>
class H2N2CO2FluidSystem: public Base<Scalar, H2N2CO2FluidSystem<Scalar>> class H2N2CO2FluidSystem: public Base<Scalar, H2N2CO2FluidSystem<Scalar>>
......
...@@ -94,8 +94,8 @@ struct EnableFVGridGeometryCache<TypeTag, TTag::OnePCompressible> { static const ...@@ -94,8 +94,8 @@ struct EnableFVGridGeometryCache<TypeTag, TTag::OnePCompressible> { static const
/*! /*!
* \ingroup OnePTests * \ingroup OnePTests
* \brief Test problem for the compressible one-phase model: * \brief Test problem for the compressible one-phase model:
*\todo doc me! *
* <tt>./test_box1pfv</tt> or * Can be run as <tt>./test_box1pfv</tt> or
* <tt>./test_cc1pfv</tt> * <tt>./test_cc1pfv</tt>
*/ */
template<class TypeTag> template<class TypeTag>
......
...@@ -94,8 +94,8 @@ struct EnableFVGridGeometryCache<TypeTag, TTag::OnePCompressible> { static const ...@@ -94,8 +94,8 @@ struct EnableFVGridGeometryCache<TypeTag, TTag::OnePCompressible> { static const
/*! /*!
* \ingroup OnePTests * \ingroup OnePTests
* \brief Test problem for the compressible one-phase model: * \brief Test problem for the compressible one-phase model:
*\todo doc me! *
* <tt>./test_box1pfv</tt> or * Can be run as <tt>./test_box1pfv</tt> or
* <tt>./test_cc1pfv</tt> * <tt>./test_cc1pfv</tt>
*/ */
template<class TypeTag> template<class TypeTag>
......
...@@ -112,8 +112,8 @@ struct Scalar<TypeTag, TTag::OnePIncompressibleTpfaQuad> { using type = Quad; }; ...@@ -112,8 +112,8 @@ struct Scalar<TypeTag, TTag::OnePIncompressibleTpfaQuad> { using type = Quad; };
/*! /*!
* \ingroup OnePTests * \ingroup OnePTests
* \brief Test problem for the incompressible one-phase model: * \brief Test problem for the incompressible one-phase model:
*\todo doc me! *
* <tt>./test_box1pfv</tt> or * Can be run as <tt>./test_box1pfv</tt> or
* <tt>./test_cc1pfv</tt> * <tt>./test_cc1pfv</tt>
*/ */
template<class TypeTag> template<class TypeTag>
......
...@@ -99,8 +99,8 @@ struct EnableFVGridGeometryCache<TypeTag, TTag::OnePIncompressible> { static con ...@@ -99,8 +99,8 @@ struct EnableFVGridGeometryCache<TypeTag, TTag::OnePIncompressible> { static con
/*! /*!
* \ingroup OnePTests * \ingroup OnePTests
* \brief Test problem for the incompressible one-phase model: * \brief Test problem for the incompressible one-phase model:
*\todo doc me! *
* <tt>./test_box1pfv</tt> or * Can be run as <tt>./test_box1pfv</tt> or
* <tt>./test_cc1pfv</tt> * <tt>./test_cc1pfv</tt>
*/ */
template<class TypeTag> template<class TypeTag>
......
...@@ -56,7 +56,7 @@ public: ...@@ -56,7 +56,7 @@ public:
/*! /*!
* \ingroup SequentialTwoPTests * \ingroup SequentialTwoPTests
* \brief Test problem for the sequential 2p models \todo Please doc me! * \brief Test problem for the sequential 2p models
*/ */
template<class TypeTag> template<class TypeTag>
class Test2PSpatialParams: public SequentialFVSpatialParams<TypeTag> class Test2PSpatialParams: public SequentialFVSpatialParams<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