Commit ca3b1347 authored by Thomas Fetzer's avatar Thomas Fetzer
Browse files

[doxygen]

- added FluidState group, which appears now on the module page
- fixed ingroups


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@15432 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 226fa261
......@@ -74,6 +74,10 @@
* \ingroup Material
* \defgroup Fluidsystems Fluid Systems
*/
/*!
* \ingroup Material
* \defgroup FluidStates Fluid States
*/
/*!
* \ingroup Material
* \defgroup fluidmatrixinteractions Fluid-Matrix Interactions
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Components
*
* \brief A class for the CO2 fluid properties
*/
......@@ -35,6 +36,7 @@
namespace Dumux
{
/*!
* \ingroup Components
* \brief A class for the CO2 fluid properties
*
* Under reservoir conditions, CO2 is typically in supercritical state. These
......
......@@ -36,6 +36,7 @@
namespace Dumux
{
/*!
* \ingroup FluidStates
* \brief Represents all relevant thermodynamic quantities of a
* multi-phase, multi-component fluid system assuming
* thermodynamic equilibrium.
......
......@@ -33,6 +33,7 @@
namespace Dumux
{
/*!
* \ingroup FluidStates
* \brief Represents all relevant thermodynamic quantities of a
* multi-phase fluid system assuming immiscibility and
* thermodynamic equilibrium.
......
......@@ -34,6 +34,7 @@
namespace Dumux
{
/*!
* \ingroup FluidStates
* \brief Represents all relevant thermodynamic quantities of a
* multi-phase fluid system assuming immiscibility and
* thermodynamic equilibrium.
......
......@@ -42,6 +42,7 @@ NEW_PROP_TAG(FluidSystem);
}
/*!
* \ingroup FluidStates
* \brief Represents all relevant thermodynamic quantities of a
* multi-phase, multi-component fluid system
*
......
......@@ -36,6 +36,7 @@
namespace Dumux
{
/*!
* \ingroup FluidStates
* \brief Represents all relevant thermodynamic quantities of a
* multi-phase, multi-component fluid system without using
* any assumptions.
......
......@@ -45,6 +45,7 @@ NEW_PROP_TAG(NumComponents);
}
/*!
* \ingroup FluidStates
* \brief Represents all relevant thermodynamic quantities of a
* multi-phase, multi-component fluid system
*
......
......@@ -33,6 +33,7 @@
namespace Dumux
{
/*!
* \ingroup FluidStates
* \brief This is a fluid state which allows to set the fluid
* pressures and takes all other quantities from an other
* fluid state.
......
......@@ -33,6 +33,7 @@
namespace Dumux
{
/*!
* \ingroup FluidStates
* \brief This is a fluid state which allows to set the fluid
* saturations and takes all other quantities from an other
* fluid state.
......
......@@ -31,6 +31,7 @@
namespace Dumux
{
/*!
* \ingroup FluidStates
* \brief This is a fluid state which allows to set the fluid
* temperatures and takes all other quantities from an other
* fluid state.
......
......@@ -29,6 +29,7 @@
namespace Dumux
{
/*!
* \ingroup Fluidsystems
* \brief Fluid system base class.
*/
template <class Scalar, class Implementation>
......
......@@ -19,7 +19,6 @@
/*!
* \file
*
* \ingroup Fluidsystems
* \brief A fluid system with a liquid and a gaseous phase and \f$H_2O\f$, \f$Air\f$ and \f$S\f$ (dissolved minerals) as components.
*
*/
......
......@@ -44,6 +44,7 @@ namespace Dumux
namespace FluidSystems{
/*!
* \ingroup Fluidsystems
* \brief A compositional fluid with brine and carbon as
* components in both, the liquid and the gas (supercritical) phase.
*
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Fluidsystems
*
* \brief Provides defaults for the members of a fluidsystem.
*/
......
......@@ -28,6 +28,7 @@ namespace Dumux
{
/*!
* \ingroup Fluidsystems
* \brief gaseous phase consisting of a single component
*/
template <class Scalar, class ComponentT>
......
......@@ -20,7 +20,6 @@
/*!
* \file
*
* \ingroup Fluidsystems
* \brief A fluid system with a liquid and a gaseous phase and \f$H_2O\f$ and \f$Air\f$
* as components.
*/
......
......@@ -45,6 +45,7 @@ namespace FluidSystems
{
/*!
* \ingroup Fluidsystems
* \brief A compositional fluid with water and molecular nitrogen as
* components in both, the liquid and the gas phase.
*/
......
......@@ -43,6 +43,7 @@ namespace FluidSystems
{
/*!
* \ingroup Fluidsystems
* \brief A compositional fluid with water and molecular nitrogen as
* components in both, the liquid and the gas phase.
*/
......
......@@ -42,6 +42,7 @@ namespace Dumux
namespace FluidSystems
{
/*!
* \ingroup Fluidsystems
* \brief A twophase fluid system with water and nitrogen as components.
*/
template <class Scalar, bool useComplexRelations = true>
......
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