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

The spatial parameters class for the test problem using the incompressible 1p model. More...

#include <test/multidomain/boundary/darcydarcy/1p_1p/spatialparams.hh>

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

Description

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

The spatial parameters class for the test problem using the incompressible 1p model.

The spatial parameters for the incompressible test.

The spatial parameters class for the test problem using the 1p box model.

The spatial params of the incompressible single-phase convergence test.

The spatial parameters class for the test problem using the compressible 1p model.

Public Types
using	PermeabilityType = Scalar
using	PermeabilityType = Scalar
using	PermeabilityType = Scalar
using	PermeabilityType = Scalar
using	PermeabilityType = Scalar
using	PermeabilityType = Scalar
using	PermeabilityType = Scalar
using	PermeabilityType = Scalar

Public Member Functions
	OnePTestSpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)
PermeabilityType	permeabilityAtPos (const GlobalPosition &globalPos) const
	Function for defining the (intrinsic) permeability $[m^2]$. More...
Scalar	porosityAtPos (const GlobalPosition &globalPos) const
	Defines the porosity $\mathrm{[-]}$. More...
void	setLens (const GlobalPosition &lowerLeft, const GlobalPosition &upperRight)
	Optionally set a lens. More...
	OnePTestSpatialParams (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]$. More...
Scalar	porosityAtPos (const GlobalPosition &globalPos) const
	Defines the porosity $\mathrm{[-]}$. More...
	OnePTestSpatialParams (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]$. More...
Scalar	porosityAtPos (const GlobalPosition &globalPos) const
	Defines the porosity $\mathrm{[-]}$. More...
	OnePTestSpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)
	The constructor. More...
PermeabilityType	permeabilityAtPos (const GlobalPosition &globalPos) const
	Function for defining the (intrinsic) permeability $[m^2]$. More...
Scalar	porosityAtPos (const GlobalPosition &globalPos) const
	Defines the porosity $\mathrm{[-]}$. More...
	OnePTestSpatialParams (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]$. More...
Scalar	porosityAtPos (const GlobalPosition &globalPos) const
	Defines the porosity $\mathrm{[-]}$. More...
	OnePTestSpatialParams (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]$. More...
Scalar	porosityAtPos (const GlobalPosition &globalPos) const
	Defines the porosity in [-]. More...
void	initRandomField (const GridGeometry &gg)
	This method allows the generation of a statistical field using gstat. More...
const std::vector< Scalar > &	getPermField () const
	get the permeability field for output More...
	OnePTestSpatialParams (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]$. More...
Scalar	porosityAtPos (const GlobalPosition &globalPos) const
	Defines the porosity $\mathrm{[-]}$. More...
	OnePTestSpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)
