The base class for spatial parameters for pore network solid models.

#include <dumux/porenetwork/solidenergy/spatialparams.hh>

Inheritance diagram for Dumux::PoreNetwork::SolidEnergySpatialParams< FVGridGeometry, Scalar >:

Public Types
using	PermeabilityType = Scalar

Public Member Functions
Scalar	porosityAtPos (const GlobalPosition &globalPos) const
	Define the porosity \(\mathrm{[-]}\). More...

Scalar	throatLength (const Element &element, const ElementVolumeVariables &elemVolVars) const
	Length of the throat \([m]\). Can be solution-dependent. More...

Scalar	throatInscribedRadius (const Element &element, const ElementVolumeVariables &elemVolVars) const
	Inscribed radius of the throat \([m]\). Can be solution-dependent. More...

Scalar	throatCrossSectionalArea (const Element &element, const ElementVolumeVariables &elemVolVars) const
	Cross-sectional area of the throat \([m]\). Can be solution-dependent. More...

Scalar	poreInscribedRadius (const Element &element, const SubControlVolume &scv, const ElementSolutionVector &elemSol) const
	Inscribed radius of the pore body \([m]\). Can be solution-dependent. More...

const GridView &	gridView () const
	Returns a reference to the gridview. More...

Scalar	permeabilityAtPos (const GlobalPosition &globalPos) const
	Required for compatibility reasons with porous medium-flow models. More...

