The base class for spatial parameters of porous-medium problems.

#include <dumux/common/fvporousmediumspatialparams.hh>

Inheritance diagram for Dumux::FVPorousMediumSpatialParams< GridGeometry, Scalar, Implementation >:

Public Member Functions
	FVPorousMediumSpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)
template<class ElementSolution>
Scalar	porosity (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Function for defining the porosity. That is possibly solution dependent.
template<class IpData, class ElementSolution>
Scalar	porosity (const FVElementGeometry &fvGeometry, const IpData &ipData, const ElementSolution &elemSol) const
	Function for defining the porosity at an interpolation point, for degrees of freedom that own no sub-control volume.
template<class SolidSystem, class ElementSolution, typename std::enable_if_t< SolidSystem::isInert() &&SolidSystem::numInertComponents==1 &&!decltype(isValid(Detail::hasInertVolumeFractionAtPos< GlobalPosition, SolidSystem >())(std::declval< Implementation >()))::value, int > = 0>
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.
template<class SolidSystem, class IpData, class ElementSolution>
Scalar	inertVolumeFraction (const FVElementGeometry &fvGeometry, const IpData &ipData, const ElementSolution &elemSol, int compIdx) const
	Function for defining the solid volume fraction. That is possibly solution dependent.
template<class SolidSystem, class ElementSolution, typename std::enable_if_t< SolidSystem::numInertComponents==0, int > = 0>
Scalar	inertVolumeFraction (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol, int compIdx) const
template<class SolidSystem, class IpData, class ElementSolution>
Scalar	inertVolumeFraction (const FVElementGeometry &fvGeometry, const IpData &ipData, const ElementSolution &elemSol, int compIdx) const
	Function for defining the solid volume fraction. That is possibly solution dependent.
template<class SolidSystem, class ElementSolution, typename std::enable_if_t<(SolidSystem::numInertComponents > 1)\|\|((SolidSystem::numInertComponents > 0) &&(!SolidSystem::isInert()\|\|decltype(isValid(Detail::hasInertVolumeFractionAtPos< GlobalPosition, SolidSystem >())(std::declval< Implementation >()))::value)), int > = 0>
Scalar	inertVolumeFraction (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol, int compIdx) const
template<class SolidSystem, class IpData, class ElementSolution>
Scalar	inertVolumeFraction (const FVElementGeometry &fvGeometry, const IpData &ipData, const ElementSolution &elemSol, int compIdx) const
	Function for defining the solid volume fraction. That is possibly solution dependent.
template<class IpData, class ElementSolution>
Scalar	extrusionFactor (const FVElementGeometry &fvGeometry, const IpData &ipData, const ElementSolution &elemSol) const
	Return how much the domain is extruded at an integration point.
template<class ElementSolution>
Scalar	extrusionFactor (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Return how much the domain is extruded at a given sub-control volume.
Scalar	extrusionFactorAtPos (const GlobalPosition &globalPos) const
	Return how much the domain is extruded at a given position.
template<class IpData, class ElementSolution>
Scalar	temperature (const FVElementGeometry &fvGeometry, const IpData &ipData, const ElementSolution &elemSol) const
	Return the temperature at an integration point.
template<class ElementSolution>
Scalar	temperature (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Return the temperature in the given sub-control volume.
Scalar	temperatureAtPos (const GlobalPosition &globalPos) const
	Return the temperature in the domain at the given position.
const GravityVector &	gravity (const GlobalPosition &pos) const
	Returns the acceleration due to gravity \(\mathrm{[m/s^2]}\).
const GridGeometry &	gridGeometry () const
	The finite volume grid geometry.

Protected Member Functions
Implementation &	asImp_ ()
	Returns the implementation of the spatial parameters (static polymorphism).
const Implementation &	asImp_ () const
	Returns the implementation of the spatial parameters (static polymorphism).

Constructor & Destructor Documentation

◆ FVPorousMediumSpatialParams()

template<class GridGeometry, class Scalar, class Implementation>

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

inline

Member Function Documentation

◆ asImp_() [1/2]

template<class GridGeometry, class Scalar, class Implementation>

Implementation & Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::asImp_ ( )

inlineprotectedinherited

◆ asImp_() [2/2]

template<class GridGeometry, class Scalar, class Implementation>

const Implementation & Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::asImp_ ( ) const

inlineprotectedinherited

◆ extrusionFactor() [1/2]

template<class GridGeometry, class Scalar, class Implementation>

template<class ElementSolution>

Scalar Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::extrusionFactor	(	const Element &	element,
		const SubControlVolume &	scv,
		const ElementSolution &	elemSol ) const

inlineinherited

This means the factor by which a lower-dimensional (1D or 2D) entity needs to be expanded to get a full dimensional cell. The default is 1.0 which means that 1D problems are actually thought as pipes with a cross section of 1 m^2 and 2D problems are assumed to extend 1 m to the back.

◆ extrusionFactor() [2/2]

template<class GridGeometry, class Scalar, class Implementation>

template<class IpData, class ElementSolution>

Scalar Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::extrusionFactor	(	const FVElementGeometry &	fvGeometry,
		const IpData &	ipData,
		const ElementSolution &	elemSol ) const

inlineinherited

This means the factor by which a lower-dimensional (1D or 2D) entity needs to be expanded to get a full dimensional cell. The default is 1.0 which means that 1D problems are actually thought as pipes with a cross section of 1 m^2 and 2D problems are assumed to extend 1 m to the back.

◆ extrusionFactorAtPos()

template<class GridGeometry, class Scalar, class Implementation>

Scalar Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::extrusionFactorAtPos ( const GlobalPosition & globalPos ) const

inlineinherited

◆ gravity()

template<class GridGeometry, class Scalar, class Implementation>

const GravityVector & Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::gravity ( const GlobalPosition & pos ) const

inlineinherited

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 evaluate the gravity vector

◆ gridGeometry()

template<class GridGeometry, class Scalar, class Implementation>

const GridGeometry & Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::gridGeometry ( ) const

inlineinherited

◆ inertVolumeFraction() [1/6]

template<class GridGeometry, class Scalar, class Implementation>

template<class SolidSystem, class ElementSolution, typename std::enable_if_t<(SolidSystem::numInertComponents > 1)||((SolidSystem::numInertComponents > 0) &&(!SolidSystem::isInert()||decltype(isValid(Detail::hasInertVolumeFractionAtPos< GlobalPosition, SolidSystem >())(std::declval< Implementation >()))::value)), int > = 0>

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

inline

◆ inertVolumeFraction() [2/6]

template<class GridGeometry, class Scalar, class Implementation>

template<class SolidSystem, class ElementSolution, typename std::enable_if_t< SolidSystem::numInertComponents==0, int > = 0>

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

inline

◆ inertVolumeFraction() [3/6]

template<class GridGeometry, class Scalar, class Implementation>

template<class SolidSystem, class ElementSolution, typename std::enable_if_t< SolidSystem::isInert() &&SolidSystem::numInertComponents==1 &&!decltype(isValid(Detail::hasInertVolumeFractionAtPos< GlobalPosition, SolidSystem >())(std::declval< Implementation >()))::value, int > = 0>

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

inline

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() [4/6]

template<class GridGeometry, class Scalar, class Implementation>

template<class SolidSystem, class IpData, class ElementSolution>

Scalar Dumux::FVPorousMediumSpatialParams< GridGeometry, Scalar, Implementation >::inertVolumeFraction	(	const FVElementGeometry &	fvGeometry,
		const IpData &	ipData,
		const ElementSolution &	elemSol,
		int	compIdx ) const

inline

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() [5/6]

template<class GridGeometry, class Scalar, class Implementation>

template<class SolidSystem, class IpData, class ElementSolution>

Scalar Dumux::FVPorousMediumSpatialParams< GridGeometry, Scalar, Implementation >::inertVolumeFraction	(	const FVElementGeometry &	fvGeometry,
		const IpData &	ipData,
		const ElementSolution &	elemSol,
		int	compIdx ) const

inline

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() [6/6]

template<class GridGeometry, class Scalar, class Implementation>

template<class SolidSystem, class IpData, class ElementSolution>

Scalar Dumux::FVPorousMediumSpatialParams< GridGeometry, Scalar, Implementation >::inertVolumeFraction	(	const FVElementGeometry &	fvGeometry,
		const IpData &	ipData,
		const ElementSolution &	elemSol,
		int	compIdx ) const

inline

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.

◆ porosity() [1/2]

template<class GridGeometry, class Scalar, class Implementation>

template<class ElementSolution>

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

inline

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, class Implementation>

template<class IpData, class ElementSolution>

Scalar Dumux::FVPorousMediumSpatialParams< GridGeometry, Scalar, Implementation >::porosity	(	const FVElementGeometry &	fvGeometry,
		const IpData &	ipData,
		const ElementSolution &	elemSol ) const

inline

Parameters

fvGeometry	The finite-volume geometry
ipData	The interpolation point data
elemSol	The solution at the dofs connected to the element.

Returns: the porosity

◆ temperature() [1/2]

template<class GridGeometry, class Scalar, class Implementation>

template<class ElementSolution>

Scalar Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::temperature	(	const Element &	element,
		const SubControlVolume &	scv,
		const ElementSolution &	elemSol ) const

inlineinherited

◆ temperature() [2/2]

template<class GridGeometry, class Scalar, class Implementation>

template<class IpData, class ElementSolution>

Scalar Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::temperature	(	const FVElementGeometry &	fvGeometry,
		const IpData &	ipData,
		const ElementSolution &	elemSol ) const

inlineinherited

◆ temperatureAtPos()

template<class GridGeometry, class Scalar, class Implementation>

Scalar Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::temperatureAtPos ( const GlobalPosition & globalPos ) const

inlineinherited

Parameters

globalPos The position in global coordinates where the temperature should be specified.

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

fvporousmediumspatialparams.hh

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

◆ FVPorousMediumSpatialParams()

Member Function Documentation

◆ asImp_() [1/2]

◆ asImp_() [2/2]

◆ extrusionFactor() [1/2]

◆ extrusionFactor() [2/2]

◆ extrusionFactorAtPos()

◆ gravity()

◆ gridGeometry()

◆ inertVolumeFraction() [1/6]

◆ inertVolumeFraction() [2/6]

◆ inertVolumeFraction() [3/6]

◆ inertVolumeFraction() [4/6]

◆ inertVolumeFraction() [5/6]

◆ inertVolumeFraction() [6/6]

◆ porosity() [1/2]

◆ porosity() [2/2]

◆ temperature() [1/2]

◆ temperature() [2/2]

◆ temperatureAtPos()