diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt index 0b37e26bf1f1b5f2e7a06335c931c06bab073a9e..c1d1cfef04587979095c04c5557befb25d43fd42 100644 --- a/doc/doxygen/modules.txt +++ b/doc/doxygen/modules.txt @@ -409,7 +409,7 @@ * - __Fluid-Matrix Interactions:__ <br> @copydoc Fluidmatrixinteractions * - __Fluid state:__ <br> @copydoc FluidStates * - __Solid state:__ <br> @copydoc SolidStates - * - __Fluid system:__ <br> @copydoc Fluidsystems + * - __Fluid system:__ <br> @copydoc FluidSystems * - __Solid system:__ <br> @copydoc SolidSystems * - __Spatial Parameters:__ <br> @copydoc SpatialParameters */ diff --git a/dumux/material/fluidsystems/1padapter.hh b/dumux/material/fluidsystems/1padapter.hh index 082da5eedcd7fb28911df658db1ee8a9ff54e78e..1bc0a080e17693773e162daab9e3cfe1ada1e0cb 100644 --- a/dumux/material/fluidsystems/1padapter.hh +++ b/dumux/material/fluidsystems/1padapter.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::FluidSystems::OnePAdapter */ #ifndef DUMUX_FLUIDSYTEMS_ONEP_ADAPTER_HH @@ -35,7 +35,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief An adapter for multi-phase fluid systems to be used with (compositional) one-phase models * \tparam MPFluidSystem the multi-phase fluid system to be adapted * \tparam phase the index of the phase we choose from the multi-phase fluid system diff --git a/dumux/material/fluidsystems/1pgas.hh b/dumux/material/fluidsystems/1pgas.hh index ecf49a69941cbdcc9d96ba5e9b3afd49a8638eb4..4ebf28aa3d73b076fd6fa31fb2975bb97d68340d 100644 --- a/dumux/material/fluidsystems/1pgas.hh +++ b/dumux/material/fluidsystems/1pgas.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::FluidSystems::OnePGas */ #ifndef DUMUX_GAS_PHASE_HH @@ -37,7 +37,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief A gaseous phase consisting of a single component */ template <class Scalar, class ComponentT> diff --git a/dumux/material/fluidsystems/1pliquid.hh b/dumux/material/fluidsystems/1pliquid.hh index 280f4312a88ca10e89e30dca37e8320d7dbeda46..d71dbd74aff1cb4e24059138fc672c6d702bb3ca 100644 --- a/dumux/material/fluidsystems/1pliquid.hh +++ b/dumux/material/fluidsystems/1pliquid.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::FluidSystems::OnePLiquid */ #ifndef DUMUX_LIQUID_PHASE_HH @@ -37,7 +37,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief A liquid phase consisting of a single component */ template <class Scalar, class ComponentT> diff --git a/dumux/material/fluidsystems/2p1c.hh b/dumux/material/fluidsystems/2p1c.hh index a858be0f529290b9a326fc5f69af865abeb95bfe..86082fe1f871fd3421d2b8c4b344118d64617db8 100644 --- a/dumux/material/fluidsystems/2p1c.hh +++ b/dumux/material/fluidsystems/2p1c.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::FluidSystems::TwoPOneC */ #ifndef DUMUX_2P_1C_FLUID_SYSTEM_HH @@ -37,7 +37,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief A two-phase fluid system with only one component. */ template <class Scalar, class ComponentType> diff --git a/dumux/material/fluidsystems/2pimmiscible.hh b/dumux/material/fluidsystems/2pimmiscible.hh index c474849176fbf69c991014fa39687c0cfb9dcda8..a70036dcd28c28da334f389712c5d4cab98766e7 100644 --- a/dumux/material/fluidsystems/2pimmiscible.hh +++ b/dumux/material/fluidsystems/2pimmiscible.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::FluidSystems::TwoPImmiscible */ #ifndef DUMUX_2P_IMMISCIBLE_FLUID_SYSTEM_HH @@ -41,7 +41,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief A fluid system for two-phase models assuming immiscibility and * thermodynamic equilibrium * diff --git a/dumux/material/fluidsystems/3pimmiscible.hh b/dumux/material/fluidsystems/3pimmiscible.hh index 7c1ae81e7c73ba1d3b2702a4336935d1d6c2efaa..6a9411828be57193c644f07dc8d725b95fcf704b 100644 --- a/dumux/material/fluidsystems/3pimmiscible.hh +++ b/dumux/material/fluidsystems/3pimmiscible.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::FluidSystems::ThreePImmiscible */ #ifndef DUMUX_3P_IMMISCIBLE_FLUID_SYSTEM_HH @@ -40,7 +40,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief A fluid system for three-phase models assuming immiscibility and * thermodynamic equilibrium * diff --git a/dumux/material/fluidsystems/base.hh b/dumux/material/fluidsystems/base.hh index 5421fa80583d2bd04ff5c42d4ed4a9062353d287..ce98bab6bdfd13929408562e3bce6c6fee4354bd 100644 --- a/dumux/material/fluidsystems/base.hh +++ b/dumux/material/fluidsystems/base.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::FluidSystems::Base */ #ifndef DUMUX_BASE_FLUID_SYSTEM_HH @@ -34,7 +34,7 @@ namespace Dumux { namespace FluidSystems { /*! -* \ingroup Fluidsystems +* \ingroup FluidSystems * \brief Fluid system base class. * * \note Always derive your fluid system from this class to be sure diff --git a/dumux/material/fluidsystems/brine.hh b/dumux/material/fluidsystems/brine.hh index eca5ed88ddedf2b6388c6f13641888e4eaeaf146..f567df4d5c7c22867b56316432c8d035180cf733 100644 --- a/dumux/material/fluidsystems/brine.hh +++ b/dumux/material/fluidsystems/brine.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief A fluid system for brine, i.e. H2O with dissolved NaCl. */ #ifndef DUMUX_BRINE_FLUID_SYSTEM_HH @@ -38,7 +38,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief A compositional single phase fluid system consisting of * two components, which are H2O and NaCl. */ diff --git a/dumux/material/fluidsystems/brineair.hh b/dumux/material/fluidsystems/brineair.hh index 0d94fed11860a55293cee2eb6787cffc2f4ec04a..872ff3b44dfdd49ea306375b05873d640043d600 100644 --- a/dumux/material/fluidsystems/brineair.hh +++ b/dumux/material/fluidsystems/brineair.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::FluidSystems::BrineAir */ #ifndef DUMUX_BRINE_AIR_FLUID_SYSTEM_HH @@ -48,7 +48,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief Policy for the brine-air fluid system */ template<bool fastButSimplifiedRelations = false> @@ -60,7 +60,7 @@ struct BrineAirDefaultPolicy }; /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief A compositional two-phase fluid system with a liquid and a gaseous phase * and \f$H_2O\f$, \f$Air\f$ and \f$S\f$ (dissolved minerals) as components. * diff --git a/dumux/material/fluidsystems/brineco2.hh b/dumux/material/fluidsystems/brineco2.hh index 4b0a027e7dbe66c6859ed2382cd884c138a39ae6..f189855ce4251dea3ede712533360efbfa2b0511 100644 --- a/dumux/material/fluidsystems/brineco2.hh +++ b/dumux/material/fluidsystems/brineco2.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::FluidSystems::BrineCO2 */ #ifndef DUMUX_BRINE_CO2_FLUID_SYSTEM_HH @@ -84,7 +84,7 @@ namespace Dumux::FluidSystems::Detail { namespace Dumux::FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief Default policy for the Brine-CO2 fluid system */ template<bool salinityIsConstant, bool fastButSimplifiedRelations = false> @@ -95,7 +95,7 @@ struct BrineCO2DefaultPolicy }; /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief A compositional fluid with brine (H2O & NaCl) and carbon dioxide as * components in both the liquid and the gas (supercritical) phase. * diff --git a/dumux/material/fluidsystems/h2oair.hh b/dumux/material/fluidsystems/h2oair.hh index e111f6a35cdb20fa5fdeb3ba4c9f26d5e907f18c..ad21bdbde74a63b31e6c084005bb0cbac9ed0929 100644 --- a/dumux/material/fluidsystems/h2oair.hh +++ b/dumux/material/fluidsystems/h2oair.hh @@ -19,7 +19,7 @@ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::FluidSystems::H2OAir */ #ifndef DUMUX_H2O_AIR_SYSTEM_HH @@ -43,7 +43,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief Policy for the H2O-air fluid system */ template<bool fastButSimplifiedRelations = false> @@ -55,7 +55,7 @@ struct H2OAirDefaultPolicy }; /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * * \brief A compositional two-phase fluid system with water and air as * components in both, the liquid and the gas phase. diff --git a/dumux/material/fluidsystems/h2oairmesitylene.hh b/dumux/material/fluidsystems/h2oairmesitylene.hh index 7bcfdaa61a7f8efa90dab4575505e8ced292ff2e..471833f9529b0657ee3da50fb26c2fac860c73fa 100644 --- a/dumux/material/fluidsystems/h2oairmesitylene.hh +++ b/dumux/material/fluidsystems/h2oairmesitylene.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::FluidSystems::H2OAirMesitylene */ #ifndef DUMUX_H2O_AIR_MESITYLENE_FLUID_SYSTEM_HH @@ -43,7 +43,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief A three-phase fluid system featuring gas, NAPL and water as phases and * distilled water \f$(\mathrm{H_2O})\f$ and air (Pseudo component composed of * \f$\mathrm{79\%\;N_2}\f$, \f$\mathrm{20\%\;O_2}\f$ and Mesitylene \f$(\mathrm{C_6H_3(CH_3)_3})\f$ as components. diff --git a/dumux/material/fluidsystems/h2oairxylene.hh b/dumux/material/fluidsystems/h2oairxylene.hh index 138f69a1e00bd6a99380e5f1f00064616a72c2f7..56b08cda83b1c355a6f907bece885f28efadfeed 100644 --- a/dumux/material/fluidsystems/h2oairxylene.hh +++ b/dumux/material/fluidsystems/h2oairxylene.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::FluidSystems::H2OAirXylene */ #ifndef DUMUX_H2O_AIR_XYLENE_FLUID_SYSTEM_HH @@ -42,7 +42,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief A three-phase fluid system featuring gas, NAPL and water as phases and * distilled water \f$(\mathrm{H_2O})\f$ and air (Pseudo component composed of * \f$\mathrm{79\%\;N_2}\f$, \f$\mathrm{20\%\;O_2}\f$ and Mesitylene \f$(\mathrm{C_8H_{10}})\f$ as components. diff --git a/dumux/material/fluidsystems/h2oheavyoil.hh b/dumux/material/fluidsystems/h2oheavyoil.hh index e56f6a37b37b074bd8e3dc164ca65d92d43c85e5..5b0843f3f9f30ff14ef38555383d29a6f13dd0fb 100644 --- a/dumux/material/fluidsystems/h2oheavyoil.hh +++ b/dumux/material/fluidsystems/h2oheavyoil.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::FluidSystems::H2OHeavyOil */ #ifndef DUMUX_H2O_HEAVYOIL_FLUID_SYSTEM_HH @@ -39,7 +39,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief A compositional fluid system with water and heavy oil * components in both the liquid and the gas phase. */ diff --git a/dumux/material/fluidsystems/h2on2.hh b/dumux/material/fluidsystems/h2on2.hh index ccbae655f0218007b21b633b76d0dee35367992b..bc9fbb02e3735ecdb087b6411b28a4ecef131c26 100644 --- a/dumux/material/fluidsystems/h2on2.hh +++ b/dumux/material/fluidsystems/h2on2.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copydoc Dumux::FluidSystems::H2ON2 */ #ifndef DUMUX_H2O_N2_FLUID_SYSTEM_HH @@ -43,7 +43,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief Policy for the H2O-N2 fluid system */ template<bool fastButSimplifiedRelations = false> @@ -57,7 +57,7 @@ struct H2ON2DefaultPolicy }; /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * * \brief A two-phase fluid system with two components water \f$(\mathrm{H_2O})\f$ * Nitrogen \f$(\mathrm{N_2})\f$ for non-equilibrium models. diff --git a/dumux/material/fluidsystems/h2on2kinetic.hh b/dumux/material/fluidsystems/h2on2kinetic.hh index cba3c98c6e3dec372efe12fbd30b810b437f20be..bf1070f7fe1e91b78c882087bb501370b92788b1 100644 --- a/dumux/material/fluidsystems/h2on2kinetic.hh +++ b/dumux/material/fluidsystems/h2on2kinetic.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copydoc Dumux::FluidSystems::H2ON2Kinetic */ #ifndef DUMUX_H2O_N2_FLUID_SYSTEM_KINETIC_HH @@ -39,7 +39,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief A two-phase fluid system with two components water \f$(\mathrm{H_2O})\f$ * Nitrogen \f$(\mathrm{N_2})\f$ for non-equilibrium models. TODO: Is this fluid system necessary?? */ diff --git a/dumux/material/fluidsystems/h2on2o2.hh b/dumux/material/fluidsystems/h2on2o2.hh index acbffcb39c8c85e8efec73165a6af23ec2b69b2e..17a72b4b3926faa9c398c6a79a595c38ea8fd405 100644 --- a/dumux/material/fluidsystems/h2on2o2.hh +++ b/dumux/material/fluidsystems/h2on2o2.hh @@ -19,7 +19,7 @@ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::FluidSystems::H2ON2O2 */ #ifndef DUMUX_H2O_N2_O2_FLUID_SYSTEM_HH @@ -48,7 +48,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief Policy for the H2O-N2-O2 fluid system */ template<bool fastButSimplifiedRelations = false> @@ -62,7 +62,7 @@ struct H2ON2O2DefaultPolicy }; /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief A two-phase (water and air) fluid system * with water, nitrogen and oxygen as components. * diff --git a/dumux/material/fluidsystems/liquidphase2c.hh b/dumux/material/fluidsystems/liquidphase2c.hh index 44ed3c9a0817691846581d9092fbe34a68d7773b..4eea57c45f88103d50188436a3178d7dfc2abac4 100644 --- a/dumux/material/fluidsystems/liquidphase2c.hh +++ b/dumux/material/fluidsystems/liquidphase2c.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::FluidSystems::LiquidPhaseTwoC */ #ifndef DUMUX_LIQUID_TWOC_PHASE_HH @@ -36,7 +36,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief A liquid phase consisting of a two components, * a main component and a conservative tracer component */ diff --git a/dumux/material/fluidsystems/nullparametercache.hh b/dumux/material/fluidsystems/nullparametercache.hh index cda4faae9ebe59b79bc5c83b105f20e7fd9e2820..f3ebebd5fc1eb1e77dfe4c186776f787223f0988 100644 --- a/dumux/material/fluidsystems/nullparametercache.hh +++ b/dumux/material/fluidsystems/nullparametercache.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::NullParameterCache */ #ifndef DUMUX_NULL_PARAMETER_CACHE_HH @@ -28,7 +28,7 @@ namespace Dumux { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief The a parameter cache which does nothing */ class NullParameterCache : public ParameterCacheBase<NullParameterCache> {}; diff --git a/dumux/material/fluidsystems/parametercachebase.hh b/dumux/material/fluidsystems/parametercachebase.hh index 5b80c287eb35b4b46260bb35591ca9e3372a6886..a20c9986351a1404125c3b4224148d48837cf04b 100644 --- a/dumux/material/fluidsystems/parametercachebase.hh +++ b/dumux/material/fluidsystems/parametercachebase.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::ParameterCacheBase */ #ifndef DUMUX_PARAMETER_CACHE_BASE_HH @@ -27,7 +27,7 @@ namespace Dumux { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief The base class of the parameter cache classes for fluid systems */ template <class Implementation> diff --git a/dumux/material/fluidsystems/spe5.hh b/dumux/material/fluidsystems/spe5.hh index 3074202a7399b6cf9ebca6c103af6d2eab8431f0..29e7eede6c1756c17b5397bf549f1e952aaffa47 100644 --- a/dumux/material/fluidsystems/spe5.hh +++ b/dumux/material/fluidsystems/spe5.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::FluidSystems::Spe5 */ #ifndef DUMUX_SPE5_FLUID_SYSTEM_HH @@ -34,7 +34,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief The fluid system for the SPE-5 benchmark problem. * * A three-phase fluid system featuring gas, oil and water as phases and the seven diff --git a/dumux/material/fluidsystems/spe5parametercache.hh b/dumux/material/fluidsystems/spe5parametercache.hh index 294810a423da8afe9d16fe6abfa521ca504448aa..988021083e257fb73c01fe5ed8cf54b70f5e2471 100644 --- a/dumux/material/fluidsystems/spe5parametercache.hh +++ b/dumux/material/fluidsystems/spe5parametercache.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief @copybrief Dumux::Spe5ParameterCache */ #ifndef SPE5_PARAMETER_CACHE_HH @@ -35,7 +35,7 @@ namespace Dumux { /*! - * \ingroup Fluidsystems + * \ingroup FluidSystems * \brief Specifies the parameters required by the SPE5 problem which * are despondent on the thermodynamic state. */