diff --git a/dumux/porousmediumflow/3pwateroil/indices.hh b/dumux/porousmediumflow/3pwateroil/indices.hh index bab64a79eaf1b547c800bb4ec1667889a8fbebbe..52541a3205ba01e39c131a2ab268d5f5bb7dea36 100644 --- a/dumux/porousmediumflow/3pwateroil/indices.hh +++ b/dumux/porousmediumflow/3pwateroil/indices.hh @@ -18,6 +18,7 @@ *****************************************************************************/ /*! * \file + * \ingroup ThreePWaterOilModel * \brief Defines the indices required for the 3p2cni model. */ #ifndef DUMUX_3P2CNI_INDICES_HH @@ -29,7 +30,6 @@ namespace Dumux /*! * \ingroup ThreePWaterOilModel - * \ingroup ImplicitIndices * \brief The indices for the isothermal 3p2cni model. * * \tparam formulation The formulation, only pgSwSn diff --git a/dumux/porousmediumflow/3pwateroil/localresidual.hh b/dumux/porousmediumflow/3pwateroil/localresidual.hh index f1990f5a4722b5e80f9afd633a0732b65ded3b8c..4bb312fd7890e2431b25ff0b0980ad98afafdd59 100644 --- a/dumux/porousmediumflow/3pwateroil/localresidual.hh +++ b/dumux/porousmediumflow/3pwateroil/localresidual.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * + * \ingroup ThreePWaterOilModel * \brief Element-wise calculation of the Jacobian matrix for problems * using the three-phase three-component fully implicit model. */ @@ -32,11 +32,10 @@ namespace Dumux { /*! * \ingroup ThreePWaterOilModel - * \ingroup ImplicitLocalResidual - * \brief Element-wise calculation of the Jacobian matrix for problems - * using the three-phase three-component fully implicit model. + * \brief Element-wise calculation of the local residual for problems + * using the ThreePWaterOil fully implicit model. * - * This class is used to fill the gaps in BoxLocalResidual for the 3P2C flow. + * This class is used to fill the gaps in the CompositionalLocalResidual for the 3PWaterOil flow. */ template<class TypeTag> class ThreePWaterOilLocalResidual: public ThreePThreeCLocalResidual<TypeTag> diff --git a/dumux/porousmediumflow/3pwateroil/model.hh b/dumux/porousmediumflow/3pwateroil/model.hh index 2fd41afc981486a753125f36cfff5a0b30c1fa0a..0506938e8876fecf6420394cbc39591a04281179 100644 --- a/dumux/porousmediumflow/3pwateroil/model.hh +++ b/dumux/porousmediumflow/3pwateroil/model.hh @@ -18,38 +18,11 @@ *****************************************************************************/ /*! * \file - * + * \ingroup ThreePWaterOilModel * \brief Adaption of the fully implicit scheme to the three-phase three-component flow model. * * The model is designed for simulating three fluid phases with water, gas, and * a liquid contaminant (NAPL - non-aqueous phase liquid) - */ -#ifndef DUMUX_3PWATEROIL_MODEL_HH -#define DUMUX_3PWATEROIL_MODEL_HH - -#include <dumux/common/properties.hh> - -#include <dumux/material/spatialparams/fv.hh> -#include <dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh> -#include <dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh> - -#include <dumux/porousmediumflow/properties.hh> -#include <dumux/porousmediumflow/nonisothermal/model.hh> -#include <dumux/porousmediumflow/compositional/switchableprimaryvariables.hh> - -#include "indices.hh" -#include "model.hh" -#include "volumevariables.hh" -#include "localresidual.hh" -#include "primaryvariableswitch.hh" -#include "vtkoutputfields.hh" - -namespace Dumux -{ -/*! - * \ingroup ThreePWaterOilModel - * \brief Adaption of the fully implicit scheme to the three-phase two-component flow model. - * * This model implements three-phase two-component flow of three fluid phases * \f$\alpha \in \{ water, gas, NAPL \}\f$ each composed of up to two components * \f$\kappa \in \{ water, contaminant \}\f$. The standard multiphase Darcy @@ -94,6 +67,34 @@ namespace Dumux * <li> ... to be completed ... </li> * </ul> */ + +#ifndef DUMUX_3PWATEROIL_MODEL_HH +#define DUMUX_3PWATEROIL_MODEL_HH + +#include <dumux/common/properties.hh> + +#include <dumux/material/spatialparams/fv.hh> +#include <dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh> +#include <dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh> + +#include <dumux/porousmediumflow/properties.hh> +#include <dumux/porousmediumflow/nonisothermal/model.hh> +#include <dumux/porousmediumflow/compositional/switchableprimaryvariables.hh> + +#include "indices.hh" +#include "model.hh" +#include "volumevariables.hh" +#include "localresidual.hh" +#include "primaryvariableswitch.hh" +#include "vtkoutputfields.hh" + +namespace Dumux +{ +/*! + * \ingroup ThreePWaterOilModel + * \brief Adaption of the fully implicit scheme to the three-phase two-component flow model. + * + */ namespace Properties { NEW_TYPE_TAG(ThreePWaterOilNI, INHERITS_FROM(PorousMediumFlow, NonIsothermal)); diff --git a/dumux/porousmediumflow/3pwateroil/primaryvariableswitch.hh b/dumux/porousmediumflow/3pwateroil/primaryvariableswitch.hh index 3585f350b5678c4d1fc15142201fa62d6040cbca..35c945abefb71c7a6d05ca6f7a334d1679dd5d87 100644 --- a/dumux/porousmediumflow/3pwateroil/primaryvariableswitch.hh +++ b/dumux/porousmediumflow/3pwateroil/primaryvariableswitch.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * + * \ingroup ThreePWaterOilModel * \brief The primary variable switch for the 3p3c model */ #ifndef DUMUX_3P3C_PRIMARY_VARIABLE_SWITCH_HH diff --git a/dumux/porousmediumflow/3pwateroil/volumevariables.hh b/dumux/porousmediumflow/3pwateroil/volumevariables.hh index fe6f805f56d3d35e986aefe49b4207cd0ee3d50a..b48f932adac6f620bc183cd8e034424e689e4c9d 100644 --- a/dumux/porousmediumflow/3pwateroil/volumevariables.hh +++ b/dumux/porousmediumflow/3pwateroil/volumevariables.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * + * \ingroup ThreePWaterOilModel * \brief Contains the quantities which are constant within a * finite volume in the three-phase, two-component model. */ @@ -45,7 +45,7 @@ namespace Dumux /*! * \ingroup ThreePWaterOilModel * \brief Contains the quantities which are are constant within a - * finite volume in the two-phase, two-component model. + * finite volume in the three-phase, two-component model. */ template <class TypeTag> class ThreePWaterOilVolumeVariables : public PorousMediumFlowVolumeVariables<TypeTag> diff --git a/dumux/porousmediumflow/3pwateroil/vtkoutputfields.hh b/dumux/porousmediumflow/3pwateroil/vtkoutputfields.hh index fe13bf378cb2640a35587e3782956f1406337d9d..079e1dce9292a8ae047dae1f3c6540a8f63304fd 100644 --- a/dumux/porousmediumflow/3pwateroil/vtkoutputfields.hh +++ b/dumux/porousmediumflow/3pwateroil/vtkoutputfields.hh @@ -18,6 +18,7 @@ *****************************************************************************/ /*! * \file + * \ingroup ThreePWaterOilModel * \brief Adds vtk output fields specific to the twop model */ #ifndef DUMUX_THREEPWATEROIL_VTK_OUTPUT_FIELDS_HH @@ -29,7 +30,7 @@ namespace Dumux { /*! - * \ingroup ThreePThreeC, InputOutput + * \ingroup ThreePWaterOilModel * \brief Adds vtk output fields specific to the three-phase three-component model */ template<class TypeTag> diff --git a/test/porousmediumflow/3pwateroil/implicit/test_box3pwateroil.cc b/test/porousmediumflow/3pwateroil/implicit/test_box3pwateroil.cc index 6f5c1d3b18700ebc253f6d1390d86dacbdd67f76..ef46ef7d475312fb4aa98379c44a422ea3e5b7fd 100644 --- a/test/porousmediumflow/3pwateroil/implicit/test_box3pwateroil.cc +++ b/test/porousmediumflow/3pwateroil/implicit/test_box3pwateroil.cc @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * + * \ingroup OnePTests * \brief Test for the three-phase three-component box model */ #include <config.h> @@ -52,8 +52,7 @@ /*! * \brief Provides an interface for customizing error messages associated with * reading in parameters. - * - * \param progName The name of the program, that was tried to be started. + * \ingroup OnePTests * \param errorMsg The error message that was issued by the start function. * Comprises the thing that went wrong and a general help message. */