Dumux::TwoPTestSpatialParams< GridGeometry, Scalar > Class Template Reference

The spatial params for the incompressible 2p test. More...

#include <test/porousmediumflow/2p/implicit/boxdfm/spatialparams.hh>

Inheritance diagram for Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >:

Description

template<class GridGeometry, class Scalar>
class Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >

The spatial params for the incompressible 2p test.

Public Types
using	MaterialLaw = EffToAbsLaw< RegularizedBrooksCorey< Scalar > >
using	MaterialLawParams = typename MaterialLaw::Params
using	PermeabilityType = Scalar
using	MaterialLaw = EffToAbsLaw< EffectiveLaw >
using	MaterialLawParams = typename MaterialLaw::Params
using	PermeabilityType = Scalar

Public Member Functions
	TwoPTestSpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)
template<class ElementSolution >
PermeabilityType	permeability (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Function for defining the (intrinsic) permeability \([m^2]\). In this test, we use element-wise distributed permeabilities. More...
template<class ElementSolution >
Scalar	porosity (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Returns the porosity \([-]\). More...
template<class ElementSolution >
const MaterialLawParams &	materialLawParams (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Returns the parameter object for the Brooks-Corey material law. More...
template<class FluidSystem >
int	wettingPhaseAtPos (const GlobalPosition &globalPos) const
	Function for defining which phase is to be considered as the wetting phase. More...
template<class SolutionVector >
void	updateMaterialInterfaceParams (const SolutionVector &x)
	Updates the map of which material parameters are associated with a nodal dof. More...
const BoxMaterialInterfaceParams< ThisType > &	materialInterfaceParams () const
	Returns the material parameters associated with a nodal dof. More...
	TwoPTestSpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)
template<class ElementSolution >
PermeabilityType	permeability (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Function for defining the (intrinsic) permeability \([m^2]\). In this test, we use element-wise distributed permeabilities. More...
Scalar	porosityAtPos (const GlobalPosition &globalPos) const
	Returns the porosity \([-]\). More...
template<class ElementSolution >
const MaterialLawParams &	materialLawParams (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Returns the parameter object for the Brooks-Corey material law. More...
template<class FluidSystem >
int	wettingPhaseAtPos (const GlobalPosition &globalPos) const
	Function for defining which phase is to be considered as the wetting phase. More...
template<class SolutionVector >
void	updateMaterialInterfaceParams (const SolutionVector &x)
	Updates the map of which material parameters are associated with a nodal dof. More...
const BoxMaterialInterfaceParams< ThisType > &	materialInterfaceParams () const
	Returns the material parameters associated with a nodal dof. More...
bool	lensIsOilWet () const
	Returns whether or not the lens is oil wet. More...
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...
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 GridGeometry &	fvGridGeometry () const
	The finite volume grid geometry. More...
const GridGeometry &	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
TwoPTestSpatialParams< GridGeometry, Scalar > &	asImp_ ()
const TwoPTestSpatialParams< GridGeometry, Scalar > &	asImp_ () const

Member Typedef Documentation

MaterialLaw [1/2]

template<class GridGeometry , class Scalar >

using Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::MaterialLaw = EffToAbsLaw< RegularizedBrooksCorey<Scalar> >

MaterialLaw [2/2]

template<class GridGeometry , class Scalar >

using Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::MaterialLaw = EffToAbsLaw<EffectiveLaw>

MaterialLawParams [1/2]

template<class GridGeometry , class Scalar >

using Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::MaterialLawParams = typename MaterialLaw::Params

MaterialLawParams [2/2]

template<class GridGeometry , class Scalar >

using Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::MaterialLawParams = typename MaterialLaw::Params

PermeabilityType [1/2]

template<class GridGeometry , class Scalar >

using Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::PermeabilityType = Scalar

PermeabilityType [2/2]

template<class GridGeometry , class Scalar >

using Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::PermeabilityType = Scalar

Constructor & Destructor Documentation

TwoPTestSpatialParams() [1/2]

template<class GridGeometry , class Scalar >

Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::TwoPTestSpatialParams ( std::shared_ptr< const GridGeometry >  gridGeometry )

inline

TwoPTestSpatialParams() [2/2]

template<class GridGeometry , class Scalar >

Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::TwoPTestSpatialParams ( std::shared_ptr< const GridGeometry >  gridGeometry )

inline

Member Function Documentation

asImp_() [1/2]

TwoPTestSpatialParams< GridGeometry, Scalar > & Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TwoPTestSpatialParams< GridGeometry, Scalar > >::asImp_ ( )

inlineprotectedinherited

asImp_() [2/2]

const TwoPTestSpatialParams< GridGeometry, Scalar > & Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TwoPTestSpatialParams< GridGeometry, Scalar > >::asImp_ ( ) const

inlineprotectedinherited

beaversJosephCoeffAtPos()

Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TwoPTestSpatialParams< GridGeometry, Scalar > >::beaversJosephCoeffAtPos ( const GlobalPosition &  globalPos ) const

inlineinherited

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

Returns

Beavers-Joseph coefficient \(\mathrm{[-]}\)

Parameters

globalPos

The global position

evaluatePermeabilityAtScvfIP()

static constexpr bool Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TwoPTestSpatialParams< GridGeometry, 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< GridGeometry, Scalar, TwoPTestSpatialParams< GridGeometry, Scalar > >::forchCoeff ( const SubControlVolumeFace &  scvf ) const

inlineinherited

Apply the Forchheimer coefficient for inertial forces calculation.

Parameters

scvf	The sub-control volume face where the intrinsic velocity ought to be calculated.

fvGridGeometry()

const GridGeometry & Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TwoPTestSpatialParams< GridGeometry, Scalar > >::fvGridGeometry ( ) const

inlineinherited

The finite volume grid geometry.

gravity()

const GlobalPosition & Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TwoPTestSpatialParams< GridGeometry, 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

pos	the spatial position at which to evaulate the gravity vector

gridGeometry()

const GridGeometry & Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TwoPTestSpatialParams< GridGeometry, Scalar > >::gridGeometry ( ) const

inlineinherited

The finite volume grid geometry.

harmonicMean() [1/2]

DimWorldMatrix Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TwoPTestSpatialParams< GridGeometry, 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

T1	first tensor
T2	second tensor
normal	The unit normal vector of the interface

harmonicMean() [2/2]

Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TwoPTestSpatialParams< GridGeometry, 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

T1	first scalar parameter
T2	second scalar parameter
normal	The unit normal vector of the interface

inertVolumeFraction() [1/3]

Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TwoPTestSpatialParams< GridGeometry, 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

element	The current element
scv	The sub-control volume inside the element.
elemSol	The solution at the dofs connected to the element.
compIdx	The 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< GridGeometry, Scalar, TwoPTestSpatialParams< GridGeometry, Scalar > >::inertVolumeFraction ( const Element &  element, const SubControlVolume &  scv, const ElementSolution &  elemSol, int  compIdx  ) const

inlineinherited

inertVolumeFraction() [3/3]

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

inlineinherited

lensIsOilWet()

template<class GridGeometry , class Scalar >

bool Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::lensIsOilWet ( ) const

inline

Returns whether or not the lens is oil wet.

materialInterfaceParams() [1/2]

template<class GridGeometry , class Scalar >

const BoxMaterialInterfaceParams< ThisType > & Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::materialInterfaceParams ( ) const

inline

Returns the material parameters associated with a nodal dof.

materialInterfaceParams() [2/2]

template<class GridGeometry , class Scalar >

const BoxMaterialInterfaceParams< ThisType > & Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::materialInterfaceParams ( ) const

inline

Returns the material parameters associated with a nodal dof.

materialLawParams() [1/3]

decltype(auto) Dumux::FVSpatialParams< GridGeometry, Scalar, TwoPTestSpatialParams< GridGeometry, 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

element	The current element
scv	The sub-control volume inside the element.
elemSol	The solution at the dofs connected to the element.

Returns

the material parameters object

materialLawParams() [2/3]

template<class GridGeometry , class Scalar >

template<class ElementSolution >

const MaterialLawParams & Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::materialLawParams ( const Element &  element, const SubControlVolume &  scv, const ElementSolution &  elemSol  ) const

inline

Returns the parameter object for the Brooks-Corey material law.

In this test, we use element-wise distributed material parameters.

Parameters

element	The current element
scv	The sub-control volume inside the element.
elemSol	The solution at the dofs connected to the element.

Returns

The material parameters object

materialLawParams() [3/3]

template<class GridGeometry , class Scalar >

template<class ElementSolution >

const MaterialLawParams & Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::materialLawParams ( const Element &  element, const SubControlVolume &  scv, const ElementSolution &  elemSol  ) const

inline

Returns the parameter object for the Brooks-Corey material law.

In this test, we use element-wise distributed material parameters.

Parameters

element	The current element
scv	The sub-control volume inside the element.
elemSol	The solution at the dofs connected to the element.

Returns

The material parameters object

permeability() [1/3]

decltype(auto) Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TwoPTestSpatialParams< GridGeometry, 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

element	The current element
scv	The sub-control volume inside the element.
elemSol	The solution at the dofs connected to the element.

Returns

permeability

permeability() [2/3]

template<class GridGeometry , class Scalar >

template<class ElementSolution >

PermeabilityType Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::permeability ( const Element &  element, const SubControlVolume &  scv, const ElementSolution &  elemSol  ) const

inline

Function for defining the (intrinsic) permeability \([m^2]\). In this test, we use element-wise distributed permeabilities.

Parameters

element	The current element
scv	The sub-control volume inside the element.
elemSol	The solution at the dofs connected to the element.

Returns

The permeability

permeability() [3/3]

template<class GridGeometry , class Scalar >

template<class ElementSolution >

PermeabilityType Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::permeability ( const Element &  element, const SubControlVolume &  scv, const ElementSolution &  elemSol  ) const

inline

Function for defining the (intrinsic) permeability \([m^2]\). In this test, we use element-wise distributed permeabilities.

Parameters

element	The current element
scv	The sub-control volume inside the element.
elemSol	The solution at the dofs connected to the element.

Returns

The permeability

porosity() [1/2]

Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TwoPTestSpatialParams< GridGeometry, 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

element	The current element
scv	The sub-control volume inside the element.
elemSol	The solution at the dofs connected to the element.

Returns

the porosity

porosity() [2/2]

template<class GridGeometry , class Scalar >

template<class ElementSolution >

Scalar Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::porosity ( const Element &  element, const SubControlVolume &  scv, const ElementSolution &  elemSol  ) const

inline

Returns the porosity \([-]\).

Parameters

element	The current element
scv	The sub-control volume inside the element.
elemSol	The solution at the dofs connected to the element.

Returns

The porosity

porosityAtPos()

template<class GridGeometry , class Scalar >

Scalar Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::porosityAtPos ( const GlobalPosition &  globalPos ) const

inline

Returns the porosity \([-]\).

Parameters

globalPos

The global position

updateMaterialInterfaceParams() [1/2]

template<class GridGeometry , class Scalar >

template<class SolutionVector >

void Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::updateMaterialInterfaceParams ( const SolutionVector &  x )

inline

Updates the map of which material parameters are associated with a nodal dof.

updateMaterialInterfaceParams() [2/2]

template<class GridGeometry , class Scalar >

template<class SolutionVector >

void Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::updateMaterialInterfaceParams ( const SolutionVector &  x )

inline

Updates the map of which material parameters are associated with a nodal dof.

wettingPhase()

int Dumux::FVSpatialParams< GridGeometry, Scalar, TwoPTestSpatialParams< GridGeometry, 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

element	The current element
scv	The sub-control volume inside the element.
elemSol	The solution at the dofs connected to the element.

Returns

the wetting phase index

wettingPhaseAtPos() [1/2]

template<class GridGeometry , class Scalar >

template<class FluidSystem >

int Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::wettingPhaseAtPos ( const GlobalPosition &  globalPos ) const

inline

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

Parameters

globalPos

The global position

Returns

The wetting phase index

wettingPhaseAtPos() [2/2]

template<class GridGeometry , class Scalar >

template<class FluidSystem >

int Dumux::TwoPTestSpatialParams< GridGeometry, Scalar >::wettingPhaseAtPos ( const GlobalPosition &  globalPos ) const

inline

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

Parameters

globalPos

The global position

Returns

The wetting phase index

---

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

• porousmediumflow/2p/implicit/boxdfm/spatialparams.hh
• porousmediumflow/2p/implicit/incompressible/spatialparams.hh