template<class ElementSolution >
const PermeabilityType &	permeability (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Function for defining the (intrinsic) permeability $[m^2]$. More...
Scalar	porosityAtPos (const GlobalPosition &globalPos) const
	Function for defining the porosity which is possibly solution dependent. More...
const std::vector< Scalar > &	getKField () const
	Reference to the k field. 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...
const GlobalPosition &	gravity (const GlobalPosition &pos) const
	Returns the acceleration due to gravity $\mathrm{[m/s^2]}$. More...
GetPropType< TypeTag, Properties::Scalar >	harmonicMean (const GetPropType< TypeTag, Properties::Scalar > T1, const GetPropType< TypeTag, Properties::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...
GetPropType< TypeTag, Properties::Scalar >	porosity (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Function for defining the porosity. That is possibly solution dependent. More...
GetPropType< TypeTag, Properties::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...
GetPropType< TypeTag, Properties::Scalar >	beaversJosephCoeffAtPos (const GlobalPosition &globalPos) const
	Function for defining the Beavers-Joseph coefficient for multidomain problems $\mathrm{[-]}$. More...
GetPropType< TypeTag, Properties::Scalar >	forchCoeff (const SubControlVolumeFace &scvf) const
	Apply the Forchheimer coefficient for inertial forces calculation. More...
const GetPropType< TypeTag, Properties::GridGeometry > &	fvGridGeometry () const
	The finite volume grid geometry. More...
const GetPropType< TypeTag, Properties::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...
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
OnePTestSpatialParams< GridGeometry, Scalar > &	asImp_ ()
const OnePTestSpatialParams< GridGeometry, Scalar > &	asImp_ () const
OnePTestSpatialParams< TypeTag > &	asImp_ ()
const OnePTestSpatialParams< TypeTag > &	asImp_ () const

Member Typedef Documentation

PermeabilityType [1/8]

template<class GridGeometry , class Scalar >

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

PermeabilityType [2/8]

template<class GridGeometry , class Scalar >

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

PermeabilityType [3/8]

template<class GridGeometry , class Scalar >

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

PermeabilityType [4/8]

template<class GridGeometry , class Scalar >

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

PermeabilityType [5/8]

template<class GridGeometry , class Scalar >

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

PermeabilityType [6/8]

template<class GridGeometry , class Scalar >

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

PermeabilityType [7/8]

template<class GridGeometry , class Scalar >

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

PermeabilityType [8/8]

template<class GridGeometry , class Scalar >

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

Constructor & Destructor Documentation

OnePTestSpatialParams() [1/8]

template<class GridGeometry , class Scalar >

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

inline

OnePTestSpatialParams() [2/8]

template<class GridGeometry , class Scalar >

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

inline

OnePTestSpatialParams() [3/8]

template<class GridGeometry , class Scalar >

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

inline

OnePTestSpatialParams() [4/8]

template<class GridGeometry , class Scalar >

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

inline

The constructor.

Parameters

gridGeometry

The finite-volume grid geometry

OnePTestSpatialParams() [5/8]

template<class GridGeometry , class Scalar >

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

inline

OnePTestSpatialParams() [6/8]

template<class GridGeometry , class Scalar >

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

inline

OnePTestSpatialParams() [7/8]

template<class GridGeometry , class Scalar >

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

inline

OnePTestSpatialParams() [8/8]

template<class GridGeometry , class Scalar >

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

inline

Member Function Documentation

asImp_() [1/4]

OnePTestSpatialParams< TypeTag > & Dumux::FVSpatialParamsOneP< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::Scalar > , OnePTestSpatialParams< TypeTag > >::asImp_ ( )

inlineprotectedinherited

asImp_() [2/4]

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

inlineprotectedinherited

asImp_() [3/4]

const OnePTestSpatialParams< TypeTag > & Dumux::FVSpatialParamsOneP< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::Scalar > , OnePTestSpatialParams< TypeTag > >::asImp_ ( ) const

inlineprotectedinherited

asImp_() [4/4]

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

inlineprotectedinherited

beaversJosephCoeffAtPos() [1/2]

GetPropType< TypeTag, Properties::Scalar > Dumux::FVSpatialParamsOneP< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::Scalar > , OnePTestSpatialParams< TypeTag > >::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

beaversJosephCoeffAtPos() [2/2]

Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, OnePTestSpatialParams< 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() [1/2]

static constexpr bool Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, OnePTestSpatialParams< 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.

evaluatePermeabilityAtScvfIP() [2/2]

static constexpr bool Dumux::FVSpatialParamsOneP< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::Scalar > , OnePTestSpatialParams< TypeTag > >::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() [1/2]

GetPropType< TypeTag, Properties::Scalar > Dumux::FVSpatialParamsOneP< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::Scalar > , OnePTestSpatialParams< TypeTag > >::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.

forchCoeff() [2/2]

Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, OnePTestSpatialParams< 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() [1/2]

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

inlineinherited

The finite volume grid geometry.

fvGridGeometry() [2/2]

const GetPropType< TypeTag, Properties::GridGeometry > & Dumux::FVSpatialParamsOneP< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::Scalar > , OnePTestSpatialParams< TypeTag > >::fvGridGeometry ( ) const

inlineinherited

The finite volume grid geometry.

getKField()

template<class GridGeometry , class Scalar >

const std::vector< Scalar > & Dumux::OnePTestSpatialParams< GridGeometry, Scalar >::getKField ( ) const

inline

Reference to the k field.

getPermField()

template<class GridGeometry , class Scalar >

const std::vector< Scalar > & Dumux::OnePTestSpatialParams< GridGeometry, Scalar >::getPermField ( ) const

inline

get the permeability field for output

gravity() [1/2]

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

gravity() [2/2]

const GlobalPosition & Dumux::FVSpatialParamsOneP< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::Scalar > , OnePTestSpatialParams< TypeTag > >::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() [1/2]

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

inlineinherited

The finite volume grid geometry.

gridGeometry() [2/2]

const GetPropType< TypeTag, Properties::GridGeometry > & Dumux::FVSpatialParamsOneP< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::Scalar > , OnePTestSpatialParams< TypeTag > >::gridGeometry ( ) const

inlineinherited

The finite volume grid geometry.

harmonicMean() [1/4]

DimWorldMatrix Dumux::FVSpatialParamsOneP< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::Scalar > , OnePTestSpatialParams< TypeTag > >::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/4]

DimWorldMatrix Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, OnePTestSpatialParams< 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() [3/4]

GetPropType< TypeTag, Properties::Scalar > Dumux::FVSpatialParamsOneP< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::Scalar > , OnePTestSpatialParams< TypeTag > >::harmonicMean ( const GetPropType< TypeTag, Properties::Scalar >  T1, const GetPropType< TypeTag, Properties::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

harmonicMean() [4/4]

Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, OnePTestSpatialParams< 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/4]

GetPropType< TypeTag, Properties::Scalar > Dumux::FVSpatialParamsOneP< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::Scalar > , OnePTestSpatialParams< TypeTag > >::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/4]

Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, OnePTestSpatialParams< 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() [3/4]

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

inlineinherited

inertVolumeFraction() [4/4]

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

inlineinherited

initRandomField()

template<class GridGeometry , class Scalar >

void Dumux::OnePTestSpatialParams< GridGeometry, Scalar >::initRandomField ( const GridGeometry &  gg )

inline

This method allows the generation of a statistical field using gstat.

Parameters

gg	The finite-volume grid geometry used by the problem

permeability() [1/8]

decltype(auto) Dumux::FVSpatialParamsOneP< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::Scalar > , OnePTestSpatialParams< TypeTag > >::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/8]

