Commit df53d24c authored by Sina Ackermann's avatar Sina Ackermann Committed by Simon Emmert

[doxygen] Adapt documentation for 3p, 3p3c, 3pwateroil models

parent 47f93884
......@@ -21,6 +21,7 @@
* \ingroup ThreePModel
* \brief Defines the indices for the three-phase model.
*/
#ifndef DUMUX_3P_INDICES_HH
#define DUMUX_3P_INDICES_HH
......
......@@ -19,8 +19,9 @@
/*!
* \file
* \ingroup ThreePModel
* \brief Adds I/O fields specific to the three-phase model
* \brief Adds I/O fields specific to the three-phase model.
*/
#ifndef DUMUX_THREEP_IO_FIELDS_HH
#define DUMUX_THREEP_IO_FIELDS_HH
......@@ -31,7 +32,7 @@ namespace Dumux {
/*!
* \ingroup ThreePModel
* \brief Adds I/O fields specific to the three-phase model
* \brief Adds I/O fields specific to the three-phase model.
*/
class ThreePIOFields
{
......
......@@ -21,6 +21,7 @@
* \ingroup ThreePModel
* \brief Contains the quantities which are constant within a finite volume in the three-phase model.
*/
#ifndef DUMUX_3P_VOLUME_VARIABLES_HH
#define DUMUX_3P_VOLUME_VARIABLES_HH
......@@ -62,17 +63,17 @@ class ThreePVolumeVariables
};
public:
//! export fluid state type
//! Export fluid state type
using FluidState = typename Traits::FluidState;
//! export fluid system type
//! Export fluid system type
using FluidSystem = typename Traits::FluidSystem;
//! export type of solid state
//! Export type of solid state
using SolidState = typename Traits::SolidState;
//! export type of solid system
//! Export type of solid system
using SolidSystem = typename Traits::SolidSystem;
/*!
* \brief Update all quantities for a given control volume
* \brief Updates all quantities for a given control volume.
*
* \param elemSol A vector containing all primary variables connected to the element
* \param problem The object specifying the problem which ought to
......@@ -114,7 +115,7 @@ public:
}
/*!
* \brief Set complete fluid state
* \brief Sets complete fluid state.
*
* \param elemSol A vector containing all primary variables connected to the element
* \param problem The object specifying the problem which ought to
......
......@@ -21,6 +21,7 @@
* \ingroup ThreePThreeCModel
* \brief Defines the indices required for the three-phase three-component fully implicit model.
*/
#ifndef DUMUX_3P3C_INDICES_HH
#define DUMUX_3P3C_INDICES_HH
......
......@@ -19,8 +19,9 @@
/*!
* \file
* \ingroup ThreePThreeCModel
* \brief Adds I/O fields specific to the three-phase three-component model
* \brief Adds I/O fields specific to the three-phase three-component model.
*/
#ifndef DUMUX_THREEPTHREEC_IO_FIELDS_HH
#define DUMUX_THREEPTHREEC_IO_FIELDS_HH
......@@ -32,7 +33,7 @@ namespace Dumux {
/*!
* \ingroup ThreePThreeCModel
* \brief Adds I/O fields specific to the three-phase three-component model
* \brief Adds I/O fields specific to the three-phase three-component model.
*/
class ThreePThreeCIOFields
{
......
......@@ -22,6 +22,7 @@
* \brief Element-wise calculation of the Jacobian matrix for problems
* using the three-phase three-component fully implicit model.
*/
#ifndef DUMUX_3P3C_LOCAL_RESIDUAL_HH
#define DUMUX_3P3C_LOCAL_RESIDUAL_HH
......@@ -78,7 +79,7 @@ public:
using ParentType::ParentType;
/*!
* \brief Evaluate the amount of all conservation quantities
* \brief Evaluates the amount of all conservation quantities
* (e.g. phase mass) within a sub-control volume.
*
* The result should be averaged over the volume (e.g. phase mass
......
......@@ -19,8 +19,9 @@
/*!
* \file
* \ingroup ThreePThreeCModel
* \brief The primary variable switch for the 3p3c model
* \brief The primary variable switch for the 3p3c model.
*/
#ifndef DUMUX_3P3C_PRIMARY_VARIABLE_SWITCH_HH
#define DUMUX_3P3C_PRIMARY_VARIABLE_SWITCH_HH
......@@ -32,7 +33,7 @@ namespace Dumux {
/*!
* \ingroup ThreePThreeCModel
* \brief The primary variable switch controlling the phase presence state variable
* \brief The primary variable switch controlling the phase presence state variable.
*/
class ThreePThreeCPrimaryVariableSwitch
: public PrimaryVariableSwitch<ThreePThreeCPrimaryVariableSwitch>
......
......@@ -21,6 +21,7 @@
* \ingroup ThreePWaterOilModel
* \brief Defines the indices required for the 3p2cni model.
*/
#ifndef DUMUX_3P2CNI_INDICES_HH
#define DUMUX_3P2CNI_INDICES_HH
......
......@@ -19,8 +19,9 @@
/*!
* \file
* \ingroup ThreePWaterOilModel
* \brief Adds I/O fields specific to the twop model
* \brief Adds I/O fields specific to the three-phase three-component model.
*/
#ifndef DUMUX_3P2CNI_IO_FIELDS_HH
#define DUMUX_3P2CNI_IO_FIELDS_HH
......@@ -31,7 +32,7 @@ namespace Dumux {
/*!
* \ingroup ThreePWaterOilModel
* \brief Adds I/O fields specific to the three-phase three-component model
* \brief Adds I/O fields specific to the three-phase three-component model.
*/
class ThreePWaterOilIOFields
{
......
......@@ -22,6 +22,7 @@
* \brief Element-wise calculation of the Jacobian matrix for problems
* using the three-phase three-component fully implicit model.
*/
#ifndef DUMUX_3P2CNI_LOCAL_RESIDUAL_HH
#define DUMUX_3P2CNI_LOCAL_RESIDUAL_HH
......@@ -71,13 +72,13 @@ protected:
nCompIdx = FluidSystem::nCompIdx,
};
//! property that defines whether mole or mass fractions are used
//! Property that defines whether mole or mass fractions are used
static constexpr bool useMoles = getPropValue<TypeTag, Properties::UseMoles>();
public:
using ParentType::ParentType;
/*!
* \brief Evaluate the amount of all conservation quantities
* \brief Evaluates the amount of all conservation quantities
* (e.g. phase mass) within a sub-control volume.
*
* The result should be averaged over the volume (e.g. phase mass
......
......@@ -19,8 +19,9 @@
/*!
* \file
* \ingroup ThreePWaterOilModel
* \brief The primary variable switch for the 3p3c model
* \brief The primary variable switch for the 3p3c model.
*/
#ifndef DUMUX_3P2CNI_PRIMARY_VARIABLE_SWITCH_HH
#define DUMUX_3P2CNI_PRIMARY_VARIABLE_SWITCH_HH
......@@ -31,7 +32,7 @@ namespace Dumux {
/*!
* \ingroup ThreePWaterOilModel
* \brief The primary variable switch controlling the phase presence state variable
* \brief The primary variable switch controlling the phase presence state variable.
*/
class ThreePWaterOilPrimaryVariableSwitch
: public PrimaryVariableSwitch<ThreePWaterOilPrimaryVariableSwitch>
......
......@@ -22,6 +22,7 @@
* \brief Contains the quantities which are constant within a
* finite volume in the three-phase, two-component model.
*/
#ifndef DUMUX_3P2CNI_VOLUME_VARIABLES_HH
#define DUMUX_3P2CNI_VOLUME_VARIABLES_HH
......@@ -90,20 +91,20 @@ public:
using FluidState = typename Traits::FluidState;
//! The type of the fluid system
using FluidSystem = typename Traits::FluidSystem;
//! export the indices
//! Export the indices
using Indices = typename ModelTraits::Indices;
//! export type of solid state
//! Export type of solid state
using SolidState = typename Traits::SolidState;
//! export type of solid system
//! Export type of solid system
using SolidSystem = typename Traits::SolidSystem;
//! export the primary variable switch
//! Export the primary variable switch
using PrimaryVariableSwitch = ThreePWaterOilPrimaryVariableSwitch;
//! state if only the gas phase is allowed to disappear
//! State if only the gas phase is allowed to disappear
static constexpr bool onlyGasPhaseCanDisappear()
{ return Traits::ModelTraits::onlyGasPhaseCanDisappear(); }
/*!
* \brief Update all quantities for a given control volume
* \brief Updates all quantities for a given control volume.
*
* \param elemSol A vector containing all primary variables connected to the element
* \param problem The object specifying the problem which ought to be simulated
......
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