Commit 0926c2b1 authored by Klaus Mosthaf's avatar Klaus Mosthaf
Browse files

work on the stokes2cni docu


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@7846 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent f3543516
......@@ -70,6 +70,10 @@ public:
*
* The result should be averaged over the volume (e.g. phase mass
* inside a sub control volume divided by the volume)
*
* \param result The mass of the component within the sub-control volume
* \param scvIdx The SCV (sub-control-volume) index
* \param usePrevSol Evaluate function with solution of current or previous time step
*/
void computeStorage(PrimaryVariables &result, int scvIdx, bool usePrevSol) const
{
......
......@@ -77,9 +77,15 @@ public:
calculateValues_(problem, element, elemVolVars);
}
/*!
* \brief Returns the heat conductivity at the integration point.
*/
Scalar heatConductivityAtIP() const
{ return heatConductivityAtIP_; }
/*!
* \brief Returns the temperature gradient at the integration point.
*/
const ScalarGradient &temperatureGradAtIP() const
{ return temperatureGradAtIP_; }
......
......@@ -38,7 +38,7 @@ namespace Dumux
/*!
* \ingroup BoxStokes2cniModel
* \ingroup BoxIndices
* \brief Enumerations for the non-isothermal compositional stokes model
* \brief Enumerations for the non-isothermal compositional Stokes model
*/
template <class TypeTag, int PVOffset=0>
struct Stokes2cniCommonIndices : public Stokes2cCommonIndices<TypeTag, PVOffset>
......
......@@ -41,8 +41,12 @@ namespace Dumux
* \ingroup BoxStokes2cniModel
* \ingroup BoxLocalResidual
* \brief Element-wise calculation of the Jacobian matrix for problems
* using the non-isothermal compositional Stokes box model. This is derived
* from the stokes2c box model and adds the energy balance equation.
* using the non-isothermal compositional Stokes box model. This class is derived
* from the stokes2c box local residual and adds the energy balance equation.
*
* \param result The mass of the component within the sub-control volume
* \param scvIdx The SCV (sub-control-volume) index
* \param usePrevSol Evaluate function with solution of current or previous time step
*/
template<class TypeTag>
class Stokes2cniLocalResidual : public Stokes2cLocalResidual<TypeTag>
......@@ -91,11 +95,11 @@ public:
/*!
* \brief Evaluates the convective energy flux
* over a face of a sub-control volume and writes the result in
* the flux vector. This method is called by computeFlux in the base class.
* over a face of a sub-control volume and writes the result in
* the flux vector. This method is called by computeFlux in the base class.
*
* \param flux The vector for the fluxes over the SCV face
* \param fluxVars The flux variables at the current SCV face
* \param flux The vector for the fluxes over the SCV/boundary face
* \param fluxVars The flux variables at the current SCV/boundary face
*/
void computeAdvectiveFlux(PrimaryVariables &flux,
const FluxVariables &fluxVars) const
......
......@@ -98,11 +98,7 @@ class Stokes2cniModel : public Stokes2cModel<TypeTag>
typedef typename GET_PROP_TYPE(TypeTag, VolumeVariables) VolumeVariables;
public:
/*!
* \brief Append all quantities of interest which can be derived
* from the solution of the current time step to the VTK
* writer.
*/
//! \@copydoc BoxModel::addOutputVtkFields
template <class MultiWriter>
void addOutputVtkFields(const SolutionVector &sol, MultiWriter &writer)
{
......
......@@ -26,7 +26,7 @@
*
* \file
*
* \brief Defines the properties required for the non-isothermal compositional
* \brief Defines the additional properties required for the non-isothermal compositional
* Stokes box model.
*/
#ifndef DUMUX_STOKES2CNI_PROPERTIES_HH
......@@ -42,7 +42,7 @@ namespace Properties
// Type tags
//////////////////////////////////////////////////////////////////
//! The type tag for the compositional stokes problems
//! The type tag for the non-isothermal compositional Stokes problems
NEW_TYPE_TAG(BoxStokes2cni, INHERITS_FROM(BoxStokes2c));
//////////////////////////////////////////////////////////////////
......
......@@ -27,7 +27,7 @@
* \file
*
* \brief Sets default properties for the non-isothermal compositional
* Stokes box model.
* Stokes box model.
*/
#ifndef DUMUX_STOKES2CNI_PROPERTY_DEFAULTS_HH
#define DUMUX_STOKES2CNI_PROPERTY_DEFAULTS_HH
......@@ -61,7 +61,7 @@ SET_TYPE_PROP(BoxStokes2cni,
LocalResidual,
Stokes2cniLocalResidual<TypeTag>);
//! the model property
//! the Model property
SET_TYPE_PROP(BoxStokes2cni, Model, Stokes2cniModel<TypeTag>);
//! the VolumeVariables property
......
......@@ -63,7 +63,7 @@ class Stokes2cniVolumeVariables : public Stokes2cVolumeVariables<TypeTag>
public:
/*!
* \brief Update all additional quantities for a given control volume.
* \@copydoc BoxModel::update
*/
void update(const PrimaryVariables &primaryVars,
const Problem &problem,
......@@ -86,21 +86,21 @@ public:
};
/*!
* \brief Returns the total internal energy of a phase in the
* \brief Returns the total internal energy of the fluid phase in the
* sub-control volume.
*/
Scalar internalEnergy() const
{ return this->fluidState_.internalEnergy(phaseIdx); };
/*!
* \brief Returns the total enthalpy of a phase in the sub-control
* \brief Returns the total enthalpy of the fluid phase in the sub-control
* volume.
*/
Scalar enthalpy() const
{ return this->fluidState_.enthalpy(phaseIdx); };
/*!
* \brief Returns the total heat capacity \f$\mathrm{[J/(K*m^3]}\f$ of the rock matrix in
* \brief Returns the heat conductivity of the fluid phase in
* the sub-control volume.
*/
Scalar heatConductivity() const
......
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