decltype(auto) Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, OnePTestSpatialParams< 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() [3/8]

template<class GridGeometry , class Scalar >

template<class ElementSolution >

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

inline

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

Parameters

element	The element
scv	The sub-control volume
elemSol	The element solution vector

Returns

The intrinsic permeability

permeability() [4/8]

template<class GridGeometry , class Scalar >

template<class ElementSolution >

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

inline

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

Parameters

element	The element
scv	The sub-control volume
elemSol	The element solution vector

Returns

The intrinsic permeability

permeability() [5/8]

template<class GridGeometry , class Scalar >

template<class ElementSolution >

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

inline

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

Parameters

element	The element
scv	The sub-control volume
elemSol	The element solution vector

Returns

The intrinsic permeability

permeability() [6/8]

template<class GridGeometry , class Scalar >

template<class ElementSolution >

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

inline

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

Parameters

element	The element
scv	The sub-control volume
elemSol	The element solution vector

Returns

The intrinsic permeability

permeability() [7/8]

template<class GridGeometry , class Scalar >

template<class ElementSolution >

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

inline

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

Parameters

element	The element
scv	The sub-control volume
elemSol	The element solution vector

Returns

the intrinsic permeability

permeability() [8/8]

template<class GridGeometry , class Scalar >

template<class ElementSolution >

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

inline

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

Parameters

element	The element
scv	The sub-control volume
elemSol	The element solution vector

Returns

the intrinsic permeability

permeabilityAtPos() [1/2]

template<class GridGeometry , class Scalar >

PermeabilityType Dumux::OnePTestSpatialParams< GridGeometry, Scalar >::permeabilityAtPos ( const GlobalPosition &  globalPos ) const

inline

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

Returns

The intrinsic permeability

permeabilityAtPos() [2/2]

template<class GridGeometry , class Scalar >

PermeabilityType Dumux::OnePTestSpatialParams< GridGeometry, Scalar >::permeabilityAtPos ( const GlobalPosition &  globalPos ) const

inline

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

Parameters

globalPos

The global position

porosity() [1/2]

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

GetPropType< TypeTag, Properties::Scalar > Dumux::FVSpatialParamsOneP< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::Scalar > , OnePTestSpatialParams< TypeTag > >::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

porosityAtPos() [1/8]

template<class GridGeometry , class Scalar >

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

inline

Defines the porosity $\mathrm{[-]}$.

Parameters

globalPos

The global position

porosityAtPos() [2/8]

template<class GridGeometry , class Scalar >

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

inline

Defines the porosity $\mathrm{[-]}$.

Parameters

globalPos

The global position

porosityAtPos() [3/8]

template<class GridGeometry , class Scalar >

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

inline

Defines the porosity $\mathrm{[-]}$.

Parameters

globalPos

The global position

porosityAtPos() [4/8]

template<class GridGeometry , class Scalar >

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

inline

Defines the porosity $\mathrm{[-]}$.

Parameters

globalPos

The global position

porosityAtPos() [5/8]

template<class GridGeometry , class Scalar >

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

inline

Defines the porosity $\mathrm{[-]}$.

Parameters

globalPos

The global position

porosityAtPos() [6/8]

template<class GridGeometry , class Scalar >

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

inline

Defines the porosity in [-].

Parameters

globalPos

The global position where we evaluate

porosityAtPos() [7/8]

template<class GridGeometry , class Scalar >

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

inline

Defines the porosity $\mathrm{[-]}$.

Parameters

globalPos

The global position

porosityAtPos() [8/8]

template<class GridGeometry , class Scalar >

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

inline

Function for defining the porosity which is possibly solution dependent.

Returns

the porosity

setLens()

template<class GridGeometry , class Scalar >

void Dumux::OnePTestSpatialParams< GridGeometry, Scalar >::setLens ( const GlobalPosition &  lowerLeft, const GlobalPosition &  upperRight  )

inline

Optionally set a lens.

---

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

• multidomain/boundary/darcydarcy/1p_1p/spatialparams.hh
• porousmediumflow/1p/implicit/compressible/instationary/spatialparams.hh
• porousmediumflow/1p/implicit/compressible/stationary/spatialparams.hh
• porousmediumflow/1p/implicit/convergence/spatialparams.hh
• porousmediumflow/1p/implicit/incompressible/spatialparams.hh
• porousmediumflow/1p/implicit/isothermal/spatialparams.hh
• porousmediumflow/1p/implicit/periodicbc/spatialparams.hh
• porousmediumflow/tracer/1ptracer/spatialparams_1p.hh