Commit 3e7db981 authored by Katharina Heck's avatar Katharina Heck
Browse files

Merge branch 'fix/mpnc-docu' into 'next'

Fix/mpnc docu

See merge request !702
parents 533268b3 238bb8b4
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup MPNCModel
* \brief The primary variable and equation indices for the MpNc model.
*/
#ifndef DUMUX_MPNC_INDICES_HH
......@@ -30,7 +31,6 @@ namespace Dumux
/*!
* \ingroup MPNCModel
* \ingroup ImplicitIndices
* \brief Enumerates the formulations which the MpNc model accepts.
*/
struct MpNcPressureFormulation
......@@ -43,7 +43,6 @@ struct MpNcPressureFormulation
/*!
* \ingroup MPNCModel
* \ingroup ImplicitIndices
* \brief The primary variable and equation indices for the MpNc model.
*/
template <class TypeTag, int BasePVOffset = 0>
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup MPNCModel
* \brief MpNc specific details needed to approximately calculate the local
* defect in the fully implicit scheme.
*
......@@ -32,7 +33,6 @@ namespace Dumux
{
/*!
* \ingroup MPNCModel
* \ingroup ImplicitLocalResidual
* \brief MpNc specific details needed to approximately calculate the local
* defect in the fully implicit scheme.
*
......
......@@ -115,10 +115,7 @@
#include "localresidual.hh"
/*!
* \ingroup Properties
* \ingroup ImplicitProperties
* \ingroup BoxMpNcModel
* \file
* \ingroup \ingroup MPNCModel
* \brief Defines the properties required for the MpNc fully implicit model.
*/
namespace Dumux
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup MPNCModel
* \brief Contains the secondary variables (Quantities which are
* constant within a finite volume) of the MpNc model.
*/
......@@ -38,7 +38,6 @@ namespace Dumux
{
/*!
* \ingroup MPNCModel
* \ingroup ImplicitVolumeVariables
* \brief Contains the quantities which are constant within a
* finite volume in the MpNc model.
*/
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup MPNCModel
* \brief Adds vtk output fields specific to the twop model
*/
#ifndef DUMUX_MPNC_VTK_OUTPUT_FIELDS_HH
......@@ -27,7 +28,7 @@ namespace Dumux
{
/*!
* \ingroup TwoP, InputOutput
* \ingroup MPNCModel
* \brief Adds vtk output fields specific to the twop model
*/
template<class TypeTag>
......
......@@ -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>
......
......@@ -15,15 +15,13 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file combustionproblem1c.hh
*
* \file
* \ingroup MPNCTests
* \brief Problem where hot, pure liquid water is injected from the left hand side into a initially
* isotherm domain. The water is fully evaporated by a strong heat source.
* A local thermal non-equilibrium model is used: i.e. two different (fluid, solid)
* temperatures are primary variables.
*
* \ingroup MpNcBoxproblems
*
* \author Philipp Nuske
*/
#ifndef DUMUX_COMBUSTION_PROBLEM_ONE_COMPONENT_HH
......@@ -106,8 +104,7 @@ SET_INT_PROP(CombustionProblemOneComponent, NumEqBalance, GET_PROP_VALUE(TypeTag
}
/*!
* \ingroup MpNcBoxproblems
*
* \ingroup MPNCTests
* \brief Problem where water is injected from the left hand side into a porous media filled domain,
* which is supplied with energy from the right hand side to evaporate the water.
*/
......
......@@ -17,8 +17,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file combustionspatialparams.hh
*
* \file
* \ingroup MPNCTests
* \brief Spatialparameters for the combustionproblem1c. Parameters for the actual simulation domain and an outflow region are provided.
*/
#ifndef DUMUX_COMBUSTION_SPATIALPARAMS_HH
......@@ -34,7 +34,10 @@
namespace Dumux
{
/*!
* \ingroup MPNCTests
* \brief Spatialparameters for the combustionproblem1c. Parameters for the actual simulation domain and an outflow region are provided.
*/
//forward declaration
template<class TypeTag>
class CombustionSpatialParams;
......
......@@ -17,8 +17,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file evaporationatmosphereproblem.hh
* \ingroup MpNcBoxproblems
* \file
* \ingroup MPNCTests
*
* \brief Problem showcasing the capabilities of the kinetic model.
*
......@@ -28,10 +28,6 @@
*
* The porous domain is bypassed with dry air. This way the equilibration process on top of the porous domain can be studied.
*
* The Problem is written, such that the kinetic consideration for mass and energy can
* be switched of by merely setting kinetic, kineticenergy respectivly to false.
* Boundary and initial conditions are specified for all cases.
*
* \author Philipp Nuske
*/
#ifndef DUMUX_EVAPORATION_ATMOSPHERE_PROBLEM_HH
......@@ -58,7 +54,11 @@
namespace Dumux
{
/*!
* \ingroup MPNCTests
*
* \brief Problem showcasing the capabilities of the kinetic model.
*/
template <class TypeTag>
class EvaporationAtmosphereProblem;
......
......@@ -17,7 +17,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file evaporationatmospherespatialparams.hh
* \file
* \ingroup MPNCTests
* \brief spatialparameters for the kinetic test-case of the mpnc model. "Poor-mans" coupling of free-flow and porous medium.
*
*/
......@@ -45,7 +46,11 @@
namespace Dumux
{
/*!
* \ingroup MPNCTests
* \brief spatialparameters for the kinetic test-case of the mpnc model. "Poor-mans" coupling of free-flow and porous medium.
*
*/
//forward declaration
template<class TypeTag>
class EvaporationAtmosphereSpatialParams;
......
......@@ -16,8 +16,9 @@
* 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 MPNCTests
* \brief Problem where liquid water is injected -- by means of a
* Dirichlet condition on the lower right of the domain -- which has to go
* around an obstacle with \f$10^3\f$ lower permeability.
......@@ -41,7 +42,12 @@
namespace Dumux
{
/*!
* \ingroup MPNCTests
* \brief Problem where liquid water is injected -- by means of a
* Dirichlet condition on the lower right of the domain -- which has to go
* around an obstacle with \f$10^3\f$ lower permeability.
*/
template <class TypeTag>
class ObstacleProblem;
......
......@@ -16,9 +16,9 @@
* 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 MPNCTests
* \brief The spatial parameters for the ObstacleProblem
*/
......@@ -34,7 +34,10 @@
namespace Dumux
{
/*!
* \ingroup MPNCTests
* \brief The spatial parameters for the ObstacleProblem
*/
//forward declaration
template<class TypeTag>
class ObstacleSpatialParams;
......
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