decltype(auto)	permeability (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Function for defining the (intrinsic) permeability \([m^2]\). More...

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...

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	extrusionFactor (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Return how much the domain is extruded at a given sub-control volume. More...

Scalar	extrusionFactorAtPos (const GlobalPosition &globalPos) const
	Return how much the domain is extruded at a given position. More...

Scalar	temperature (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Return the temperature in the given sub-control volume. More...

Scalar	temperatureAtPos (const GlobalPosition &globalPos) const
	Return the temperature in the domain at the given position. More...

const GravityVector &	gravity (const GlobalPosition &pos) const
	Returns the acceleration due to gravity \(\mathrm{[m/s^2]}\). 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
SolidEnergySpatialParams< FVGridGeometry, Scalar > &	asImp_ ()
	Returns the implementation of the spatial parameters (static polymorphism) More...

const SolidEnergySpatialParams< FVGridGeometry, Scalar > &	asImp_ () const
	Returns the implementation of the spatial parameters (static polymorphism) More...

Member Typedef Documentation

◆ PermeabilityType

template<class FVGridGeometry , class Scalar >

using Dumux::PoreNetwork::SolidEnergySpatialParams< FVGridGeometry, Scalar >::PermeabilityType = Scalar

Member Function Documentation

◆ asImp_() [1/2]

SolidEnergySpatialParams< FVGridGeometry, Scalar > & Dumux::FVSpatialParams< FVGridGeometry , Scalar, SolidEnergySpatialParams< FVGridGeometry, Scalar > >::asImp_ ( )

inlineprotectedinherited

◆ asImp_() [2/2]

const SolidEnergySpatialParams< FVGridGeometry, Scalar > & Dumux::FVSpatialParams< FVGridGeometry , Scalar, SolidEnergySpatialParams< FVGridGeometry, Scalar > >::asImp_ ( ) const

inlineprotectedinherited

◆ beaversJosephCoeffAtPos()

Scalar Dumux::FVPorousMediumFlowSpatialParams< FVGridGeometry , Scalar, SolidEnergySpatialParams< FVGridGeometry, Scalar > >::beaversJosephCoeffAtPos ( const GlobalPosition & globalPos ) const

inlineinherited

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

Parameters

globalPos The global position

◆ evaluatePermeabilityAtScvfIP()

static constexpr bool Dumux::FVPorousMediumFlowSpatialParams< FVGridGeometry , Scalar, SolidEnergySpatialParams< FVGridGeometry, Scalar > >::evaluatePermeabilityAtScvfIP ( )

inlinestaticconstexprinherited

◆ extrusionFactor()

Scalar Dumux::FVSpatialParams< FVGridGeometry , Scalar, SolidEnergySpatialParams< FVGridGeometry, Scalar > >::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.

◆ extrusionFactorAtPos()

Scalar Dumux::FVSpatialParams< FVGridGeometry , Scalar, SolidEnergySpatialParams< FVGridGeometry, Scalar > >::extrusionFactorAtPos ( const GlobalPosition & globalPos ) const

inlineinherited

◆ forchCoeff()

Scalar Dumux::FVPorousMediumFlowSpatialParams< FVGridGeometry , Scalar, SolidEnergySpatialParams< FVGridGeometry, Scalar > >::forchCoeff ( const SubControlVolumeFace & scvf ) const

inlineinherited

Parameters

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

◆ gravity()

const GravityVector & Dumux::FVSpatialParams< FVGridGeometry , Scalar, SolidEnergySpatialParams< FVGridGeometry, Scalar > >::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()

const FVGridGeometry & Dumux::FVSpatialParams< FVGridGeometry , Scalar, SolidEnergySpatialParams< FVGridGeometry, Scalar > >::gridGeometry ( ) const

inlineinherited

◆ gridView()

const GridView & Dumux::PoreNetwork::SpatialParams< FVGridGeometry , Scalar, SolidEnergySpatialParams< FVGridGeometry, Scalar > >::gridView ( ) const

inlineinherited

◆ inertVolumeFraction() [1/3]

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

inlineinherited

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::FVPorousMediumSpatialParams< FVGridGeometry , Scalar, SolidEnergySpatialParams< FVGridGeometry, Scalar > >::inertVolumeFraction	(	const Element &	element,
		const SubControlVolume &	scv,
		const ElementSolution &	elemSol,
		int	compIdx
	)		const

inlineinherited

◆ inertVolumeFraction() [3/3]

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

inlineinherited

◆ permeability()

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

inlineinherited

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

◆ permeabilityAtPos()

Scalar Dumux::PoreNetwork::SpatialParams< FVGridGeometry , Scalar, SolidEnergySpatialParams< FVGridGeometry, Scalar > >::permeabilityAtPos ( const GlobalPosition & globalPos ) const

inlineinherited

◆ poreInscribedRadius()

Scalar Dumux::PoreNetwork::SpatialParams< FVGridGeometry , Scalar, SolidEnergySpatialParams< FVGridGeometry, Scalar > >::poreInscribedRadius	(	const Element &	element,
		const SubControlVolume &	scv,
		const ElementSolutionVector &	elemSol
	)		const

inlineinherited

Parameters

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

◆ porosity()

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

inlineinherited

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()

template<class FVGridGeometry , class Scalar >

Scalar Dumux::PoreNetwork::SolidEnergySpatialParams< FVGridGeometry, Scalar >::porosityAtPos ( const GlobalPosition & globalPos ) const

inline

Parameters

globalPos The global position

◆ temperature()

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

inlineinherited

◆ temperatureAtPos()

Scalar Dumux::FVSpatialParams< FVGridGeometry , Scalar, SolidEnergySpatialParams< FVGridGeometry, Scalar > >::temperatureAtPos ( const GlobalPosition & globalPos ) const

inlineinherited

Parameters

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

◆ throatCrossSectionalArea()

Scalar Dumux::PoreNetwork::SpatialParams< FVGridGeometry , Scalar, SolidEnergySpatialParams< FVGridGeometry, Scalar > >::throatCrossSectionalArea	(	const Element &	element,
		const ElementVolumeVariables &	elemVolVars
	)		const

inlineinherited

Parameters

element	The finite volume element
elemVolVars	The element volume variables.

◆ throatInscribedRadius()

Scalar Dumux::PoreNetwork::SpatialParams< FVGridGeometry , Scalar, SolidEnergySpatialParams< FVGridGeometry, Scalar > >::throatInscribedRadius	(	const Element &	element,
		const ElementVolumeVariables &	elemVolVars
	)		const

inlineinherited

Parameters

element	The finite volume element
elemVolVars	The element volume variables.

◆ throatLength()

Scalar Dumux::PoreNetwork::SpatialParams< FVGridGeometry , Scalar, SolidEnergySpatialParams< FVGridGeometry, Scalar > >::throatLength	(	const Element &	element,
		const ElementVolumeVariables &	elemVolVars
	)		const

inlineinherited

Parameters

element	The finite volume element
elemVolVars	The element volume variables.

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

porenetwork/solidenergy/spatialparams.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Member Typedef Documentation

◆ PermeabilityType

Member Function Documentation

◆ asImp_() [1/2]

◆ asImp_() [2/2]

◆ beaversJosephCoeffAtPos()

◆ evaluatePermeabilityAtScvfIP()

◆ extrusionFactor()

◆ extrusionFactorAtPos()

◆ forchCoeff()

◆ gravity()

◆ gridGeometry()

◆ gridView()

◆ inertVolumeFraction() [1/3]

◆ inertVolumeFraction() [2/3]

◆ inertVolumeFraction() [3/3]

◆ permeability()

◆ permeabilityAtPos()

◆ poreInscribedRadius()

◆ porosity()

◆ porosityAtPos()

◆ temperature()

◆ temperatureAtPos()

◆ throatCrossSectionalArea()

◆ throatInscribedRadius()

◆ throatLength()