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

Definition of the spatial parameters for the poro-elastic problem. More...

#include <test/geomechanics/poroelastic/spatialparams.hh>

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

Description

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

Definition of the spatial parameters for the poro-elastic problem.

Definition of the spatial parameters for the poro-elastic sub-problem in the coupled poro-mechanical el1p problem.

Public Types
using	LameParams = Dumux::LameParams< Scalar >
	Export the type of the lame parameters. More...
using	LameParams = Dumux::LameParams< Scalar >
	Export the type of the lame parameters. More...
using	LameParams = Dumux::LameParams< Scalar >
	Export the type of the lame parameters. More...

Public Member Functions
	PoroElasticSpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)
const LameParams &	lameParamsAtPos (const GlobalPosition &globalPos) const
	Defines the Lame parameters. More...
template<class ElemSol >
Scalar	porosity (const Element &element, const SubControlVolume &scv, const ElemSol &elemSol) const
	Returns the porosity of the porous medium. More...
Scalar	biotCoefficientAtPos (const GlobalPosition &globalPos) const
	Returns the Biot coefficient of the porous medium. More...
	PoroElasticSpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)
const LameParams &	lameParamsAtPos (const GlobalPosition &globalPos) const
	Defines the Lame parameters. More...
template<class ElementSolution >
Scalar	porosity (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Returns the porosity of the porous medium. More...
Scalar	biotCoefficientAtPos (const GlobalPosition &globalPos) const
	Returns the Biot coefficient of the porous medium. More...
	PoroElasticSpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)
const LameParams &	lameParamsAtPos (const GlobalPosition &globalPos) const
	Defines the Lame parameters. More...
