Commit 3a0a8da2 authored by Beatrix Becker's avatar Beatrix Becker
Browse files

[docu][1p 1pnc] add ingroup and cleanup for next

parent 8826dd24
......@@ -31,6 +31,11 @@
namespace Dumux
{
/*!
* \ingroup OnePModel
* \brief Element-wise calculation of the residual and its derivatives
* for a single-phase, incompressible, test problem.
*/
template<class TypeTag>
class OnePIncompressibleLocalResidual : public ImmiscibleLocalResidual<TypeTag>
{
......@@ -223,6 +228,7 @@ public:
}
}
//! Robin-type flux derivatives
template<class PartialDerivativeMatrices>
void addRobinFluxDerivatives(PartialDerivativeMatrices& derivativeMatrices,
const Problem& problem,
......
......@@ -34,8 +34,8 @@ namespace Dumux
*/
struct OnePIndices
{
static const int conti0EqIdx = 0; //index for the mass balance
static const int pressureIdx = 0; //index of the primary variable
static const int conti0EqIdx = 0; //!< index for the mass balance
static const int pressureIdx = 0; //!< index of the primary variable
};
// \}
......
......@@ -58,7 +58,13 @@ 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,
......@@ -74,7 +80,14 @@ public:
};
/*!
* \copydoc ImplicitModel::completeFluidState
* \brief Set 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
* be simulated
* \param element An element which contains part of the control volume
* \param scv The sub-control volume
* \param fluidState A container with the current (physical) state of the fluid
*/
static void completeFluidState(const ElementSolutionVector &elemSol,
const Problem& problem,
......
......@@ -28,7 +28,7 @@ namespace Dumux
{
/*!
* \ingroup OnePModel, InputOutput
* \ingroup OnePModel
* \brief Adds vtk output fields specific to the one phase model
*/
template<class TypeTag>
......
......@@ -19,6 +19,7 @@
/*!
* \file
* \ingroup OnePNCModel
* \brief Defines the primary variable and equation indices used by
* the 1pnc model
*/
......@@ -31,7 +32,6 @@ namespace Dumux
{
/*!
* \ingroup OnePNCModel
* \ingroup ImplicitIndices
* \brief The indices for the isothermal one-phase n-component model.
*
* \tparam PVOffset The first index in a primary variable vector.
......
......@@ -17,20 +17,10 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file
*
* \brief Base class for all models which use the single-phase, n-component fully implicit model.
* Adaption of the fully implicit model to the one-phase n-component flow model.
*/
#ifndef DUMUX_1PNC_MODEL_HH
#define DUMUX_1PNC_MODEL_HH
/*!
* \file
* \ingroup OnePNCModel
* \brief Adaption of the fully implicit scheme to the
* one-phase n-component flow model.
* \brief Base class for all models which use the single-phase, n-component fully implicit model.
* Adaption of the fully implicit model to the one-phase n-component flow model.
*
* This model implements a one-phase flow of a compressible fluid, that consists
* of n components, using a standard Darcy approach as the equation for the
......@@ -65,6 +55,9 @@
* The primary variables are the pressure \f$p\f$ and the mole fraction of dissolved components \f$x^\kappa\f$.
*/
#ifndef DUMUX_1PNC_MODEL_HH
#define DUMUX_1PNC_MODEL_HH
#include <dumux/common/properties.hh>
#include <dumux/material/fluidmatrixinteractions/1p/thermalconductivityaverage.hh>
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePNCModel
* \brief Quantities required by the single-phase, n-component box
* model defined on a vertex.
*/
......@@ -90,8 +90,13 @@ public:
using FluidState = typename GET_PROP_TYPE(TypeTag, FluidState);
/*!
* \copydoc ImplicitVolumeVariables::update
* \param priVars The primary Variables
* \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,
......@@ -128,11 +133,16 @@ public:
}
/*!
* \copydoc ImplicitModel::completeFluidState
* \param isOldSol Specifies whether this is the previous solution or the current one
* \param priVars The primary Variables
*/
/*!
* \brief Set 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
* be simulated
* \param element An element which contains part of the control volume
* \param scv The sub-control volume
* \param fluidState A container with the current (physical) state of the fluid
*/
static void completeFluidState(const ElementSolutionVector &elemSol,
const Problem& problem,
const Element& element,
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup OnePNCModel
* \brief Adds vtk output fields specific to the OnePNC model
*/
#ifndef DUMUX_ONEPNC_VTK_OUTPUT_FIELDS_HH
......@@ -27,7 +28,7 @@ namespace Dumux
{
/*!
* \ingroup OnePNC, InputOutput
* \ingroup OnePNCModel
* \brief Adds vtk output fields specific to the OnePNC 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