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

Definition of the spatial parameters for the linear elasticity problem. More...

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

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

Description

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

Definition of the spatial parameters for the linear elasticity problem.

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

Public Member Functions
	ElasticSpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)
const LameParams &	lameParamsAtPos (const GlobalPosition &globalPos) const
	Defines the Lame parameters. 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	inertVolumeFractionAtPos (const GlobalPosition &globalPos, int compIdx) const
	Function for defining the solid volume fraction. That is possibly solution dependent. More...
decltype(auto)	lameParams (const Element &element, const FVElementGeometry &fvGeometry, const ElemVolVars &elemVolVars, const FluxVarsCache &fluxVarsCache) const
	Define the Lame parameters. More...
const GridGeometry &	fvGridGeometry () const
	The finite volume grid geometry. More...
const GridGeometry &	gridGeometry () const
	The finite volume grid geometry. More...

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

Member Typedef Documentation

LameParams

template<class Scalar , class GridGeometry >

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

Export the type of the lame parameters.

Constructor & Destructor Documentation

ElasticSpatialParams()

template<class Scalar , class GridGeometry >

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

inline

Member Function Documentation

asImp_() [1/2]

ElasticSpatialParams< Scalar, GridGeometry > & Dumux::FVSpatialParamsElastic< Scalar, GridGeometry, ElasticSpatialParams< Scalar, GridGeometry > >::asImp_ ( )

inlineprotectedinherited

asImp_() [2/2]

const ElasticSpatialParams< Scalar, GridGeometry > & Dumux::FVSpatialParamsElastic< Scalar, GridGeometry, ElasticSpatialParams< Scalar, GridGeometry > >::asImp_ ( ) const

inlineprotectedinherited

fvGridGeometry()

const GridGeometry & Dumux::FVSpatialParamsElastic< Scalar, GridGeometry, ElasticSpatialParams< Scalar, GridGeometry > >::fvGridGeometry ( ) const

inlineinherited

The finite volume grid geometry.

gravity()

const GlobalPosition & Dumux::FVSpatialParamsElastic< Scalar, GridGeometry, ElasticSpatialParams< 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::FVSpatialParamsElastic< Scalar, GridGeometry, ElasticSpatialParams< Scalar, GridGeometry > >::gridGeometry ( ) const

inlineinherited

The finite volume grid geometry.

inertVolumeFraction()

Scalar Dumux::FVSpatialParamsElastic< Scalar, GridGeometry, ElasticSpatialParams< 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

inertVolumeFractionAtPos()

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

inlineinherited

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

decltype(auto) Dumux::FVSpatialParamsElastic< Scalar, GridGeometry, ElasticSpatialParams< 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()

template<class Scalar , class GridGeometry >

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

inline

Defines the Lame parameters.

---

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

• geomechanics/elastic/spatialparams.hh