Commit dd451d0b authored by Katharina Heck's avatar Katharina Heck
Browse files

[fix] docu nonequilibrium

parent f8e9a772
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup PorousmediumNonEquilibriumModel
* \brief Class storing scv and scvf variables
*/
#ifndef DUMUX_NONEQUILIBRIUM_GRID_VARIABLES_HH
......@@ -28,9 +29,8 @@
namespace Dumux
{
/*!
* \ingroup NonEquilbriumModel
* \ingroup PorousmediumNonEquilibriumModel
* \brief This class stores the velocities which are used to compute reynoldsnumbers for the source terms of nonequilibrium models
*/
template<class TypeTag>
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup PorousmediumNonEquilibriumModel
* \brief The primary variable and equation indices for the MpNc model.
*/
#ifndef DUMUX_NONEQUILIBRIUM_INDICES_HH
......@@ -29,8 +30,7 @@ namespace Dumux
{
/*!
* \ingroup NonEquilibrium
* \ingroup ImplicitIndices
* \ingroup PorousmediumNonEquilibriumModel
* \brief The primary variable and equation indices for the MpNc model.
*/
template <class TypeTag, int BasePVOffset = 0>
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup PorousmediumNonEquilibriumModel
* \brief The local residual for the kinetic mass transfer module of
* the compositional multi-phase model.
*/
......@@ -38,6 +39,7 @@ template <class TypeTag>
using NonEquilibriumLocalResidual = NonEquilibriumLocalResidualImplementation<TypeTag, GET_PROP_VALUE(TypeTag, EnableThermalNonEquilibrium), GET_PROP_VALUE(TypeTag, EnableChemicalNonEquilibrium)>;
/*!
* \ingroup PorousmediumNonEquilibriumModel
* \brief The mass conservation part of the nonequilibrium model for a model without chemical non-equilibrium
*/
template<class TypeTag>
......
......@@ -16,6 +16,13 @@
* 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
* \brief This is the specialization that is able to capture non-equilibrium mass and / or energy transfer.
* \todo DocMe
*/
#ifndef DUMUX_NONEQUILIBRIUM_MODEL_HH
#define DUMUX_NONEQUILIBRIUM_MODEL_HH
......@@ -30,12 +37,8 @@
#include "vtkoutputfields.hh"
/*!
* \ingroup Properties
* \ingroup ImplicitProperties
* \ingroup NonEquilibriumModel
* \file
* \brief This is the specialization that is able to capture non-equilibrium mass and / or energy transfer.
*
* \ingroup \ingroup PorousmediumNonEquilibriumModel
* \brief Defines the properties required for non-equilibrium models
*/
namespace Dumux
{
......
......@@ -18,9 +18,9 @@
*****************************************************************************/
/*!
* \file
* \ingroup PorousmediumNonEquilibriumModel
* \brief A MpNc specific controller for the newton solver.
*
* This controller calls the velocity averaging in the model after each iteration.
* This controller calls the velocity averaging in the model after each iteration.
*/
#ifndef DUMUX_NONEQUILIBRIUM_NEWTON_CONTROLLER_HH
#define DUMUX_NONEQUILIBRIUM_NEWTON_CONTROLLER_HH
......@@ -31,11 +31,9 @@
namespace Dumux {
/*!
* \brief A kinetic-nonequilibrium specific controller for the newton solver.
*
* \ingroup PorousmediumNonEquilibriumModel
* \brief A nonequilibrium specific controller for the newton solver.
* This controller calls the velocity averaging in the problem after each iteration.
*
* Everything else is taken from the standard mpnc newtoncontroller.
*/
template <class TypeTag>
class NonEquilibriumNewtonController : public NewtonController<TypeTag>
......
......@@ -17,10 +17,9 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup PorousmediumThermalNonEquilibriumModel
* \brief This file contains the parts of the local residual to
* calculate the heat conservation in the thermal non-equilibrium M-phase
* N-component model.
* calculate the heat conservation in the thermal non-equilibrium model.
*/
#ifndef DUMUX_ENERGY_NONEQUILIBRIUM_LOCAL_RESIDUAL_HH
#define DUMUX_ENERGY_NONEQUILIBRIUM_LOCAL_RESIDUAL_HH
......@@ -30,7 +29,11 @@
namespace Dumux
{
/*!
* \ingroup PorousmediumThermalNonEquilibriumModel
* \brief This file contains the parts of the local residual to
* calculate the heat conservation in the thermal non-equilibrium model.
*/
// forward declaration
template <class TypeTag, int numEnergyEqFluid>
class EnergyLocalResidualNonEquilibrium;
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup PorousmediumNonEquilibriumModel
* \brief This class contains the volume variables required for the
* modules which require the specific interfacial area between
* fluid phases.
......@@ -40,7 +40,13 @@
namespace Dumux
{
/*!
* \file
* \ingroup PorousmediumNonEquilibriumModel
* \brief This class contains the volume variables required for the
* modules which require the specific interfacial area between
* fluid phases.
*/
// forward declaration
template <class TypeTag, bool enableChemicalNonEquilibrium ,bool enableThermalNonEquilibrium>
class NonEquilibriumVolumeVariablesImplementation;
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup PorousmediumNonEquilibriumModel
* \brief Adds vtk output fields specific to non-isothermal models
*/
#ifndef DUMUX_NONEQUILBRIUM_OUTPUT_FIELDS_HH
......@@ -29,7 +30,7 @@ namespace Dumux
{
/*!
* \ingroup NonEquilibrium, InputOutput
* \ingroup PorousmediumNonEquilibriumModel
* \brief Adds vtk output fields specific to non-isothermal models
*/
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