template<class ElementSolution >
Scalar	porosity (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Returns the porosity of the porous medium. More...
Scalar	biotCoefficientAtPos (const GlobalPosition &globalPos) const
	Returns the Biot coefficient of the porous medium. More...
const GlobalPosition &	gravity (const GlobalPosition &pos) const
	Returns the acceleration due to gravity \(\mathrm{[m/s^2]}\). 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	reactiveVolumeFraction (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol, int compIdx) const
	Function for defining the solid volume fraction of a solid component that takes part in some sort of reaction. More...
Scalar	reactiveVolumeFraction (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol, int compIdx) const
	overload for the case of reactive solids or user-provided overload More...
decltype(auto)	lameParams (const Element &element, const FVElementGeometry &fvGeometry, const ElemVolVars &elemVolVars, const FluxVarsCache &fluxVarsCache) const
	Define the Lame parameters. More...
Scalar	biotCoefficient (const Element &element, const FVElementGeometry &fvGeometry, const ElemVolVars &elemVolVars, const FluxVarsCache &fluxVarsCache) const
	Returns the Biot coefficient in an element. More...
const GridGeometry &	fvGridGeometry () const
	The finite volume grid geometry. More...
const GridGeometry &	gridGeometry () const
	The finite volume grid geometry. More...

Protected Member Functions
PoroElasticSpatialParams< Scalar, GridGeometry > &	asImp_ ()
const PoroElasticSpatialParams< Scalar, GridGeometry > &	asImp_ () const

Member Typedef Documentation

LameParams [1/3]

template<class Scalar , class GridGeometry >

using Dumux::PoroElasticSpatialParams< Scalar, GridGeometry >::LameParams = Dumux::LameParams<Scalar>

Export the type of the lame parameters.

LameParams [2/3]

template<class Scalar , class GridGeometry >

using Dumux::PoroElasticSpatialParams< Scalar, GridGeometry >::LameParams = Dumux::LameParams<Scalar>

Export the type of the lame parameters.

LameParams [3/3]

template<class Scalar , class GridGeometry >

using Dumux::PoroElasticSpatialParams< Scalar, GridGeometry >::LameParams = Dumux::LameParams<Scalar>

Export the type of the lame parameters.

Constructor & Destructor Documentation

PoroElasticSpatialParams() [1/3]

template<class Scalar , class GridGeometry >

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

inline

PoroElasticSpatialParams() [2/3]

template<class Scalar , class GridGeometry >

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

inline

PoroElasticSpatialParams() [3/3]

template<class Scalar , class GridGeometry >

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

inline

Member Function Documentation

asImp_() [1/2]

PoroElasticSpatialParams< Scalar, GridGeometry > & Dumux::FVSpatialParamsPoroElastic< Scalar, GridGeometry, PoroElasticSpatialParams< Scalar, GridGeometry > >::asImp_ ( )

inlineprotectedinherited

asImp_() [2/2]

const PoroElasticSpatialParams< Scalar, GridGeometry > & Dumux::FVSpatialParamsPoroElastic< Scalar, GridGeometry, PoroElasticSpatialParams< Scalar, GridGeometry > >::asImp_ ( ) const

inlineprotectedinherited

biotCoefficient()

Scalar Dumux::FVSpatialParamsPoroElastic< Scalar, GridGeometry, PoroElasticSpatialParams< Scalar, GridGeometry > >::biotCoefficient ( const Element &  element, const FVElementGeometry &  fvGeometry, const ElemVolVars &  elemVolVars, const FluxVarsCache &  fluxVarsCache  ) const

inlineinherited

Returns the Biot coefficient in an element.

Note

This is possibly solution dependent and is 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

Biot coefficient

biotCoefficientAtPos() [1/3]

template<class Scalar , class GridGeometry >

Scalar Dumux::PoroElasticSpatialParams< Scalar, GridGeometry >::biotCoefficientAtPos ( const GlobalPosition &  globalPos ) const

inline

Returns the Biot coefficient of the porous medium.

biotCoefficientAtPos() [2/3]

template<class Scalar , class GridGeometry >

Scalar Dumux::PoroElasticSpatialParams< Scalar, GridGeometry >::biotCoefficientAtPos ( const GlobalPosition &  globalPos ) const

inline

Returns the Biot coefficient of the porous medium.

biotCoefficientAtPos() [3/3]

template<class Scalar , class GridGeometry >

Scalar Dumux::PoroElasticSpatialParams< Scalar, GridGeometry >::biotCoefficientAtPos ( const GlobalPosition &  globalPos ) const

inline

Returns the Biot coefficient of the porous medium.

fvGridGeometry()

const GridGeometry & Dumux::FVSpatialParamsPoroElastic< Scalar, GridGeometry, PoroElasticSpatialParams< Scalar, GridGeometry > >::fvGridGeometry ( ) const

inlineinherited

The finite volume grid geometry.

gravity()

const GlobalPosition & Dumux::FVSpatialParamsPoroElastic< Scalar, GridGeometry, PoroElasticSpatialParams< Scalar, GridGeometry > >::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()

const GridGeometry & Dumux::FVSpatialParamsPoroElastic< Scalar, GridGeometry, PoroElasticSpatialParams< Scalar, GridGeometry > >::gridGeometry ( ) const

inlineinherited

The finite volume grid geometry.

inertVolumeFraction() [1/3]

Scalar Dumux::FVSpatialParamsPoroElastic< Scalar, GridGeometry, PoroElasticSpatialParams< Scalar, GridGeometry > >::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 enabled if there is only one inert solid component and the user didn't choose to implement an 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::FVSpatialParamsPoroElastic< Scalar, GridGeometry, PoroElasticSpatialParams< Scalar, GridGeometry > >::inertVolumeFraction ( const Element &  element, const SubControlVolume &  scv, const ElementSolution &  elemSol, int  compIdx  ) const

inlineinherited

inertVolumeFraction() [3/3]

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

inlineinherited

lameParams()

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

inlineinherited

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

lameParamsAtPos() [1/3]

template<class Scalar , class GridGeometry >

const LameParams & Dumux::PoroElasticSpatialParams< Scalar, GridGeometry >::lameParamsAtPos ( const GlobalPosition &  globalPos ) const

inline

Defines the Lame parameters.

lameParamsAtPos() [2/3]

template<class Scalar , class GridGeometry >

const LameParams & Dumux::PoroElasticSpatialParams< Scalar, GridGeometry >::lameParamsAtPos ( const GlobalPosition &  globalPos ) const

inline

Defines the Lame parameters.

lameParamsAtPos() [3/3]

template<class Scalar , class GridGeometry >

const LameParams & Dumux::PoroElasticSpatialParams< Scalar, GridGeometry >::lameParamsAtPos ( const GlobalPosition &  globalPos ) const

inline

Defines the Lame parameters.

porosity() [1/3]

template<class Scalar , class GridGeometry >

template<class ElementSolution >

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

inline

Returns the porosity of the porous medium.

porosity() [2/3]

template<class Scalar , class GridGeometry >

template<class ElementSolution >

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

inline

Returns the porosity of the porous medium.

porosity() [3/3]

template<class Scalar , class GridGeometry >

template<class ElemSol >

Scalar Dumux::PoroElasticSpatialParams< Scalar, GridGeometry >::porosity ( const Element &  element, const SubControlVolume &  scv, const ElemSol &  elemSol  ) const

inline

Returns the porosity of the porous medium.

reactiveVolumeFraction() [1/2]

Scalar Dumux::FVSpatialParamsPoroElastic< Scalar, GridGeometry, PoroElasticSpatialParams< Scalar, GridGeometry > >::reactiveVolumeFraction ( const Element &  element, const SubControlVolume &  scv, const ElementSolution &  elemSol, int  compIdx  ) const

inlineinherited

Function for defining the solid volume fraction of a solid component that takes part in some sort of reaction.

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 enabled if there are only inert solid components and the user did not choose to implement a reactiveVolumeFractionAtPos function. The reactive volume fraction is zero in this case.

reactiveVolumeFraction() [2/2]

Scalar Dumux::FVSpatialParamsPoroElastic< Scalar, GridGeometry, PoroElasticSpatialParams< Scalar, GridGeometry > >::reactiveVolumeFraction ( const Element &  element, const SubControlVolume &  scv, const ElementSolution &  elemSol, int  compIdx  ) const

inlineinherited

overload for the case of reactive solids or user-provided overload

---

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

• geomechanics/poroelastic/spatialparams.hh
• el1p/spatialparams_poroelastic.hh
• el2p/spatialparams_poroelastic.hh