Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
dumuxrepositories
dumux
Commits
3aae3506
Commit
3aae3506
authored
Nov 19, 2019
by
Kai Wendel
Committed by
Timo Koch
Nov 19, 2019
Browse files
[doc] Correct some typos in comments
parent
94239795
Changes
18
Hide whitespace changes
Inline
Sidebyside
dumux/material/fluidmatrixinteractions/1p/thermalconductivityaverage.hh
View file @
3aae3506
...
...
@@ 54,7 +54,7 @@ public:
* \brief Relation for a simple effective thermal conductivity \f$\mathrm{[W/(m K)]}\f$
*
* \param volVars volume variables
* \return
e
ffective thermal conductivity \f$\mathrm{[W/(m K)]}\f$
* \return
E
ffective thermal conductivity \f$\mathrm{[W/(m K)]}\f$
*/
template
<
class
VolumeVariables
>
static
Scalar
effectiveThermalConductivity
(
const
VolumeVariables
&
volVars
)
...
...
dumux/material/fluidmatrixinteractions/2p/brookscorey.hh
View file @
3aae3506
...
...
@@ 54,7 +54,7 @@ public:
/*!
* \brief The capillary pressuresaturation curve according to Brooks & Corey.
*
* The BrooksCorey empirical
capillary pressure <> saturation
* The BrooksCorey empirical capillary pressure <> saturation
* function is given by
*
* \f$\mathrm{ p_C = p_e\overline{S}_w^{1/\lambda}
...
...
@@ 109,7 +109,7 @@ public:
* \brief The capillary pressure at Swe = 1.0 also called end point capillary pressure
*
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
*/
static
Scalar
endPointPc
(
const
Params
&
params
)
...
...
@@ 126,7 +126,7 @@ public:
*
* \param swe Effective saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
* \return Partial derivative of \f$\mathrm{[p_c]}\f$ w.r.t. effective saturation according to Brooks & Corey.
*
...
...
@@ 150,7 +150,7 @@ public:
*
* \param pc Capillary pressure \f$\mathrm{[p_c]}\f$ in \f$\mathrm{[Pa]}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
* \return Partial derivative of effective saturation w.r.t. \f$\mathrm{[p_c]}\f$ according to Brooks & Corey.
*
...
...
@@ 174,7 +174,7 @@ public:
*
* \param swe The mobile saturation of the wetting phase.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Relative permeability of the wetting phase calculated as implied by Brooks & Corey.
*
...
...
@@ 199,7 +199,7 @@ public:
*
* \param swe The mobile saturation of the wetting phase.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Derivative of the relative permeability of the wetting phase w.r.t. effective wetting phase
* saturation calculated as implied by Brooks & Corey.
...
...
@@ 225,7 +225,7 @@ public:
*
* \param swe The mobile saturation of the wetting phase.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
* \return Relative permeability of the nonwetting phase calculated as implied by Brooks & Corey.
*
...
...
@@ 253,7 +253,7 @@ public:
*
* \param swe The mobile saturation of the wetting phase.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Derivative of the relative permeability of the nonwetting phase w.r.t. effective wetting phase
* saturation calculated as implied by Brooks & Corey.
...
...
dumux/material/fluidmatrixinteractions/2p/brookscoreyparams.hh
View file @
3aae3506
...
...
@@ 35,7 +35,7 @@ namespace Dumux {
/*!
* \ingroup Fluidmatrixinteractions
* \brief Specification of the material parameters
* for the Brooks Corey constitutive relations.
*
for the Brooks Corey constitutive relations.
* \see BrooksCorey
*/
template
<
class
ScalarT
>
...
...
dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh
View file @
3aae3506
...
...
@@ 84,7 +84,7 @@ public:
*
* \param pc Capillary pressure \f$\mathrm{[p_c]}\f$ in \f$\mathrm{[Pa]}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Absolute wetting phase saturation \f$\mathrm{[S_w]}\f$ calculated as inverse of
* (EffLaw e.g. Brooks & Corey, van Genuchten, linear...) constitutive relation.
...
...
@@ 98,7 +98,7 @@ public:
* \brief The capillary pressure at Swe = 1.0 also called end point capillary pressure
*
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
*/
static
Scalar
endPointPc
(
const
Params
&
params
)
...
...
@@ 115,7 +115,7 @@ public:
}\f$
* \param sw Absolute saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Partial derivative of \f$\mathrm{[p_c]}\f$ w.r.t. effective saturation according to
EffLaw e.g. Brooks & Corey, van Genuchten, linear... .
...
...
@@ 138,7 +138,7 @@ public:
*
* \param pc Capillary pressure \f$\mathrm{[p_c]}\f$ in \f$\mathrm{[Pa]}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Partial derivative of effective saturation w.r.t. \f$\mathrm{[p_c]}\f$ according to
EffLaw e.g. Brooks & Corey, van Genuchten, linear... .
...
...
@@ 154,7 +154,7 @@ public:
* \param sw Absolute saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$. It is converted to effective saturation
* and then handed over to the material law actually used for calculation.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Relative permeability of the wetting phase calculated as implied by
* EffLaw e.g. Brooks & Corey, van Genuchten, linear... .
...
...
@@ 183,7 +183,7 @@ public:
* \param sw Absolute saturation of the wetting phase \f$\mathrm{[{S}_w]}\f$. It is converted to effective saturation
* and then handed over to the material law actually used for calculation.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Relative permeability of the nonwetting phase calculated as implied by
* EffLaw e.g. Brooks & Corey, van Genuchten, linear... .
...
...
@@ 211,7 +211,7 @@ public:
*
* \param sw Absolute saturation of the wetting phase \f$\mathrm{[{S}_w]}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Effective saturation of the wetting phase.
*/
...
...
@@ 225,7 +225,7 @@ public:
*
* \param sn Absolute saturation of the nonwetting phase \f$\mathrm{[{S}_n]}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Effective saturation of the nonwetting phase.
*/
...
...
@@ 234,13 +234,12 @@ public:
return
(
sn

params
.
snr
())
/
(
1.

params
.
swr
()

params
.
snr
());
}
//private:
/*!
* \brief Convert an effective wetting saturation to an absolute one.
*
* \param swe Effective saturation of the nonwetting phase \f$\mathrm{[\overline{S}_n]}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Absolute saturation of the nonwetting phase.
*/
...
...
@@ 253,7 +252,7 @@ public:
* \brief Derivative of the effective saturation w.r.t. the absolute saturation.
*
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Derivative of the effective saturation w.r.t. the absolute saturation.
*/
...
...
@@ 264,7 +263,7 @@ public:
* \brief Derivative of the absolute saturation w.r.t. the effective saturation.
*
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Derivative of the absolute saturation w.r.t. the effective saturation.
*/
...
...
dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh
View file @
3aae3506
...
...
@@ 82,7 +82,7 @@ public:
*
* \return The effective saturaion of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$
* \param params Array of parameters
* \param pC
c
apillary pressure \f$\mathrm{[p_C]}\f$ in \f$\mathrm{[Pa]}\f$.
* \param pC
C
apillary pressure \f$\mathrm{[p_C]}\f$ in \f$\mathrm{[Pa]}\f$.
*/
static
Scalar
Sw
(
const
Params
&
params
,
Scalar
pC
)
{
...
...
@@ 114,7 +114,7 @@ public:
* \brief Returns the partial derivative of the effective
* saturation to the capillary pressure.
* \param params Array of parameters
* \param pC
c
apillary pressure \f$\mathrm{[p_C]}\f$ in \f$\mathrm{[Pa]}\f$.
* \param pC
C
apillary pressure \f$\mathrm{[p_C]}\f$ in \f$\mathrm{[Pa]}\f$.
*/
static
Scalar
dSw_dpC
(
const
Params
&
params
,
Scalar
pC
)
{
...
...
dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh
View file @
3aae3506
...
...
@@ 60,7 +60,7 @@ public:
*
* \param swe Effective saturation of the wetting phase \f$\overline{S}_w\f$ conversion from absolute saturation happened in EffToAbsLaw.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
* \return Capillary pressure calculated by linear constitutive relation.
*/
...
...
@@ 79,7 +79,7 @@ public:
*
* \param pc Capillary pressure \f$\mathrm{[p_C]}\f$ in \f$\mathrm{[Pa]}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
* \return Effective wetting phase saturation calculated as inverse of the linear constitutive relation.
*/
...
...
@@ 92,7 +92,7 @@ public:
* \brief The capillary pressure at Swe = 1.0 also called end point capillary pressure
*
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
*/
static
Scalar
endPointPc
(
const
Params
&
params
)
...
...
@@ 109,7 +109,7 @@ public:
}\f$
* \param swe Effective saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$ conversion from absolute saturation happened in EffToAbsLaw.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
* \return Partial derivative of \f$\mathrm{[p_c]}\f$ w.r.t. effective saturation according to linear material relation.
*/
...
...
@@ 124,7 +124,7 @@ public:
*
* \param pc Capillary pressure \f$\mathrm{[p_C]}\f$ in \f$\mathrm{[Pa]}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
* \return Partial derivative of effective saturation w.r.t. \f$\mathrm{[p_c]}\f$ according to linear relation.
*/
...
...
@@ 137,7 +137,7 @@ public:
* \brief The relative permeability for the wetting phase.
*
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
* \param swe Effective saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$ conversion from absolute saturation happened in EffToAbsLaw.
* \return Relative permeability of the wetting phase calculated as linear relation.
...
...
@@ 153,7 +153,7 @@ public:
* \brief The relative permeability for the nonwetting phase.
*
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
* \param swe Effective saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$ conversion from absolute saturation happened in EffToAbsLaw.
* \return Relative permeability of the nonwetting phase calculated as linear relation.
...
...
dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh
View file @
3aae3506
...
...
@@ 195,7 +195,7 @@ public:
* \brief The capillary pressure at Swe = 1.0 also called end point capillary pressure
*
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
*/
static
Scalar
endPointPc
(
const
Params
&
params
)
...
...
@@ 449,7 +449,7 @@ private:
* saturations below the minimum saturation.
*
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
*/
static
Scalar
mLow_
(
const
Params
&
params
)
...
...
dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh
View file @
3aae3506
...
...
@@ 61,7 +61,7 @@ public:
}\f$
* \param swe Effective saturation of the wetting phase \f$\mathrm{\overline{S}_w}\f$
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
* \note Instead of undefined behaviour if swe is not in the valid range, we return a valid number,
* by clamping the input. Note that for pc(swe = 0.0) = inf, have a look at RegularizedVanGenuchten if this is a problem.
...
...
@@ 88,7 +88,7 @@ public:
*
* \param pc Capillary pressure \f$\mathrm{p_C}\f$ in \f$\mathrm{[Pa]}\f$
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
* \return The effective saturation of the wetting phase \f$\mathrm{\overline{S}_w}\f$
* \note Instead of undefined behaviour if pc is not in the valid range, we return a valid number,
...
...
@@ 109,7 +109,8 @@ public:
* \brief The capillary pressure at Swe = 1.0 also called end point capillary pressure
*
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first,
* the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
*/
static
Scalar
endPointPc
(
const
Params
&
params
)
...
...
@@ 128,7 +129,8 @@ public:
*
* \param swe Effective saturation of the wetting phase \f$\mathrm{\overline{S}_w}\f$
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters
* first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
*
* \note Instead of undefined behaviour if swe is not in the valid range, we return a valid number,
...
...
@@ 153,7 +155,8 @@ public:
*
* \param pc Capillary pressure \f$\mathrm{p_C}\f$ in \f$\mathrm{[Pa]}\f$
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters
* first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
*
* \note Instead of undefined behaviour if pc is not in the valid range, we return a valid number,
...
...
@@ 177,7 +180,8 @@ public:
*
* \param swe The mobile saturation of the wetting phase.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters
* first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
*
* \note Instead of undefined behaviour if pc is not in the valid range, we return a valid number,
...
...
@@ 203,7 +207,8 @@ public:
*
* \param swe The mobile saturation of the wetting phase.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters
* first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
*
* \note Instead of undefined behaviour if pc is not in the valid range, we return a valid number,
...
...
@@ 230,7 +235,8 @@ public:
*
* \param swe The mobile saturation of the wetting phase.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters
* first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
*
* \note Instead of undefined behaviour if pc is not in the valid range, we return a valid number,
...
...
@@ 255,7 +261,8 @@ public:
*
* \param swe The mobile saturation of the wetting phase.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters
* first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
*
* \note Instead of undefined behaviour if pc is not in the valid range, we return a valid number,
...
...
dumux/material/fluidmatrixinteractions/2pia/efftoabslawia.hh
View file @
3aae3506
...
...
@@ 46,7 +46,7 @@ namespace Dumux {
*
* This approach makes sure that in the "material laws" only effective saturations are considered, which makes sense,
* as these laws only deal with effective saturations. This also allows for changing the calculation of the effective
* saturations easily, as this is subject of discussion
/
may be problem specific.
* saturations easily, as this is subject of discussion may be problem specific.
*
* Additionally, handing over effective saturations to the "material laws" in stead of them calculating effective
* saturations prevents accidently "converting twice".
...
...
@@ 91,7 +91,7 @@ protected:
*
* \param sw Absolute saturation of the wetting phase \f$\mathrm{{S}_w}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
* \return Effective saturation of the wetting phase.
*/
...
...
dumux/material/fluidmatrixinteractions/3p/efftoabslaw.hh
View file @
3aae3506
...
...
@@ 70,7 +70,7 @@ public:
* \param sw Absolute saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$. It is converted to effective saturation
* and then handed over to the material law actually used for calculation.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Capillary pressure calculated by specific constitutive relation
* (EffLaw e.g. Brooks & Corey, van Genuchten, linear...)
...
...
@@ 263,7 +263,7 @@ public:
*
* \param sw Absolute saturation of the wetting phase \f$\mathrm{[{S}_w]}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Effective saturation of the wetting phase.
*/
...
...
@@ 277,7 +277,7 @@ public:
*
* \param sn Absolute saturation of the nonwetting phase \f$\mathrm{[{S}_n]}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Effective saturation of the nonwetting phase.
*/
...
...
@@ 291,7 +291,7 @@ public:
*
* \param st Absolute saturation of the total liquid phase (sw+sn) \f$\mathrm{[{S}_n]}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Effective saturation of the nonwetting phase.
*/
...
...
@@ 305,7 +305,7 @@ public:
*
* \param sg Absolute saturation of the gas phase \f$\mathrm{[{S}_n]}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Effective saturation of the nonwetting phase.
*/
...
...
@@ 320,7 +320,7 @@ public:
*
* \param swe Effective saturation of the nonwetting phase \f$\mathrm{[\overline{S}_n]}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Absolute saturation of the nonwetting phase.
*/
...
...
@@ 342,7 +342,7 @@ public:
* \brief Derivative of the effective saturation w.r.t. the absolute saturation.
*
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Derivative of the effective saturation w.r.t. the absolute saturation.
*/
...
...
@@ 355,7 +355,7 @@ public:
* \brief Derivative of the absolute saturation w.r.t. the effective saturation.
*
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen,
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Derivative of the absolute saturation w.r.t. the effective saturation.
*/
...
...
dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh
View file @
3aae3506
...
...
@@ 245,7 +245,7 @@ public:
krn
*=
sqrt
(
resIncluded
);
}
else
krn
*=
sqrt
(
sn
/
(
1

params
.
swr
()));
// Hint: (ste  swe) = sn / (1S
r
w)
krn
*=
sqrt
(
sn
/
(
1

params
.
swr
()));
// Hint: (ste  swe) = sn / (1Sw
r
)
return
krn
;
}
...
...
@@ 278,7 +278,7 @@ public:
*
* \param ste The mobile total liquid saturation.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters
first, the material law is chosen, and then the params container
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
*/
static
Scalar
dkrg_dste
(
const
Params
&
params
,
Scalar
ste
)
...
...
@@ 296,7 +296,7 @@ public:
/*!
* \brief The relative permeability for a phase.
* \param params Array of parameters.
* \param phaseIdx
i
ndicator, The saturation of all phases.
* \param phaseIdx
I
ndicator, The saturation of all phases.
* \param swe Effective wetting phase saturation
* \param sn Absolute nonwetting liquid saturation
* \param ste Effective total liquid (wetting + nonwetting) saturation
...
...
@@ 331,7 +331,7 @@ private:
* \brief The standard van Genuchten twophase pcS relation either with respect to
* the effective wetting phase saturation Swe or the effective total liquid saturation Ste.
* \param params Array of parameters.
* \param Se Effective wetting phase ortotal liquid
saturation
* \param Se Effective wetting phase ortotal liquid saturation
*/
const
static
Scalar
pc_
(
const
Params
&
params
,
const
Scalar
se
)
{
...
...
dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3p.hh
View file @
3aae3506
...
...
@@ 71,7 +71,7 @@ public:
* curve.
*
* regularized part:
*  low saturation:
extend the \f$\mathrm{p_c(S_w)}\f$ curve with the slope at the regularization point (i.e. no kink).
*  low saturation: extend the \f$\mathrm{p_c(S_w)}\f$ curve with the slope at the regularization point (i.e. no kink).
*  high saturation: connect the high regularization point with \f$\mathrm{\overline{S}_w =1}\f$
* by a straight line (yes, there is a kink :( ).
*
...
...
@@ 395,7 +395,7 @@ public:
/*!
* \brief The relative permeability for a phase.
* \param params Array of parameters.
* \param phaseIdx
i
ndicator, The saturation of all phases.
* \param phaseIdx
I
ndicator, The saturation of all phases.
* \param swe Effective wetting phase saturation
* \param sn Absolute nonwetting liquid saturation
* \param ste Effective total liquid (wetting + nonwetting) saturation
...
...
dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh
View file @
3aae3506
...
...
@@ 111,10 +111,10 @@ public:
*
* \param sw The saturation of the wetting phase
* \param sn The saturation of the nonwetting phase
* \param lambdaW
t
he thermal conductivity of the water phase in \f$\mathrm{[W/(m K)]}\f$
* \param lambdaN
t
he thermal conductivity of the NAPL phase in \f$\mathrm{[W/(m K)]}\f$
* \param lambdaG
t
he thermal conductivity of the gas phase in \f$\mathrm{[W/(m K)]}\f$
* \param lambdaSolid
t
he thermal conductivity of the solid phase in \f$\mathrm{[W/(m K)]}\f$
* \param lambdaW
T
he thermal conductivity of the water phase in \f$\mathrm{[W/(m K)]}\f$
* \param lambdaN
T
he thermal conductivity of the NAPL phase in \f$\mathrm{[W/(m K)]}\f$
* \param lambdaG
T
he thermal conductivity of the gas phase in \f$\mathrm{[W/(m K)]}\f$
* \param lambdaSolid
T
he thermal conductivity of the solid phase in \f$\mathrm{[W/(m K)]}\f$
* \param porosity The porosity
*
* \return effective thermal conductivity \f$\mathrm{[W/(m K)]}\f$ after Somerton (1974)
...
...
@@ 133,9 +133,6 @@ public:
const
Scalar
satW
=
max
<
Scalar
>
(
0.0
,
sw
);
const
Scalar
satN
=
max
<
Scalar
>
(
0.0
,
sn
);
// const Scalar lSw = 1.8; //pow(lambdaSolid, (1.0  porosity)) * pow(lambdaW, porosity);
// const Scalar lSn = 0.65; //pow(lambdaSolid, (1.0  porosity)) * pow(lambdaN, porosity);
// const Scalar lSg = 0.35; //pow(lambdaSolid, (1.0  porosity)) * pow(lambdaG, porosity);
// porosity weighted geometric mean
const
Scalar
lSw
=
pow
(
lambdaSolid
,
(
1.0

porosity
))
*
pow
(
lambdaW
,
porosity
);
const
Scalar
lSn
=
pow
(
lambdaSolid
,
(
1.0

porosity
))
*
pow
(
lambdaN
,
porosity
);
...
...
dumux/material/fluidmatrixinteractions/mp/mpadapter.hh
View file @
3aae3506
...
...
@@ 74,7 +74,7 @@ public:
* \param values Container for the return values
* \param params Array of parameters
* \param state Fluidstate
* \param wPhaseIdx
t
he phase index of the wetting phase
* \param wPhaseIdx
T
he phase index of the wetting phase
*/
template
<
class
ContainerT
,
class
FluidState
>
static
void
relativePermeabilities
(
ContainerT
&
values
,
...
...
dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh
View file @
3aae3506
...
...
@@ 82,7 +82,7 @@ public:
* \param values Container for the return values
* \param params Array of Parameters
* \param state The fluid state
* \param wPhaseIdx
t
he phase index of the wetting phase
* \param wPhaseIdx
T
he phase index of the wetting phase
*/
template
<
class
ContainerT
,
class
FluidState
>
static
void
relativePermeabilities
(
ContainerT
&
values
,
...
...
dumux/material/fluidmatrixinteractions/mp/mplinearmaterialparams.hh
View file @
3aae3506
...
...
@@ 67,7 +67,7 @@ public:
/*!
* \brief Set the capillary pressure in \f$\mathrm{[Pa]}\f$ for a phase \f$\mathrm{\alpha}\f$ at \f$\mathrm{S_\alpha=0}\f$.
* \param phaseIdx Index of the phase
* \param val
v
alue of the capillary pressure
* \param val
V
alue of the capillary pressure
*/
void
setPcMinSat
(
int
phaseIdx
,
Scalar
val
)
{
pcMinSat_
[
phaseIdx
]
=
val
;
}
...
...
@@ 82,7 +82,7 @@ public:
/*!
* \brief Set the capillary pressure in \f$\mathrm{[Pa]}\f$ for a phase \f$\mathrm{\alpha}\f$ at \f$\mathrm{S_\alpha=1}\f$.
* \param phaseIdx Index of the phase
* \param val
v
alue of the capillary pressure
* \param val
V
alue of the capillary pressure
*/
void
setPcMaxSat
(
int
phaseIdx
,
Scalar
val
)
{
pcMaxSat_
[
phaseIdx
]
=
val
;
}
...
...
dumux/material/fluidmatrixinteractions/permeabilitykozenycarman.hh
View file @
3aae3506
...
...
@@ 42,7 +42,7 @@ class PermeabilityKozenyCarman
{
public:
/*!
* \brief
c
alculates the permeability for a given subcontrol volume
* \brief
C
alculates the permeability for a given subcontrol volume
* \param refPerm Reference permeability before porosity changes
* \param refPoro The poro corresponding to the reference permeability
* \param poro The porosity for which permeability is to be evaluated
...
...
dumux/material/fluidmatrixinteractions/porosityprecipitation.hh
View file @
3aae3506
...
...
@@ 42,9 +42,9 @@ class PorosityPrecipitation
public:
/*!
* \brief Calculates the porosity in a subcontrol volume
* \param element
e
lement
* \param elemSol
t
he element solution
* \param scv
s
ub control volume
* \param element
E
lement
* \param elemSol
T
he element solution
* \param scv
S
ub control volume
* \param refPoro The solid matrix porosity without precipitates
* \param minPoro A minimum porosity value
*/
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment