The base class for spatial parameters of linear elastic geomechanical problems. More...

#include <dumux/geomechanics/elastic/fvspatialparams.hh>

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

Description

template<class GridGeometry, class Scalar, class Implementation>
class Dumux::FVElasticSpatialParams< GridGeometry, Scalar, Implementation >

The base class for spatial parameters of linear elastic geomechanical problems.

Public Member Functions
	FVElasticSpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)
	The constructor. More...

template<class SolidSystem , class ElementSolution >
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...

template<class SolidSystem >
Scalar	inertVolumeFractionAtPos (const GlobalPosition &globalPos, int compIdx) const
	Function for defining the solid volume fraction. That is possibly solution dependent. More...

template<class ElemVolVars , class FluxVarsCache >
decltype(auto)	lameParams (const Element &element, const FVElementGeometry &fvGeometry, const ElemVolVars &elemVolVars, const FluxVarsCache &fluxVarsCache) const
	Define the Lame parameters. More...

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

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

template<class ElementSolution >
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 GridGeometry &	gridGeometry () const
	The finite volume grid geometry. More...

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

const Implementation &	asImp_ () const
	Returns the implementation of the spatial parameters (static polymorphism) More...

Constructor & Destructor Documentation

◆ FVElasticSpatialParams()

template<class GridGeometry , class Scalar , class Implementation >

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

inline

The constructor.

Member Function Documentation

◆ asImp_() [1/2]

template<class GridGeometry , class Scalar , class Implementation >

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

inlineprotectedinherited

Returns the implementation of the spatial parameters (static polymorphism)

◆ asImp_() [2/2]

template<class GridGeometry , class Scalar , class Implementation >

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

inlineprotectedinherited

Returns the implementation of the spatial parameters (static polymorphism)

◆ extrusionFactor()

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

Return how much the domain is extruded at a given sub-control volume.

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

Return how much the domain is extruded at a given position.

◆ gravity()

template<class GridGeometry , class Scalar , class Implementation >

const GravityVector & Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::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 evaluate the gravity vector

◆ gridGeometry()

template<class GridGeometry , class Scalar , class Implementation >

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

inlineinherited

The finite volume grid geometry.

◆ inertVolumeFraction()

template<class GridGeometry , class Scalar , class Implementation >

template<class SolidSystem , class ElementSolution >

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

inline

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

◆ inertVolumeFractionAtPos()

template<class GridGeometry , class Scalar , class Implementation >

template<class SolidSystem >

Scalar Dumux::FVElasticSpatialParams< GridGeometry, Scalar, Implementation >::inertVolumeFractionAtPos	(	const GlobalPosition &	globalPos,
		int	compIdx
	)		const

inline

Function for defining the solid volume fraction. That is possibly solution dependent.

Parameters

globalPos	The global position
compIdx	The solid component index

Returns: the volume fraction of the inert solid component with index compIdx

◆ lameParams()

template<class GridGeometry , class Scalar , class Implementation >

template<class ElemVolVars , class FluxVarsCache >

decltype(auto) Dumux::FVElasticSpatialParams< GridGeometry, Scalar, Implementation >::lameParams	(	const Element &	element,
		const FVElementGeometry &	fvGeometry,
		const ElemVolVars &	elemVolVars,
		const FluxVarsCache &	fluxVarsCache
	)		const

inline

Define the Lame parameters.

Note: These are possibly solution dependent and are evaluated for an integration point inside the element. Therefore, a flux variables cache object is passed to this function containing data on shape functions at the integration point.

Parameters

element	The current element
fvGeometry	The local finite volume geometry
elemVolVars	Primary/Secondary variables inside the element
fluxVarsCache	Contains data on shape functions at the integration point

Returns: lame parameters

◆ temperature()

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

Return the temperature in the given sub-control volume.

◆ temperatureAtPos()

template<class GridGeometry , class Scalar , class Implementation >

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

inlineinherited

Return the temperature in the domain at the given position.

Parameters

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

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

geomechanics/elastic/fvspatialparams.hh

Description

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

◆ FVElasticSpatialParams()

Member Function Documentation

◆ asImp_() [1/2]

◆ asImp_() [2/2]

◆ extrusionFactor()

◆ extrusionFactorAtPos()

◆ gravity()

◆ gridGeometry()

◆ inertVolumeFraction()

◆ inertVolumeFractionAtPos()

◆ lameParams()

◆ temperature()

◆ temperatureAtPos()