Commit a24f9e99 authored by Bernd Flemisch's avatar Bernd Flemisch
Browse files

implicit/common: generalize box-specific comments.

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@10651 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 2cdd16cc
......@@ -77,7 +77,7 @@ public:
*
* \param problem The problem
* \param element The finite element
* \param fvGeometry The finite-volume geometry in the box scheme
* \param fvGeometry The finite-volume geometry
* \param faceIdx The local index of the SCV (sub-control-volume) face
* \param elemVolVars The volume variables of the current element
* \param onBoundary A boolean variable to specify whether the flux variables
......
......@@ -98,7 +98,7 @@ public:
*
* \param problem The problem
* \param element The finite element
* \param fvGeometry The finite-volume geometry in the box scheme
* \param fvGeometry The finite-volume geometry
* \param faceIdx The local index of the SCV (sub-control-volume) face
* \param elemVolVars The volume variables of the current element
* \param onBoundary A boolean variable to specify whether the flux variables
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \brief Caculates the Jacobian of the local residual for box models
* \brief Caculates the Jacobian of the local residual for fully-implicit models
*/
#ifndef DUMUX_IMPLICIT_LOCAL_JACOBIAN_HH
#define DUMUX_IMPLICIT_LOCAL_JACOBIAN_HH
......@@ -33,7 +33,7 @@ namespace Dumux
{
/*!
* \ingroup ImplicitLocalJacobian
* \brief Calculates the Jacobian of the local residual for box models
* \brief Calculates the Jacobian of the local residual for fully-implicit models
*
* The default behavior is to use numeric differentiation, i.e.
* forward or backward differences (2nd order), or central
......@@ -231,38 +231,38 @@ public:
{ return localResidual_; }
/*!
* \brief Returns the Jacobian of the equations at vertex i to the
* primary variables at vertex j.
* \brief Returns the Jacobian of the equations at subcontrolvolume i
* to the primary variables at subcontrolvolume j.
*
* \param i The local vertex (or sub-control volume) index on which
* \param i The local subcontrolvolume index on which
* the equations are defined
* \param j The local vertex (or sub-control volume) index which holds
* \param j The local subcontrolvolume index which holds
* primary variables
*/
const MatrixBlock &mat(const int i, const int j) const
{ return A_[i][j]; }
/*!
* \brief Returns the Jacobian of the storage term at vertex i.
* \brief Returns the Jacobian of the storage term at subcontrolvolume i.
*
* \param i The local vertex (or sub-control volume) index
* \param i The local subcontrolvolume index
*/
const MatrixBlock &storageJacobian(const int i) const
{ return storageJacobian_[i]; }
/*!
* \brief Returns the residual of the equations at vertex i.
* \brief Returns the residual of the equations at subcontrolvolume i.
*
* \param i The local vertex (or sub-control volume) index on which
* \param i The local subcontrolvolume index on which
* the equations are defined
*/
const PrimaryVariables &residual(const int i) const
{ return residual_[i]; }
/*!
* \brief Returns the storage term for vertex i.
* \brief Returns the storage term for subcontrolvolume i.
*
* \param i The local vertex (or sub-control volume) index on which
* \param i The local subcontrolvolume index on which
* the equations are defined
*/
const PrimaryVariables &storageTerm(const int i) const
......@@ -272,7 +272,7 @@ public:
* \brief Returns the epsilon value which is added and removed
* from the current solution.
*
* \param scvIdx The local index of the element's vertex for
* \param scvIdx The local index of the element's subcontrolvolume for
* which the local derivative ought to be calculated.
* \param pvIdx The index of the primary variable which gets varied
*/
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \brief Calculates the residual of models based on the box scheme element-wise.
* \brief Calculates the element-wise residual of fully-implicit models.
*/
#ifndef DUMUX_IMPLICIT_LOCAL_RESIDUAL_HH
#define DUMUX_IMPLICIT_LOCAL_RESIDUAL_HH
......@@ -268,7 +268,6 @@ public:
* volume of the element.
*
* \param scvIdx The local index of the sub-control volume
* (i.e. the element's local vertex index)
*/
const PrimaryVariables &residual(const int scvIdx) const
{ return residual_[scvIdx]; }
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \brief Base class for models using box discretization
* \brief Base class for fully-implicit models
*/
#ifndef DUMUX_IMPLICIT_MODEL_HH
#define DUMUX_IMPLICIT_MODEL_HH
......
......@@ -91,7 +91,7 @@ public:
/*!
* \brief Returns the temperature \f$\mathrm{[K]}\f$ within a control volume.
*
* This is the discretization specific interface for the box
* This is the discretization specific interface for the fully-implicit
* method. By default it just calls temperature(pos).
*
* \param element The DUNE Codim<0> enitiy which intersects with
......@@ -133,8 +133,8 @@ public:
/*!
* \brief Returns the acceleration due to gravity \f$\mathrm{[m/s^2]}\f$.
*
* This is the box discretization specific interface. By default
* it just calls gravityAtPos().
* This is the discretization specific interface for the fully-implicit method.
* By default it just calls gravityAtPos().
*/
const DimVector &boxGravity(const Element &element,
const FVElementGeometry &fvGeometry,
......
......@@ -253,14 +253,14 @@ public:
* boundary segment.
*
* This is the method for the case where the Neumann condition is
* potentially solution dependent and requires some box method
* specific things.
* potentially solution dependent and requires some quantities that
* are specific to the fully-implicit method.
*
* \param values The neumann values for the conservation equations in units of \f$ [ \textnormal{unit of conserved quantity} / (m^2 \cdot s )] \f$
* \param element The finite element
* \param fvGeometry The finite-volume geometry in the box scheme
* \param fvGeometry The finite-volume geometry
* \param is The intersection between element and boundary
* \param scvIdx The local vertex index
* \param scvIdx The local subcontrolvolume index
* \param boundaryFaceIdx The index of the boundary face
* \param elemVolVars All volume variables for the element
*
......@@ -290,9 +290,9 @@ public:
*
* \param values The neumann values for the conservation equations in units of \f$ [ \textnormal{unit of conserved quantity} / (m^2 \cdot s )] \f$
* \param element The finite element
* \param fvGeometry The finite-volume geometry in the box scheme
* \param fvGeometry The finite-volume geometry
* \param is The intersection between element and boundary
* \param scvIdx The local vertex index
* \param scvIdx The local subcontrolvolume index
* \param boundaryFaceIdx The index of the boundary face
*
* For this method, the \a values parameter stores the mass flux
......@@ -335,13 +335,13 @@ public:
* sub-control-volume.
*
* This is the method for the case where the source term is
* potentially solution dependent and requires some box method
* specific things.
* potentially solution dependent and requires some quantities that
* are specific to the fully-implicit method.
*
* \param values The source and sink values for the conservation equations in units of \f$ [ \textnormal{unit of conserved quantity} / (m^3 \cdot s )] \f$
* \param element The finite element
* \param fvGeometry The finite-volume geometry in the box scheme
* \param scvIdx The local vertex index
* \param fvGeometry The finite-volume geometry
* \param scvIdx The local subcontrolvolume index
* \param elemVolVars All volume variables for the element
*
* For this method, the \a values parameter stores the rate mass
......@@ -354,7 +354,7 @@ public:
const int scvIdx,
const ElementVolumeVariables &elemVolVars) const
{
// forward to solution independent, box specific interface
// forward to solution independent, fully-implicit specific interface
asImp_().source(values, element, fvGeometry, scvIdx);
}
......@@ -364,8 +364,8 @@ public:
*
* \param values The source and sink values for the conservation equations in units of \f$ [ \textnormal{unit of conserved quantity} / (m^3 \cdot s )] \f$
* \param element The finite element
* \param fvGeometry The finite-volume geometry in the box scheme
* \param scvIdx The local vertex index
* \param fvGeometry The finite-volume geometry
* \param scvIdx The local subcontrolvolume index
*
* For this method, the \a values parameter stores the rate mass
* generated or annihilate per volume unit. Positive values mean
......@@ -406,8 +406,8 @@ public:
*
* \param values The initial values for the primary variables
* \param element The finite element
* \param fvGeometry The finite-volume geometry in the box scheme
* \param scvIdx The local vertex index
* \param fvGeometry The finite-volume geometry
* \param scvIdx The local subcontrolvolume index
*
* For this method, the \a values parameter stores primary
* variables.
......
......@@ -43,7 +43,7 @@ namespace Properties
// Type tags
//////////////////////////////////////////////////////////////////
//! The type tag for models based on the box-scheme
//! The type tag for fully-implicit models
NEW_TYPE_TAG(ImplicitBase, INHERITS_FROM(NewtonMethod, LinearSolverTypeTag, ImplicitModel));
//////////////////////////////////////////////////////////////////
......@@ -53,7 +53,7 @@ NEW_TYPE_TAG(ImplicitBase, INHERITS_FROM(NewtonMethod, LinearSolverTypeTag, Impl
NEW_PROP_TAG(Grid); //!< The type of the DUNE grid
NEW_PROP_TAG(GridView); //!< The type of the grid view
NEW_PROP_TAG(FVElementGeometry); //! The type of the finite-volume geometry in the box scheme
NEW_PROP_TAG(FVElementGeometry); //! The type of the finite-volume geometry
NEW_PROP_TAG(Problem); //!< The type of the problem
NEW_PROP_TAG(BaseModel); //!< The type of the base class of the model
......
......@@ -58,10 +58,10 @@ SET_TYPE_PROP(ImplicitBase,
GridView,
typename GET_PROP_TYPE(TypeTag, Grid)::LeafGridView);
//! use the plain newton method for the box scheme by default
//! use the plain newton method by default
SET_TYPE_PROP(ImplicitBase, NewtonMethod, Dumux::NewtonMethod<TypeTag>);
//! use the plain newton controller for the box scheme by default
//! use the plain newton controller by default
SET_TYPE_PROP(ImplicitBase, NewtonController, Dumux::NewtonController<TypeTag>);
//! Mapper for the grid view's vertices.
......@@ -82,7 +82,7 @@ SET_TYPE_PROP(ImplicitBase, BaseModel, Dumux::ImplicitModel<TypeTag>);
//! The volume variable class, to be overloaded by the model
SET_TYPE_PROP(ImplicitBase, VolumeVariables, Dumux::ImplicitVolumeVariables<TypeTag>);
//! The local jacobian operator for the box scheme
//! The local jacobian operator
SET_TYPE_PROP(ImplicitBase, LocalJacobian, Dumux::ImplicitLocalJacobian<TypeTag>);
//! The type of a solution for the whole grid at a fixed time
......
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