Skip to content
Snippets Groups Projects
Commit 003274fc authored by Dennis Gläser's avatar Dennis Gläser Committed by Timo Koch
Browse files

[doxygen][co2] do not doc dumux namespace

parent 58beca98
No related branches found
No related tags found
1 merge request!3367[ci] add job for doxygen docu build
...@@ -18,35 +18,29 @@ ...@@ -18,35 +18,29 @@
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \file * \file
* \ingroup CO2Model
* \brief Adaption of the fully implicit scheme to the CO2Model model.
*/
#ifndef DUMUX_TWOP_TWOC_CO2_MODEL_HH
#define DUMUX_TWOP_TWOC_CO2_MODEL_HH
#include <dumux/common/properties.hh>
#include <dumux/porousmediumflow/2p2c/model.hh>
#include "volumevariables.hh"
/*!
* \ingroup CO2Model * \ingroup CO2Model
* \brief Adaption of the non-isothermal two-phase two-component flow model to problems with CO2 * \brief Adaption of the non-isothermal two-phase two-component flow model to problems with CO2
* *
* TODO: Put a doxgyen link reference here * See @ref TwoPTwoCModel for reference to the equations used.
* See TwoPTwoCModel for reference to the equations used. * The CO2 model is derived from the 2p2c model, however, in the CO2 model the phase switch criterion
* The CO2 model is derived from the 2p2c model. In the CO2 model the phase switch criterion
* is different from the 2p2c model. * is different from the 2p2c model.
* The phase switch occurs when the equilibrium concentration * The phase switch occurs when the equilibrium concentration
* of a component in a phase is exceeded, instead of the sum of the components in the virtual phase * of a component in a phase is exceeded, instead of the sum of the components in the virtual phase
* (the phase which is not present) being greater that unity as done in the 2p2c model. * (the phase which is not present) being greater that unity as done in the 2p2c model.
* The CO2VolumeVariables do not use a constraint solver for calculating the mole fractions as is the * The CO2VolumeVariables do not use a constraint solver for calculating the mole fractions as is the
* case in the 2p2c model. Instead mole fractions are calculated in the FluidSystem with a given * case in the 2p2c model. Instead, mole fractions are calculated in the FluidSystem with a given
* temperature, pressure and salinity. * temperature, pressure and salinity.
* The model is able to use either mole or mass fractions. The property useMoles can be set to either true or false in the * The model is able to use either mole or mass fractions. The property useMoles can be set to either true or false,
* problem file. Make sure that the according units are used in the problem setup. useMoles is set to false by default. * but make sure that the according units are used in the problem setup. useMoles is set to false by default.
*
*/ */
#ifndef DUMUX_TWOP_TWOC_CO2_MODEL_HH
#define DUMUX_TWOP_TWOC_CO2_MODEL_HH
#include <dumux/common/properties.hh>
#include <dumux/porousmediumflow/2p2c/model.hh>
#include "volumevariables.hh"
namespace Dumux { namespace Dumux {
namespace Properties { namespace Properties {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment