3.1-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Dumux::SalinizationSpatialParams< FVGridGeometry, Scalar > Class Template Reference

Spatial parameters for the salinization problem, where evaporation from a porous medium saturated wit brine and air leads to precipitation of salt. More...

#include <test/porousmediumflow/2pncmin/implicit/nonisothermal/spatialparams.hh>

Inheritance diagram for Dumux::SalinizationSpatialParams< FVGridGeometry, Scalar >:
Inheritance graph

Description

template<class FVGridGeometry, class Scalar>
class Dumux::SalinizationSpatialParams< FVGridGeometry, Scalar >

Spatial parameters for the salinization problem, where evaporation from a porous medium saturated wit brine and air leads to precipitation of salt.

Public Types

using PermeabilityType = Scalar
 
using MaterialLaw = EffToAbsLaw< EffectiveLaw >
 Export the material law type used. More...
 
using MaterialLawParams = typename MaterialLaw::Params
 

Public Member Functions

 SalinizationSpatialParams (std::shared_ptr< const FVGridGeometry > fvGridGeometry)
 
Scalar minimalPorosity (const Element &element, const SubControlVolume &scv) const
 Defines the minimum porosity \([-]\) distribution. More...
 
template<class SolidSystem >
Scalar inertVolumeFractionAtPos (const GlobalPosition &globalPos, int compIdx) const
 Defines the volume fraction of the inert component. More...
 
Scalar referencePorosity (const Element &element, const SubControlVolume &scv) const
 Defines the reference porosity \([-]\) distribution. More...
 
template<class ElementSolution >
PermeabilityType permeability (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
 
Scalar solubilityLimit () const
 
Scalar theta (const SubControlVolume &scv) const
 
const MaterialLawParamsmaterialLawParamsAtPos (const GlobalPosition &globalPos) const
 
template<class FluidSystem >
int wettingPhaseAtPos (const GlobalPosition &globalPos) const
 
decltype(auto) materialLawParams (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
 Function for defining the parameters needed by constitutive relationships (kr-sw, pc-sw, etc.). More...
 
int wettingPhase (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
 Function for defining which phase is to be considered as the wetting phase. More...
 
int wettingPhaseAtPos (const GlobalPosition &globalPos) const
 Function for defining which phase is to be considered as the wetting phase. More...
 
const GlobalPosition & gravity (const GlobalPosition &pos) const
 Returns the acceleration due to gravity \(\mathrm{[m/s^2]}\). More...
 
Scalar harmonicMean (const Scalar T1, const Scalar T2, const GlobalPosition &normal) const
 Harmonic average of a discontinuous scalar field at discontinuity interface (for compatibility reasons with the function below) More...
 
DimWorldMatrix harmonicMean (const DimWorldMatrix &T1, const DimWorldMatrix &T2, const GlobalPosition &normal) const
 Harmonic average of a discontinuous tensorial field at discontinuity interface. More...
 
decltype(auto) permeability (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
 Function for defining the (intrinsic) permeability \([m^2]\). More...
 
Scalar porosity (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
 Function for defining the porosity. That is possibly solution dependent. More...
 
Scalar inertVolumeFraction (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol, int compIdx) const
 Function for defining the solid volume fraction. That is possibly solution dependent. More...
 
Scalar inertVolumeFraction (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol, int compIdx) const
 
Scalar inertVolumeFraction (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol, int compIdx) const
 
Scalar beaversJosephCoeffAtPos (const GlobalPosition &globalPos) const
 Function for defining the Beavers-Joseph coefficient for multidomain problems \(\mathrm{[-]}\). More...
 
Scalar forchCoeff (const SubControlVolumeFace &scvf) const
 Apply the Forchheimer coefficient for inertial forces calculation. More...
 
const FVGridGeometry & fvGridGeometry () const
 The finite volume grid geometry. More...
 
const FVGridGeometry & gridGeometry () const
 The finite volume grid geometry. More...
 

Static Public Member Functions

static constexpr bool evaluatePermeabilityAtScvfIP ()
 If the permeability should be evaluated directly at the scvf integration point (for convergence tests with analytical and continuous perm functions) or is evaluated at the scvs (for permeability fields with discontinuities) -> default. More...
 

Protected Member Functions

SalinizationSpatialParams< FVGridGeometry, Scalar > & asImp_ ()
 
const SalinizationSpatialParams< FVGridGeometry, Scalar > & asImp_ () const
 

Member Typedef Documentation

◆ MaterialLaw

template<class FVGridGeometry , class Scalar >
using Dumux::SalinizationSpatialParams< FVGridGeometry, Scalar >::MaterialLaw = EffToAbsLaw<EffectiveLaw>

Export the material law type used.

◆ MaterialLawParams

template<class FVGridGeometry , class Scalar >
using Dumux::SalinizationSpatialParams< FVGridGeometry, Scalar >::MaterialLawParams = typename MaterialLaw::Params

◆ PermeabilityType

template<class FVGridGeometry , class Scalar >
using Dumux::SalinizationSpatialParams< FVGridGeometry, Scalar >::PermeabilityType = Scalar

Constructor & Destructor Documentation

◆ SalinizationSpatialParams()

template<class FVGridGeometry , class Scalar >
Dumux::SalinizationSpatialParams< FVGridGeometry, Scalar >::SalinizationSpatialParams ( std::shared_ptr< const FVGridGeometry >  fvGridGeometry)
inline

Member Function Documentation

◆ asImp_() [1/2]

SalinizationSpatialParams< FVGridGeometry, Scalar > & Dumux::FVSpatialParamsOneP< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::asImp_ ( )
inlineprotectedinherited

◆ asImp_() [2/2]

const SalinizationSpatialParams< FVGridGeometry, Scalar > & Dumux::FVSpatialParamsOneP< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::asImp_ ( ) const
inlineprotectedinherited

◆ beaversJosephCoeffAtPos()

Scalar Dumux::FVSpatialParamsOneP< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::beaversJosephCoeffAtPos ( const GlobalPosition &  globalPos) const
inlineinherited

Function for defining the Beavers-Joseph coefficient for multidomain problems \(\mathrm{[-]}\).

Returns
Beavers-Joseph coefficient \(\mathrm{[-]}\)
Parameters
globalPosThe global position

◆ evaluatePermeabilityAtScvfIP()

static constexpr bool Dumux::FVSpatialParamsOneP< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::evaluatePermeabilityAtScvfIP ( )
inlinestaticconstexprinherited

If the permeability should be evaluated directly at the scvf integration point (for convergence tests with analytical and continuous perm functions) or is evaluated at the scvs (for permeability fields with discontinuities) -> default.

◆ forchCoeff()

Scalar Dumux::FVSpatialParamsOneP< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::forchCoeff ( const SubControlVolumeFace &  scvf) const
inlineinherited

Apply the Forchheimer coefficient for inertial forces calculation.

Parameters
scvfThe sub-control volume face where the intrinsic velocity ought to be calculated.

◆ fvGridGeometry()

const FVGridGeometry & Dumux::FVSpatialParamsOneP< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::fvGridGeometry ( ) const
inlineinherited

The finite volume grid geometry.

◆ gravity()

const GlobalPosition & Dumux::FVSpatialParamsOneP< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::gravity ( const GlobalPosition &  pos) const
inlineinherited

Returns the acceleration due to gravity \(\mathrm{[m/s^2]}\).

The default behaviour is a constant gravity vector; if the Problem.EnableGravity parameter is true, \(\boldsymbol{g} = ( 0,\dots,\ -9.81)^T \), else \(\boldsymbol{g} = ( 0,\dots, 0)^T \).

Parameters
posthe spatial position at which to evaulate the gravity vector

◆ gridGeometry()

const FVGridGeometry & Dumux::FVSpatialParamsOneP< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::gridGeometry ( ) const
inlineinherited

The finite volume grid geometry.

◆ harmonicMean() [1/2]

DimWorldMatrix Dumux::FVSpatialParamsOneP< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::harmonicMean ( const DimWorldMatrix &  T1,
const DimWorldMatrix &  T2,
const GlobalPosition &  normal 
) const
inlineinherited

Harmonic average of a discontinuous tensorial field at discontinuity interface.

Note
We do a harmonic average of the part normal to the interface (alpha*I) and an arithmetic average of the tangential part (T - alpha*I).
Returns
the averaged tensor
Parameters
T1first tensor
T2second tensor
normalThe unit normal vector of the interface

◆ harmonicMean() [2/2]

Scalar Dumux::FVSpatialParamsOneP< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::harmonicMean ( const Scalar  T1,
const Scalar  T2,
const GlobalPosition &  normal 
) const
inlineinherited

Harmonic average of a discontinuous scalar field at discontinuity interface (for compatibility reasons with the function below)

Returns
the averaged scalar
Parameters
T1first scalar parameter
T2second scalar parameter
normalThe unit normal vector of the interface

◆ inertVolumeFraction() [1/3]

Scalar Dumux::FVSpatialParamsOneP< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::inertVolumeFraction ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol,
int  compIdx 
) const
inlineinherited

Function for defining the solid volume fraction. That is possibly solution dependent.

Parameters
elementThe current element
scvThe sub-control volume inside the element.
elemSolThe solution at the dofs connected to the element.
compIdxThe solid component index
Returns
the volume fraction of the inert solid component with index compIdx
Note
this overload is enable if there is only one inert solid component and the user didn't choose to implement a inertVolumeFractionAtPos overload. It then forwards to the simpler porosity interface. With more than one solid components or active solid components (i.e. dissolution) please overload the more general inertVolumeFraction/inertVolumeFractionAtPos interface.

◆ inertVolumeFraction() [2/3]

Scalar Dumux::FVSpatialParamsOneP< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::inertVolumeFraction ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol,
int  compIdx 
) const
inlineinherited

◆ inertVolumeFraction() [3/3]

Scalar Dumux::FVSpatialParamsOneP< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::inertVolumeFraction ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol,
int  compIdx 
) const
inlineinherited

◆ inertVolumeFractionAtPos()

template<class FVGridGeometry , class Scalar >
template<class SolidSystem >
Scalar Dumux::SalinizationSpatialParams< FVGridGeometry, Scalar >::inertVolumeFractionAtPos ( const GlobalPosition &  globalPos,
int  compIdx 
) const
inline

Defines the volume fraction of the inert component.

Parameters
globalPosThe global position in the domain
compIdxThe index of the inert solid component

◆ materialLawParams()

decltype(auto) Dumux::FVSpatialParams< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::materialLawParams ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol 
) const
inlineinherited

Function for defining the parameters needed by constitutive relationships (kr-sw, pc-sw, etc.).

Parameters
elementThe current element
scvThe sub-control volume inside the element.
elemSolThe solution at the dofs connected to the element.
Returns
the material parameters object

◆ materialLawParamsAtPos()

template<class FVGridGeometry , class Scalar >
const MaterialLawParams & Dumux::SalinizationSpatialParams< FVGridGeometry, Scalar >::materialLawParamsAtPos ( const GlobalPosition &  globalPos) const
inline

◆ minimalPorosity()

template<class FVGridGeometry , class Scalar >
Scalar Dumux::SalinizationSpatialParams< FVGridGeometry, Scalar >::minimalPorosity ( const Element &  element,
const SubControlVolume &  scv 
) const
inline

Defines the minimum porosity \([-]\) distribution.

Parameters
elementThe finite element
scvThe sub-control volume

◆ permeability() [1/2]

decltype(auto) Dumux::FVSpatialParamsOneP< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::permeability ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol 
) const
inlineinherited

Function for defining the (intrinsic) permeability \([m^2]\).

Note
It is possibly solution dependent.
Parameters
elementThe current element
scvThe sub-control volume inside the element.
elemSolThe solution at the dofs connected to the element.
Returns
permeability

◆ permeability() [2/2]

template<class FVGridGeometry , class Scalar >
template<class ElementSolution >
PermeabilityType Dumux::SalinizationSpatialParams< FVGridGeometry, Scalar >::permeability ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol 
) const
inline

Intrinsic permeability tensor K \([m^2]\) depending on the position in the domain

Parameters
elementThe finite volume element
scvThe sub-control volume
elemSolThe element solution

Solution dependent permeability function

◆ porosity()

Scalar Dumux::FVSpatialParamsOneP< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::porosity ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol 
) const
inlineinherited

Function for defining the porosity. That is possibly solution dependent.

Note
this can only be used for solids with one inert component (see inertVolumeFraction for the more general interface)
Parameters
elementThe current element
scvThe sub-control volume inside the element.
elemSolThe solution at the dofs connected to the element.
Returns
the porosity

◆ referencePorosity()

template<class FVGridGeometry , class Scalar >
Scalar Dumux::SalinizationSpatialParams< FVGridGeometry, Scalar >::referencePorosity ( const Element &  element,
const SubControlVolume &  scv 
) const
inline

Defines the reference porosity \([-]\) distribution.

This is the porosity of the porous medium without any of the considered solid phases.

Parameters
elementThe finite element
scvThe sub-control volume

◆ solubilityLimit()

template<class FVGridGeometry , class Scalar >
Scalar Dumux::SalinizationSpatialParams< FVGridGeometry, Scalar >::solubilityLimit ( ) const
inline

◆ theta()

template<class FVGridGeometry , class Scalar >
Scalar Dumux::SalinizationSpatialParams< FVGridGeometry, Scalar >::theta ( const SubControlVolume &  scv) const
inline

◆ wettingPhase()

int Dumux::FVSpatialParams< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::wettingPhase ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol 
) const
inlineinherited

Function for defining which phase is to be considered as the wetting phase.

Parameters
elementThe current element
scvThe sub-control volume inside the element.
elemSolThe solution at the dofs connected to the element.
Returns
the wetting phase index

◆ wettingPhaseAtPos() [1/2]

int Dumux::FVSpatialParams< FVGridGeometry , Scalar, SalinizationSpatialParams< FVGridGeometry, Scalar > >::wettingPhaseAtPos ( const GlobalPosition &  globalPos) const
inlineinherited

Function for defining which phase is to be considered as the wetting phase.

Returns
the wetting phase index
Parameters
globalPosThe global position

◆ wettingPhaseAtPos() [2/2]

template<class FVGridGeometry , class Scalar >
template<class FluidSystem >
int Dumux::SalinizationSpatialParams< FVGridGeometry, Scalar >::wettingPhaseAtPos ( const GlobalPosition &  globalPos) const
inline

The documentation for this class was generated from the following file: