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

[doxygen] Adapt documentation for nonequilibrium, nonisothermal models

parent 7784c756
......@@ -18,9 +18,10 @@
*****************************************************************************/
/*!
* \file
* \ingroup PorousmediumNonEquilibriumModel
* \brief Class storing scv and scvf variables
* \ingroup NonEquilibriumModel
* \brief Class storing scv and scvf variables.
*/
#ifndef DUMUX_NONEQUILIBRIUM_GRID_VARIABLES_HH
#define DUMUX_NONEQUILIBRIUM_GRID_VARIABLES_HH
......@@ -34,8 +35,9 @@
namespace Dumux {
/*!
* \ingroup PorousmediumNonEquilibriumModel
* \brief This class stores the velocities which are used to compute reynoldsnumbers for the source terms of nonequilibrium models
* \ingroup NonEquilibriumModel
* \brief This class stores the velocities which are used to compute Reynolds
* numbers for the source terms of non-equilibrium models.
*/
template<class TypeTag>
class NonEquilibriumGridVariables
......@@ -58,7 +60,7 @@ class NonEquilibriumGridVariables
static constexpr bool isBox = FVGridGeometry::discMethod == DiscretizationMethod::box;
public:
//! export the type used for scalar values
//! Export the type used for scalar values
using typename ParentType::Scalar;
//! Constructor
......@@ -121,7 +123,6 @@ public:
*
* \param phaseIdx The index of the fluid phase
* \param dofIdxGlobal The global index of the degree of freedom
*
*/
const Scalar volumeDarcyMagVelocity(const unsigned int phaseIdx,
const unsigned int dofIdxGlobal) const
......
......@@ -18,16 +18,17 @@
*****************************************************************************/
/*!
* \file
* \ingroup PorousmediumNonEquilibriumModel
* \ingroup NonEquilibriumModel
* \brief The primary variable and equation indices for the MpNc model.
*/
#ifndef DUMUX_NONEQUILIBRIUM_INDICES_HH
#define DUMUX_NONEQUILIBRIUM_INDICES_HH
namespace Dumux {
/*!
* \ingroup PorousmediumNonEquilibriumModel
* \ingroup NonEquilibriumModel
* \brief The primary variable and equation indices for the MpNc model.
*/
template <class EquilibriumIndices, int numEnergyEqFluid, int numEnergyEqSolid, int numEq>
......
......@@ -18,9 +18,10 @@
*****************************************************************************/
/*!
* \file
* \ingroup PorousmediumNonEquilibriumModel
* \ingroup NonEquilibriumModel
* \brief Adds I/O fields specific to non-isothermal models
*/
#ifndef DUMUX_NONEQUILBRIUM_OUTPUT_FIELDS_HH
#define DUMUX_NONEQUILBRIUM_OUTPUT_FIELDS_HH
......@@ -30,7 +31,7 @@
namespace Dumux {
/*!
* \ingroup PorousmediumNonEquilibriumModel
* \ingroup NonEquilibriumModel
* \brief Adds I/O fields specific to non-isothermal models
*/
template<class ModelTraits, class EquilibriumIOFields>
......
......@@ -18,10 +18,11 @@
*****************************************************************************/
/*!
* \file
* \ingroup PorousmediumNonEquilibriumModel
* \ingroup NonEquilibriumModel
* \brief The local residual for the kinetic mass transfer module of
* the compositional multi-phase model.
*/
#ifndef DUMUX_NONEQUILIBRIUM_LOCAL_RESIDUAL_HH
#define DUMUX_NONEQUILIBRIUM_LOCAL_RESIDUAL_HH
......@@ -38,7 +39,7 @@ template <class TypeTag>
using NonEquilibriumLocalResidual = NonEquilibriumLocalResidualImplementation<TypeTag, GetPropType<TypeTag, Properties::ModelTraits>::enableThermalNonEquilibrium(), GetPropType<TypeTag, Properties::ModelTraits>::enableChemicalNonEquilibrium()>;
/*!
* \ingroup PorousmediumNonEquilibriumModel
* \ingroup NonEquilibriumModel
* \brief The mass conservation part of the nonequilibrium model for a model without chemical non-equilibrium
*/
template<class TypeTag>
......@@ -67,7 +68,7 @@ public:
using ParentType::ParentType;
/*!
* \brief Calculate the source term of the equation
* \brief Calculates the source term of the equation.
*
* \param problem The object specifying the problem which ought to be simulated
* \param element An element which contains part of the control volume
......@@ -156,7 +157,8 @@ public:
/*!
* \brief The mass conservation part of the nonequilibrium model for a model assuming chemical non-equilibrium and two phases */
* \brief The mass conservation part of the nonequilibrium model for a model assuming chemical non-equilibrium and two phases
*/
template<class TypeTag>
class NonEquilibriumLocalResidualImplementation<TypeTag, true, true>: public GetPropType<TypeTag, Properties::EquilibriumLocalResidual>
{
......@@ -195,7 +197,7 @@ class NonEquilibriumLocalResidualImplementation<TypeTag, true, true>: public Get
public:
using ParentType::ParentType;
/*!
* \brief Calculate the storage for all mass balance equations
* \brief Calculates the storage for all mass balance equations.
*
* \param problem The object specifying the problem which ought to be simulated
* \param scv The sub-control volume
......@@ -227,7 +229,7 @@ public:
}
/*!
* \brief Calculate the storage for all mass balance equations
* \brief Calculates the flux for all mass balance equations.
*
* \param problem The object specifying the problem which ought to be simulated
* \param element An element which contains part of the control volume
......@@ -278,7 +280,7 @@ public:
}
/*!
* \brief Calculate the source term of the equation
* \brief Calculates the source term of the equation.
*
* \param problem The source term
* \param element An element which contains part of the control volume
......
......@@ -16,12 +16,12 @@
* 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 PorousmediumNonEquilibriumModel
* \ingroup NonEquilibriumModel
* \brief This specifies models which are able to capture non-equilibrium mass and / or energy transfer.
*/
#ifndef DUMUX_NONEQUILIBRIUM_MODEL_HH
#define DUMUX_NONEQUILIBRIUM_MODEL_HH
......@@ -39,15 +39,10 @@
#include "gridvariables.hh"
#include "iofields.hh"
/*!
* \ingroup PorousmediumNonEquilibriumModel
* \brief Defines the properties required for non-equilibrium models
*/
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup PorousmediumNonEquilibriumModel
* \ingroup NonEquilibriumModel
* \brief Specifies a number properties of porous-medium flow non-equilibrium models.
*
* \tparam ET The model traits of the underlying model assuming equilibrium
......
......@@ -18,10 +18,12 @@
*****************************************************************************/
/*!
* \file
* \ingroup PorousmediumNonEquilibriumModel
* \ingroup NonEquilibriumModel
* \brief A MpNc specific newton solver.
* This solver calls the velocity averaging in the model after each iteration.
*
* This solver calls the velocity averaging in the model after each iteration.
*/
#ifndef DUMUX_NONEQUILIBRIUM_NEWTON_SOLVER_HH
#define DUMUX_NONEQUILIBRIUM_NEWTON_SOLVER_HH
......@@ -29,8 +31,9 @@
namespace Dumux {
/*!
* \ingroup PorousmediumNonEquilibriumModel
* \ingroup NonEquilibriumModel
* \brief A nonequilibrium specific newton solver.
*
* This solver calls the velocity averaging in the problem after each iteration.
*/
template <class Assembler, class LinearSolver>
......
......@@ -17,10 +17,11 @@
*****************************************************************************/
/*!
* \file
* \ingroup PorousmediumThermalNonEquilibriumModel
* \ingroup ThermalNonEquilibriumModel
* \brief This file contains the parts of the local residual to
* calculate the heat conservation in the thermal non-equilibrium model.
*/
#ifndef DUMUX_ENERGY_NONEQUILIBRIUM_LOCAL_RESIDUAL_HH
#define DUMUX_ENERGY_NONEQUILIBRIUM_LOCAL_RESIDUAL_HH
......@@ -32,7 +33,7 @@
namespace Dumux {
/*!
* \ingroup PorousmediumThermalNonEquilibriumModel
* \ingroup ThermalNonEquilibriumModel
* \brief This file contains the parts of the local residual to
* calculate the heat conservation in the thermal non-equilibrium model.
*/
......@@ -87,7 +88,7 @@ public:
const SubControlVolume& scv,
const VolumeVariables& volVars)
{
//heat conduction for the fluid phases
// heat conduction for the fluid phases
for(int sPhaseIdx=0; sPhaseIdx<numEnergyEqSolid; ++sPhaseIdx)
{
storage[energyEqSolidIdx+sPhaseIdx] += volVars.temperatureSolid()
......@@ -151,7 +152,7 @@ public:
}
/*!
* \brief Calculate the source term of the equation
* \brief Calculates the source term of the equation.
*
* \param source The source which ought to be simulated
* \param element An element which contains part of the control volume
......@@ -165,15 +166,15 @@ public:
const ElementVolumeVariables& elemVolVars,
const SubControlVolume &scv)
{
//specialization for 2 fluid phases
// specialization for 2 fluid phases
const auto& volVars = elemVolVars[scv];
const Scalar characteristicLength = volVars.characteristicLength() ;
//interfacial area
// interfacial area
// Shi & Wang, Transport in porous media (2011)
const Scalar as = volVars.fluidSolidInterfacialArea();
//temperature fluid is the same for both fluids
// temperature fluid is the same for both fluids
const Scalar TFluid = volVars.temperatureFluid(0);
const Scalar TSolid = volVars.temperatureSolid();
......@@ -201,8 +202,8 @@ public:
DUNE_THROW(Dune::NotImplemented,
"wrong index");
} // end switch
}// end energyEqIdx
}// end source
} // end energyEqIdx
} // end source
};
template<class TypeTag>
......@@ -264,10 +265,10 @@ public:
auto upwindTerm = [phaseIdx](const auto& volVars)
{ return volVars.density(phaseIdx)*volVars.mobility(phaseIdx)*volVars.enthalpy(phaseIdx); };
//in case we have one energy equation for more than one fluid phase, add up advective parts on the one energy equation
// in case we have one energy equation for more than one fluid phase, add up advective parts on the one energy equation
flux[energyEq0Idx+phaseIdx] += fluxVars.advectiveFlux(phaseIdx, upwindTerm);
//add the diffusiv part
// add the diffusiv part
const auto diffusiveFluxes = fluxVars.molecularDiffusionFlux(phaseIdx);
const auto& insideVolVars = elemVolVars[scvf.insideScvIdx()];
const auto& outsideVolVars = elemVolVars[scvf.outsideScvIdx()];
......@@ -276,10 +277,10 @@ public:
for (int compIdx = 0; compIdx < numComponents; ++compIdx)
{
//no diffusion of the main component, this is a hack to use normal fick's law which computes both diffusions (main and component). We only add the part from the component here
// no diffusion of the main component, this is a hack to use normal fick's law which computes both diffusions (main and component). We only add the part from the component here
if (phaseIdx == compIdx)
continue;
//we need the upwind enthapy. Even better would be the componentEnthalpy
// we need the upwind enthapy. Even better would be the componentEnthalpy
auto enthalpy = 0.0;
if (diffusiveFluxes[compIdx] > 0)
enthalpy += insideEnthalpy;
......@@ -304,7 +305,7 @@ public:
}
}
/*!
* \brief Calculate the source term of the equation
* \brief Calculates the source term of the equation.
*
* \param source The source term which ought to be simulated
* \param element An element which contains part of the control volume
......@@ -318,7 +319,7 @@ public:
const ElementVolumeVariables& elemVolVars,
const SubControlVolume &scv)
{
//specialization for 2 fluid phases
// specialization for 2 fluid phases
const auto &volVars = elemVolVars[scv];
const Scalar awn = volVars.interfacialArea(phase0Idx, phase1Idx);
......@@ -372,7 +373,7 @@ public:
}// end phases
//we only need to do this for when there is more than 1 fluid phase
// we only need to do this for when there is more than 1 fluid phase
if (enableChemicalNonEquilibrium)
{
// Here comes the catch: We are not doing energy conservation for the whole
......@@ -418,9 +419,9 @@ public:
DUNE_THROW(Dune::NotImplemented,
"wrong index");
} // end switch
}// end phases
}// EnableChemicalNonEquilibrium
}// end source
} // end phases
} // EnableChemicalNonEquilibrium
} // end source
};
} // end namespace Dumux
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup PorousmediumNonEquilibriumModel
* \ingroup NonEquilibriumModel
* \brief This class contains the volume variables required for the
* modules which require the specific interfacial area between
* fluid phases.
......@@ -26,6 +26,7 @@
* This files contains all specializations which use 'real'
* interfacial areas.
*/
#ifndef DUMUX_NONEQUILIBRIUM_VOLUME_VARIABLES_HH
#define DUMUX_NONEQUILIBRIUM_VOLUME_VARIABLES_HH
......@@ -37,8 +38,7 @@
namespace Dumux {
/*!
* \file
* \ingroup PorousmediumNonEquilibriumModel
* \ingroup NonEquilibriumModel
* \brief This class contains the volume variables required for the
* modules which require the specific interfacial area between
* fluid phases.
......
......@@ -16,12 +16,12 @@
* 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 NIModel
* \brief Defines the indices used by the non-isothermal two-phase two-component model
* \brief Defines the indices used by the non-isothermal two-phase two-component model.
*/
#ifndef DUMUX_ENERGY_INDICES_HH
#define DUMUX_ENERGY_INDICES_HH
......@@ -29,7 +29,7 @@ namespace Dumux {
/*!
* \ingroup NIModel
* \brief Indices for the non-isothermal two-phase two-component model
* \brief Indices for the non-isothermal two-phase two-component model.
*
* \tparam IsothermalIndices The indices of the isothermal model
* \tparam numEq the number of equations of the non-isothermal model
......
......@@ -19,8 +19,9 @@
/*!
* \file
* \ingroup NIModel
* \brief Adds I/O fields specific to non-isothermal models
* \brief Adds I/O fields specific to non-isothermal models.
*/
#ifndef DUMUX_ENERGY_OUTPUT_FIELDS_HH
#define DUMUX_ENERGY_OUTPUT_FIELDS_HH
......@@ -31,7 +32,7 @@ namespace Dumux {
/*!
* \ingroup NIModel
* \brief Adds I/O fields specific to non-isothermal models
* \brief Adds I/O fields specific to non-isothermal models.
*/
template<class IsothermalIOFields>
class EnergyIOFields
......
......@@ -22,6 +22,7 @@
* \brief Element-wise calculation of the local residual for non-isothermal
* fully implicit models.
*/
#ifndef DUMUX_ENERGY_LOCAL_RESIDUAL_HH
#define DUMUX_ENERGY_LOCAL_RESIDUAL_HH
......@@ -52,7 +53,7 @@ class EnergyLocalResidualImplementation<TypeTag, false>
public:
/*!
* \brief The energy storage in the fluid phase with index phaseIdx
* \brief The energy storage in the fluid phase with index phaseIdx.
*
* \param storage The mass of the component within the sub-control volume
* \param scv The sub-control volume
......@@ -66,7 +67,7 @@ public:
{}
/*!
* \brief The energy storage in the solid matrix
* \brief The energy storage in the solid matrix.
*
* \param storage The mass of the component within the sub-control volume
* \param scv The sub-control volume
......@@ -78,9 +79,9 @@ public:
{}
/*!
* \brief The advective phase energy fluxes
* \brief The advective phase energy fluxes.
*
* \param flux TODO docme!
* \param flux The flux
* \param fluxVars The flux variables.
* \param phaseIdx The phase index
*/
......@@ -92,7 +93,7 @@ public:
/*!
* \brief The diffusive energy fluxes
*
* \param flux TODO docme!
* \param flux The flux
* \param fluxVars The flux variables.
*/
static void heatConductionFlux(NumEqVector& flux,
......@@ -158,7 +159,7 @@ public:
/*!
* \brief The advective phase energy fluxes
*
* \param flux TODO docme!
* \param flux The flux
* \param fluxVars The flux variables.
* \param phaseIdx The phase index
*/
......@@ -175,7 +176,7 @@ public:
/*!
* \brief The diffusive energy fluxes
*
* \param flux TODO docme!
* \param flux The flux
* \param fluxVars The flux variables.
*/
static void heatConductionFlux(NumEqVector& flux,
......
......@@ -62,6 +62,7 @@ namespace Dumux {
* \ingroup NIModel
* \brief Specifies a number properties of non-isothermal porous medium
* flow models based on the specifics of a given isothermal model.
*
* \tparam IsothermalTraits Model traits of the isothermal model
*/
template<class IsothermalT>
......
......@@ -22,6 +22,7 @@
* \brief Base class for the model specific class which provides
* access to all volume averaged quantities.
*/
#ifndef DUMUX_ENERGY_VOLUME_VARIABLES_HH
#define DUMUX_ENERGY_VOLUME_VARIABLES_HH
......@@ -76,8 +77,9 @@ class EnergyVolumeVariablesImplementation;
/*!
* \ingroup NIModel
* \brief Base class for the model specific class which provides
* access to all volume averaged quantities. The volume variables base class
* is specialized for isothermal and non-isothermal models.
* access to all volume averaged quantities.
*
* The volume variables base class is specialized for isothermal and non-isothermal models.
*/
template<class IsothermalTraits, class Impl>
using EnergyVolumeVariables = EnergyVolumeVariablesImplementation<IsothermalTraits,Impl, IsothermalTraits::ModelTraits::enableEnergyBalance()>;
......@@ -175,7 +177,7 @@ public:
else
{
//if numEnergyEq == 2 this means we have 1 temp for fluid phase, one for solid
// if numEnergyEq == 2 this means we have 1 temp for fluid phase, one for solid
if (numEnergyEq == 2)
{
const Scalar T = elemSol[scv.localDofIndex()][temperatureIdx];
......@@ -184,7 +186,7 @@ public:
fluidState.setTemperature(phaseIdx, T);
}
}
//this is for numEnergyEqFluid > 1
// this is for numEnergyEqFluid > 1
else
{
for(int phaseIdx=0; phaseIdx < FluidSystem::numPhases; ++phaseIdx)
......@@ -308,7 +310,8 @@ private:
// \{
/*!
* \brief get the solid heat capacity in an scv
* \brief Gets the solid heat capacity in an scv.
*
* \param elemSol the element solution vector
* \param problem the problem to solve
* \param element the element (codim-0-entity) the scv belongs to
......@@ -328,7 +331,8 @@ private:
}
/*!
* \brief get the solid density in an scv
* \brief Gets the solid density in an scv.
*
* \param elemSol the element solution vector
* \param problem the problem to solve
* \param element the element (codim-0-entity) the scv belongs to
......@@ -348,7 +352,8 @@ private:
}
/*!
* \brief get the solid's thermal conductivity in an scv
* \brief Gets the solid's thermal conductivity in an scv.
*
* \param elemSol the element solution vector
* \param problem the problem to solve
* \param element the element (codim-0-entity) the scv belongs to
......@@ -376,7 +381,8 @@ private:
// \{
/*!
* \brief get the solid heat capacity in an scv
* \brief Gets the solid heat capacity in an scv.
*
* \param elemSol the element solution vector
* \param problem the problem to solve
* \param element the element (codim-0-entity) the scv belongs to
......@@ -400,7 +406,8 @@ private:
}
/*!
* \brief get the solid density in an scv
* \brief Gets the solid density in an scv.
*
* \param elemSol the element solution vector
* \param problem the problem to solve
* \param element the element (codim-0-entity) the scv belongs to
......@@ -424,7 +431,8 @@ private:
}
/*!
* \brief get the solid's heat capacity in an scv
* \brief Gets the solid's heat capacity in an scv.
*
* \param elemSol the element solution vector
* \param problem the problem to solve
* \param element the element (codim-0-entity) the scv belongs to
......
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