From 003274fc37a77b264e3ebf0d3420725b7f17b505 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dennis=20Gl=C3=A4ser?= <dennis.glaeser@iws.uni-stuttgart.de>
Date: Wed, 1 Mar 2023 14:40:24 +0100
Subject: [PATCH] [doxygen][co2] do not doc dumux namespace
---
dumux/porousmediumflow/co2/model.hh | 32 ++++++++++++-----------------
1 file changed, 13 insertions(+), 19 deletions(-)
diff --git a/dumux/porousmediumflow/co2/model.hh b/dumux/porousmediumflow/co2/model.hh
index 85e0cdce31..46ae07e92c 100644
--- a/dumux/porousmediumflow/co2/model.hh
+++ b/dumux/porousmediumflow/co2/model.hh
@@ -18,35 +18,29 @@
*****************************************************************************/
/*!
* \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
* \brief Adaption of the non-isothermal two-phase two-component flow model to problems with CO2
*
- * TODO: Put a doxgyen link reference here
- * See TwoPTwoCModel for reference to the equations used.
- * The CO2 model is derived from the 2p2c model. In the CO2 model the phase switch criterion
+ * See @ref 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
* is different from the 2p2c model.
* 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
* (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
- * 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.
- * The model is able to use either mole or mass fractions. The property useMoles can be set to either true or false in the
- * problem file. Make sure that the according units are used in the problem setup. useMoles is set to false by default.
- *
+ * The model is able to use either mole or mass fractions. The property useMoles can be set to either true or false,
+ * 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 Properties {
--
GitLab