The spatial parameters class for the rough channel test. More...

#include <test/freeflow/shallowwater/roughchannel/spatialparams.hh>

Inheritance diagram for Dumux::RoughChannelSpatialParams< GridGeometry, Scalar, VolumeVariables >:

Description

template<class GridGeometry, class Scalar, class VolumeVariables>
class Dumux::RoughChannelSpatialParams< GridGeometry, Scalar, VolumeVariables >

The spatial parameters class for the rough channel test.

Public Member Functions
	RoughChannelSpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)

void	initFrictionLaw ()
	Initialize the FrictionLaw. More...

Scalar	gravity (const GlobalPosition &globalPos) const
	Define the gravitation. More...

Scalar	gravity () const
	Define the gravitation. More...

const FrictionLaw< VolumeVariables > &	frictionLaw (const Element &element, const SubControlVolume &scv) const
	Get the frictionLaw. More...

Scalar	bedSurface (const Element &element, const SubControlVolume &scv) const
	Define the bed surface. 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...

int	wettingPhaseAtPos (const GlobalPosition &globalPos) const
	Function for defining which phase is to be considered as the wetting phase. 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
RoughChannelSpatialParams< GridGeometry, Scalar, VolumeVariables > &	asImp_ ()

const RoughChannelSpatialParams< GridGeometry, Scalar, VolumeVariables > &	asImp_ () const

Constructor & Destructor Documentation

◆ RoughChannelSpatialParams()

template<class GridGeometry , class Scalar , class VolumeVariables >

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

inline

Member Function Documentation

◆ asImp_() [1/2]

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

inlineprotectedinherited

◆ asImp_() [2/2]

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

inlineprotectedinherited

◆ beaversJosephCoeffAtPos()

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

◆ bedSurface()

template<class GridGeometry , class Scalar , class VolumeVariables >

Scalar Dumux::RoughChannelSpatialParams< GridGeometry, Scalar, VolumeVariables >::bedSurface	(	const Element &	element,
		const SubControlVolume &	scv
	)		const

inline

Define the bed surface.

Parameters

element	The current element
scv	The sub-control volume inside the element.

Returns: The bed surface

◆ evaluatePermeabilityAtScvfIP()

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

◆ frictionLaw()

template<class GridGeometry , class Scalar , class VolumeVariables >

const FrictionLaw< VolumeVariables > & Dumux::RoughChannelSpatialParams< GridGeometry, Scalar, VolumeVariables >::frictionLaw	(	const Element &	element,
		const SubControlVolume &	scv
	)		const

inline

Get the frictionLaw.

Get the frictionLaw, which already includes the friction value.

Returns: frictionLaw

◆ fvGridGeometry()

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

inlineinherited

The finite volume grid geometry.

◆ gravity() [1/2]

template<class GridGeometry , class Scalar , class VolumeVariables >

Scalar Dumux::RoughChannelSpatialParams< GridGeometry, Scalar, VolumeVariables >::gravity ( ) const

inline

Define the gravitation.

Returns: gravity constant

◆ gravity() [2/2]

template<class GridGeometry , class Scalar , class VolumeVariables >

Scalar Dumux::RoughChannelSpatialParams< GridGeometry, Scalar, VolumeVariables >::gravity ( const GlobalPosition & globalPos ) const

inline

Define the gravitation.

Returns: gravity constant

◆ gridGeometry()

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

inlineinherited

The finite volume grid geometry.

◆ harmonicMean() [1/2]

DimWorldMatrix Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, RoughChannelSpatialParams< GridGeometry, Scalar, VolumeVariables > >::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, RoughChannelSpatialParams< GridGeometry, Scalar, VolumeVariables > >::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, RoughChannelSpatialParams< GridGeometry, Scalar, VolumeVariables > >::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, RoughChannelSpatialParams< GridGeometry, Scalar, VolumeVariables > >::inertVolumeFraction	(	const Element &	element,
		const SubControlVolume &	scv,
		const ElementSolution &	elemSol,
		int	compIdx
	)		const

inlineinherited

◆ inertVolumeFraction() [3/3]

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

inlineinherited

◆ initFrictionLaw()

template<class GridGeometry , class Scalar , class VolumeVariables >

void Dumux::RoughChannelSpatialParams< GridGeometry, Scalar, VolumeVariables >::initFrictionLaw ( )

inline

Initialize the FrictionLaw.

◆ materialLawParams()

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

◆ permeability()

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

◆ porosity()

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

◆ wettingPhase()

int Dumux::FVSpatialParams< GridGeometry, Scalar, RoughChannelSpatialParams< GridGeometry, Scalar, VolumeVariables > >::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()

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

globalPos The global position

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

freeflow/shallowwater/roughchannel/spatialparams.hh

Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

◆ RoughChannelSpatialParams()

Member Function Documentation

◆ asImp_() [1/2]

◆ asImp_() [2/2]

◆ beaversJosephCoeffAtPos()

◆ bedSurface()

◆ evaluatePermeabilityAtScvfIP()

◆ forchCoeff()

◆ frictionLaw()

◆ fvGridGeometry()

◆ gravity() [1/2]

◆ gravity() [2/2]

◆ gridGeometry()

◆ harmonicMean() [1/2]

◆ harmonicMean() [2/2]

◆ inertVolumeFraction() [1/3]

◆ inertVolumeFraction() [2/3]

◆ inertVolumeFraction() [3/3]

◆ initFrictionLaw()

◆ materialLawParams()

◆ permeability()

◆ porosity()

◆ wettingPhase()

◆ wettingPhaseAtPos()