diff --git a/doc/doxygen/modules b/doc/doxygen/modules index ec4868c8b6fa33339b3a1b5f3022b358b245d827..97faf33be3baf1a0b158e90c7c18d9f2f0ac2474 100644 --- a/doc/doxygen/modules +++ b/doc/doxygen/modules @@ -101,15 +101,15 @@ */ /*! * \ingroup ImplicitModels - * \defgroup OnePBoxModel One-phase + * \defgroup OnePModel One-phase * - * \copydetails Dumux::OnePBoxModel + * \copydetails Dumux::OnePModel */ /*! * \ingroup ImplicitModels - * \defgroup OnePTwoCBoxModel One-phase Two-component + * \defgroup OnePTwoCModel One-phase Two-component * - * \copydetails Dumux::OnePTwoCBoxModel + * \copydetails Dumux::OnePTwoCModel */ /*! * \ingroup ImplicitModels diff --git a/dumux/implicit/1p/1pindices.hh b/dumux/implicit/1p/1pindices.hh index 6eacd5ca7cab55c2a44f529229fb03c0ed09fecd..59bff376183fe4ca87d76bfad4b0043405db78d6 100644 --- a/dumux/implicit/1p/1pindices.hh +++ b/dumux/implicit/1p/1pindices.hh @@ -28,7 +28,7 @@ namespace Dumux // \{ /*! - * \ingroup OnePBoxModel + * \ingroup OnePModel * \ingroup ImplicitIndices * \brief Indices for the one-phase model. */ diff --git a/dumux/implicit/1p/1plocalresidual.hh b/dumux/implicit/1p/1plocalresidual.hh index 7b4fd0500b5bd6adb95df2be0b33ebb4f8f83258..034ce348c7ef732e75e8fe24d402b557aafe14cf 100644 --- a/dumux/implicit/1p/1plocalresidual.hh +++ b/dumux/implicit/1p/1plocalresidual.hh @@ -30,7 +30,7 @@ namespace Dumux { /*! - * \ingroup OnePBoxModel + * \ingroup OnePModel * \ingroup ImplicitLocalResidual * \brief Element-wise calculation of the Jacobian matrix for problems * using the one-phase fully implicit model. diff --git a/dumux/implicit/1p/1pmodel.hh b/dumux/implicit/1p/1pmodel.hh index 78d9050b27ad0e83bd10a103dba6ece325507c19..0148ddc7ce388b702f18c699a4b2045b73eb1b64 100644 --- a/dumux/implicit/1p/1pmodel.hh +++ b/dumux/implicit/1p/1pmodel.hh @@ -33,7 +33,7 @@ namespace Dumux { /*! - * \ingroup OnePBoxModel + * \ingroup OnePModel * \brief A single-phase, isothermal flow model using the fully implicit scheme. * * Single-phase, isothermal flow model, which uses a standard Darcy approach as the diff --git a/dumux/implicit/1p/1pproperties.hh b/dumux/implicit/1p/1pproperties.hh index 968867f4a10c188cb567de15234c7416e8d9b605..eecd66e74cb32a85e5c36cc82663b36a866ad28c 100644 --- a/dumux/implicit/1p/1pproperties.hh +++ b/dumux/implicit/1p/1pproperties.hh @@ -19,7 +19,7 @@ /*! * \ingroup Properties * \ingroup ImplicitProperties - * \ingroup OnePBoxModel + * \ingroup OnePModel * \file * * \brief Defines the properties required for the one-phase fully implicit model. diff --git a/dumux/implicit/1p/1ppropertydefaults.hh b/dumux/implicit/1p/1ppropertydefaults.hh index e85a296c623bc9a025973d9c3c72d3b98113e046..3d9bd134ad05f33033cf62ce937a97e90b652d57 100644 --- a/dumux/implicit/1p/1ppropertydefaults.hh +++ b/dumux/implicit/1p/1ppropertydefaults.hh @@ -19,7 +19,7 @@ /*! * \ingroup Properties * \ingroup ImplicitProperties - * \ingroup OnePBoxModel + * \ingroup OnePModel * \file * * \brief Defines the properties required for the one-phase fully implicit model. diff --git a/dumux/implicit/1p/1pvolumevariables.hh b/dumux/implicit/1p/1pvolumevariables.hh index f3411bf4d9102825d477a04dc07fbac40a963f6a..097b114b744eab635cc2cc0ee3a8473dbb62bbb2 100644 --- a/dumux/implicit/1p/1pvolumevariables.hh +++ b/dumux/implicit/1p/1pvolumevariables.hh @@ -33,7 +33,7 @@ namespace Dumux { /*! - * \ingroup OnePBoxModel + * \ingroup OnePModel * \ingroup ImplicitVolumeVariables * \brief Contains the quantities which are constant within a * finite volume in the one-phase model. @@ -143,7 +143,7 @@ public: { return fluidState_.viscosity(/*phaseIdx=*/0); } /*! - * \brief Returns the mobility. + * \brief Returns the mobility \f$\mathrm{[1/(Pa s)]}\f$. * * This function enables the use of ImplicitDarcyFluxVariables * with the 1p fully implicit model, ALTHOUGH the term mobility is diff --git a/dumux/implicit/1p2c/1p2cfluxvariables.hh b/dumux/implicit/1p2c/1p2cfluxvariables.hh index bb416b93263355ff3102673d4641e11f2e9fcce7..ded8c1aa5c650ee396ca874707e7337952242a16 100644 --- a/dumux/implicit/1p2c/1p2cfluxvariables.hh +++ b/dumux/implicit/1p2c/1p2cfluxvariables.hh @@ -37,7 +37,7 @@ namespace Dumux { /*! - * \ingroup OnePTwoCBoxModel + * \ingroup OnePTwoCModel * \ingroup ImplicitFluxVariables * \brief This template class contains the data which is required to * calculate the fluxes of the fluid phases over a face of a @@ -381,11 +381,11 @@ protected: const Element& elementI = *fvGeometry_.neighbors[face().i]; FVElementGeometry fvGeometryI; fvGeometryI.subContVol[0].global = elementI.geometry().center(); - + const Element& elementJ = *fvGeometry_.neighbors[face().j]; FVElementGeometry fvGeometryJ; fvGeometryJ.subContVol[0].global = elementJ.geometry().center(); - + sp.meanK(K_, sp.intrinsicPermeability(elementI, fvGeometryI, 0), sp.intrinsicPermeability(elementJ, fvGeometryJ, 0)); diff --git a/dumux/implicit/1p2c/1p2cindices.hh b/dumux/implicit/1p2c/1p2cindices.hh index d42e706ad9e74af804d7708462e4b61849187b9b..00473458ba574d8dd30adfe715dab846780afed7 100644 --- a/dumux/implicit/1p2c/1p2cindices.hh +++ b/dumux/implicit/1p2c/1p2cindices.hh @@ -32,7 +32,7 @@ namespace Dumux // \{ /*! - * \ingroup OnePTwoCBoxModel + * \ingroup OnePTwoCModel * \ingroup ImplicitIndices * \brief The indices for the isothermal single-phase, two-component model. */ diff --git a/dumux/implicit/1p2c/1p2clocalresidual.hh b/dumux/implicit/1p2c/1p2clocalresidual.hh index 3050849e06d6f3e4ab6bc02cd9a54480c0e493d9..ca742b32ba95feeb098fe63f14424e7b54f04344 100644 --- a/dumux/implicit/1p2c/1p2clocalresidual.hh +++ b/dumux/implicit/1p2c/1p2clocalresidual.hh @@ -32,7 +32,7 @@ namespace Dumux { /*! * - * \ingroup OnePTwoCBoxModel + * \ingroup OnePTwoCModel * \ingroup ImplicitLocalResidual * \brief Calculate the local Jacobian for the single-phase, * two-component model in the fully implicit scheme. diff --git a/dumux/implicit/1p2c/1p2cmodel.hh b/dumux/implicit/1p2c/1p2cmodel.hh index 6e2f364a4d9ff3e7b3816a862ff87c4caebeb66a..85ac63fd3d0820f6266efd0263b47492a4ed3817 100644 --- a/dumux/implicit/1p2c/1p2cmodel.hh +++ b/dumux/implicit/1p2c/1p2cmodel.hh @@ -34,7 +34,7 @@ namespace Dumux { /*! - * \ingroup OnePTwoCBoxModel + * \ingroup OnePTwoCModel * \brief Adaption of the fully implicit scheme to the one-phase two-component flow model. * * This model implements a one-phase flow of a compressible fluid, that consists of two components, diff --git a/dumux/implicit/1p2c/1p2cproperties.hh b/dumux/implicit/1p2c/1p2cproperties.hh index f66881dc0adfd22641a84f5b9414edb120ed201b..33a9afe7fe3844dba0cd1eb52b471711d71de971 100644 --- a/dumux/implicit/1p2c/1p2cproperties.hh +++ b/dumux/implicit/1p2c/1p2cproperties.hh @@ -19,7 +19,7 @@ /*! * \ingroup Properties * \ingroup ImplicitProperties - * \ingroup OnePTwoCBoxModel + * \ingroup OnePTwoCModel * \file * * \brief Defines the properties required for the single-phase, @@ -62,8 +62,8 @@ NEW_PROP_TAG(FluidSystem); //!< Type of the multi-component relations NEW_PROP_TAG(ImplicitMassUpwindWeight); //!< The default value of the upwind weight NEW_PROP_TAG(ImplicitMobilityUpwindWeight); //!< Weight for the upwind mobility in the velocity calculation NEW_PROP_TAG(ProblemEnableGravity); //!< Returns whether gravity is considered in the problem -NEW_PROP_TAG(UseMoles); //!Defines whether mole (true) or mass (false) fractions are used -NEW_PROP_TAG(Scaling); //!Defines Scaling of the model +NEW_PROP_TAG(UseMoles); //!< Defines whether mole (true) or mass (false) fractions are used +NEW_PROP_TAG(Scaling); //!< Defines Scaling of the model NEW_PROP_TAG(SpatialParamsForchCoeff); //!< Property for the forchheimer coefficient NEW_PROP_TAG(VtkAddVelocity); //!< Returns whether velocity vectors are written into the vtk output } diff --git a/dumux/implicit/1p2c/1p2cpropertydefaults.hh b/dumux/implicit/1p2c/1p2cpropertydefaults.hh index 5a7a91c1acf4f29bdc7d37305f22c171048bba18..5fee57bca4baff650586da5be4c07110ed45f049 100644 --- a/dumux/implicit/1p2c/1p2cpropertydefaults.hh +++ b/dumux/implicit/1p2c/1p2cpropertydefaults.hh @@ -19,7 +19,7 @@ /*! * \ingroup Properties * \ingroup ImplicitProperties - * \ingroup OnePTwoCBoxModel + * \ingroup OnePTwoCModel * \file * * \brief Defines some default values for the properties of the the diff --git a/dumux/implicit/1p2c/1p2cvolumevariables.hh b/dumux/implicit/1p2c/1p2cvolumevariables.hh index 810416f6ff52c5a6742f73173da9bf06504592b7..261db93c50a79ac0cfd62d63fe607c804f38d8aa 100644 --- a/dumux/implicit/1p2c/1p2cvolumevariables.hh +++ b/dumux/implicit/1p2c/1p2cvolumevariables.hh @@ -33,7 +33,7 @@ namespace Dumux { /*! - * \ingroup OnePTwoCBoxModel + * \ingroup OnePTwoCModel * \ingroup ImplicitVolumeVariables * \brief Contains the quantities which are constant within a * finite volume in the single-phase, two-component model. diff --git a/test/implicit/1p/1ptestproblem.hh b/test/implicit/1p/1ptestproblem.hh index 81e35ec08ec9535286a6890e86964b5ac329fabe..186c8da7ec76fd743653ac80fc30319521d8f610 100644 --- a/test/implicit/1p/1ptestproblem.hh +++ b/test/implicit/1p/1ptestproblem.hh @@ -106,7 +106,7 @@ SET_BOOL_PROP(OnePTestProblem, ProblemEnableGravity, true); } /*! - * \ingroup OnePBoxModel + * \ingroup OnePModel * \ingroup ImplicitTestProblems * \brief Test problem for the one-phase model: * water is flowing from bottom to top through and around a low permeable lens. @@ -185,7 +185,7 @@ public: } /*! - * \brief Return the temperature within the domain. + * \brief Return the temperature within the domain in [K]. * * This problem assumes a temperature of 10 degrees Celsius. */ diff --git a/test/implicit/1p/1ptestspatialparams.hh b/test/implicit/1p/1ptestspatialparams.hh index 98eaeec88e7af8c2e7f3f65d4f0e70bc2ed93ba0..7072a345dfd6c2694ed11df3503b2892c7e3c64f 100644 --- a/test/implicit/1p/1ptestspatialparams.hh +++ b/test/implicit/1p/1ptestspatialparams.hh @@ -31,7 +31,7 @@ namespace Dumux { /*! - * \ingroup OnePBoxModel + * \ingroup OnePModel * \ingroup ImplicitTestProblems * * \brief The spatial parameters class for the test problem using the @@ -86,7 +86,7 @@ public: } /*! - * \brief Return the intrinsic permeability for the current sub-control volume. + * \brief Return the intrinsic permeability for the current sub-control volume in [m^2]. * * \param element The current finite element * \param fvGeometry The current finite volume geometry of the element @@ -105,7 +105,7 @@ public: return permeability_; } - /*! \brief Define the porosity. + /*! \brief Define the porosity in [-]. * * \param element The finite element * \param fvGeometry The finite volume geometry diff --git a/test/implicit/1p2c/1p2coutflowproblem.hh b/test/implicit/1p2c/1p2coutflowproblem.hh index 285af9e3a4ea4a07b25136f63c7dbf95ae148e52..38b96d2e9ef2373b6f2019e84edce5d1ade4a544 100644 --- a/test/implicit/1p2c/1p2coutflowproblem.hh +++ b/test/implicit/1p2c/1p2coutflowproblem.hh @@ -90,7 +90,7 @@ SET_BOOL_PROP(OnePTwoCOutflowProblem, ProblemEnableGravity, false); /*! - * \ingroup OnePTwoCBoxModel + * \ingroup OnePTwoCModel * \ingroup ImplicitTestProblems * * \brief Definition of a problem, for the 1p2c problem: @@ -111,7 +111,7 @@ SET_BOOL_PROP(OnePTwoCOutflowProblem, ProblemEnableGravity, false); * 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. The default setting for useMoles is true. * - * This problem uses the \ref OnePTwoCBoxModel model. + * This problem uses the \ref OnePTwoCModel model. * * To run the simulation execute the following line in shell: * <tt>./test_box1p2c -parameterFile ./test_box1p2c.input</tt> or @@ -195,7 +195,7 @@ public: } /*! - * \brief Returns the temperature within the domain. + * \brief Returns the temperature within the domain [K]. * * This problem assumes a temperature of 20 degrees Celsius. */ @@ -227,7 +227,7 @@ public: { values.setAllNeumann(); } - + // outflow condition for the transport equation at right boundary if(globalPos[0] > this->bBoxMax()[0] - eps_) values.setOutflow(transportEqIdx); diff --git a/test/implicit/1p2c/1p2coutflowspatialparams.hh b/test/implicit/1p2c/1p2coutflowspatialparams.hh index 0c4749d1ee66b7f239404be41559177324eb2c26..d1c37da0bddb0b46a525a30ef06484db3a749c4e 100644 --- a/test/implicit/1p2c/1p2coutflowspatialparams.hh +++ b/test/implicit/1p2c/1p2coutflowspatialparams.hh @@ -34,7 +34,7 @@ namespace Dumux { /*! - * \ingroup OnePTwoCBoxModel + * \ingroup OnePTwoCModel * \ingroup ImplicitTestProblems * * \brief Definition of the spatial parameters for the 1p2c diff --git a/test/implicit/2p2c/injectionproblem.hh b/test/implicit/2p2c/injectionproblem.hh index a398c428880a811e50ab05d4116918ee17a7e10d..c677fa9fe8bdbc0c44d4298e9f3c1866df79fa08 100644 --- a/test/implicit/2p2c/injectionproblem.hh +++ b/test/implicit/2p2c/injectionproblem.hh @@ -252,7 +252,7 @@ public: { return name_; } /*! - * \brief Returns the temperature \f$ K \f$ + * \brief Returns the temperature [K] */ Scalar temperature() const { return temperature_; }; diff --git a/test/implicit/co2/heterogeneousproblem.hh b/test/implicit/co2/heterogeneousproblem.hh index 3953df05c900a993ba0fb4237a374af779bf5111..8f028a3b4487041fee359f159226d475fb3ea1c5 100644 --- a/test/implicit/co2/heterogeneousproblem.hh +++ b/test/implicit/co2/heterogeneousproblem.hh @@ -122,7 +122,7 @@ SET_BOOL_PROP(HeterogeneousProblem, UseMoles, false); * 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. The default setting for useMoles is false. * - * This problem uses the \ref OnePTwoCBoxModel model. + * This problem uses the \ref OnePTwoCModel model. * * To run the simulation execute the following line in shell (works with the box and cell centered spatial discretization method): * <tt>./test_ccco2 </tt> or <tt>./test_boxco2 </tt>