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

[doc][2pnc] Adapt doxygen documentation

parent 74343b71
......@@ -16,9 +16,9 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file
* \ingroup TwoPNCModel
* \brief Defines the indices required for the two-phase n-component
* fully implicit model.
*/
......@@ -29,7 +29,6 @@ namespace Dumux
{
/*!
* \ingroup TwoPNCModel
* \ingroup ImplicitIndices
* \brief Enumerates the formulations which the two-phase n-component model accepts.
*/
struct TwoPNCFormulation
......@@ -42,9 +41,9 @@ struct TwoPNCFormulation
/*!
* \ingroup TwoPNCModel
* \ingroup ImplicitIndices
* \brief The indices for the isothermal two-phase n-component model.
*
* \tparam TypeTag The problem Type Tag
* \tparam PVOffset The first index in a primary variable vector.
*/
template <class TypeTag, int PVOffset = 0>
......@@ -54,12 +53,12 @@ class TwoPNCIndices
public:
// Phase indices
static const int wPhaseIdx = FluidSystem::wPhaseIdx; //!< Index of the wetting phase
static const int nPhaseIdx = FluidSystem::nPhaseIdx; //!< Index of the non-wetting phase
static const int wPhaseIdx = FluidSystem::wPhaseIdx; //!< index of the wetting phase
static const int nPhaseIdx = FluidSystem::nPhaseIdx; //!< index of the non-wetting phase
// Component indices
static const int wCompIdx = FluidSystem::wCompIdx; //!< Index of the primary component of the wetting phase
static const int nCompIdx = FluidSystem::nCompIdx; //!< Index of the primary component of the non-wetting phase
static const int wCompIdx = FluidSystem::wCompIdx; //!< index of the primary component of the wetting phase
static const int nCompIdx = FluidSystem::nCompIdx; //!< index of the primary component of the non-wetting phase
// present phases (-> 'pseudo' primary variable)
static const int wPhaseOnly = 1; //!< Only the non-wetting phase is present
......@@ -67,13 +66,13 @@ public:
static const int bothPhases = 3; //!< Both phases are present
// Primary variable indices
static const int pressureIdx = PVOffset + 0; //!< Index for wetting/non-wetting phase pressure (depending on formulation) in a solution vector
static const int switchIdx = PVOffset + 1; //!< Index of the either the saturation or the mass fraction of the non-wetting/wetting phase
static const int pressureIdx = PVOffset + 0; //!< index for wetting/non-wetting phase pressure (depending on formulation) in a solution vector
static const int switchIdx = PVOffset + 1; //!< index of the either the saturation or the mass fraction of the non-wetting/wetting phase
// equation indices
static const int conti0EqIdx = PVOffset + 0; //!< Reference index for mass conservation equations.
static const int contiWEqIdx = conti0EqIdx + FluidSystem::wCompIdx; //!< Index of the mass conservation equation for the wetting phase major component
static const int contiNEqIdx = conti0EqIdx + FluidSystem::nCompIdx; //!< Index of the mass conservation equation for the non-wetting phase major component
static const int contiWEqIdx = conti0EqIdx + FluidSystem::wCompIdx; //!< index of the mass conservation equation for the wetting phase major component
static const int contiNEqIdx = conti0EqIdx + FluidSystem::nCompIdx; //!< index of the mass conservation equation for the non-wetting phase major component
};
// \}
......
......@@ -18,7 +18,6 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup TwoPNCModel
* \brief Adaption of the fully implicit scheme to the
* two-phase n-component fully implicit model.
......@@ -120,7 +119,7 @@ SET_TYPE_PROP(TwoPNC, PrimaryVariables, SwitchablePrimaryVariables<TypeTag, int>
SET_TYPE_PROP(TwoPNC, PrimaryVariableSwitch, TwoPNCPrimaryVariableSwitch<TypeTag>); //!< The primary variable switch for the 2pnc model
SET_TYPE_PROP(TwoPNC, VolumeVariables, TwoPNCVolumeVariables<TypeTag>); //!< the VolumeVariables property
SET_TYPE_PROP(TwoPNC, Indices, TwoPNCIndices <TypeTag, /*PVOffset=*/0>); //!< The indices required by the isothermal 2pnc model
SET_TYPE_PROP(TwoPNC, SpatialParams, FVSpatialParams<TypeTag>); //!< Use the FVSpatialParams by default
SET_TYPE_PROP(TwoPNC, SpatialParams, FVSpatialParams<TypeTag>); //!< Use the FVSpatialParams by default
SET_TYPE_PROP(TwoPNC, VtkOutputFields, TwoPNCVtkOutputFields<TypeTag>); //!< Set the vtk output fields specific to the TwoPNC model
SET_TYPE_PROP(TwoPNC, LocalResidual, CompositionalLocalResidual<TypeTag>); //!< Use the compositional local residual
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup TwoPNCModel
* \brief The primary variable switch for the 2pnc model
*/
#ifndef DUMUX_2PNC_PRIMARY_VARIABLE_SWITCH_HH
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup TwoPNCModel
* \brief Contains the quantities which are constant within a
* finite volume in the two-phase, n-component model.
*/
......@@ -109,8 +109,14 @@ public:
using FluidState = typename GET_PROP_TYPE(TypeTag, FluidState);
/*!
* \copydoc ImplicitVolumeVariables::update
*/
* \brief Update 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
* \param element An element which contains part of the control volume
* \param scv The sub control volume
*/
void update(const ElementSolutionVector &elemSol,
const Problem &problem,
const Element &element,
......@@ -163,7 +169,15 @@ public:
}
/*!
* \copydoc ImplicitModel::completeFluidState
* \brief Complete the fluid state
*
* \param elemSol A vector containing all primary variables connected to the element
* \param problem The problem
* \param element The element
* \param scv The sub control volume
* \param fluidState The fluid state
*
* Set temperature, saturations, capillary pressures, viscosities, densities and enthalpies.
*/
static void completeFluidState(const ElementSolutionVector& elemSol,
const Problem& problem,
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup TwoPNCModel
* \brief Adds vtk output fields specific to the twop-nc model
*/
#ifndef DUMUX_TWOP_NC_VTK_OUTPUT_FIELDS_HH
......@@ -29,7 +30,7 @@ namespace Dumux
{
/*!
* \ingroup TwoPNC, InputOutput
* \ingroup TwoPNCModel
* \brief Adds vtk output fields specific to the TwoPNC model
*/
template<class 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