3.5-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Member Functions | Protected Member Functions | List of all members
Dumux::FVSpatialParamsElastic< Scalar, GridGeometry, Implementation > Class Template Reference

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

#include <dumux/material/spatialparams/fvelastic.hh>

Description

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

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

Public Member Functions

 FVSpatialParamsElastic (std::shared_ptr< const GridGeometry > gridGeometry)
 The constructor. More...
 
const GlobalPosition & gravity (const GlobalPosition &pos) const
 Returns the acceleration due to gravity \(\mathrm{[m/s^2]}\). 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...
 
const GridGeometry & gridGeometry () const
 The finite volume grid geometry. More...
 

Protected Member Functions

Implementation & asImp_ ()
 
const Implementation & asImp_ () const
 

Constructor & Destructor Documentation

◆ FVSpatialParamsElastic()

template<class Scalar , class GridGeometry , class Implementation >
Dumux::FVSpatialParamsElastic< Scalar, GridGeometry, Implementation >::FVSpatialParamsElastic ( std::shared_ptr< const GridGeometry >  gridGeometry)
inline

The constructor.

Member Function Documentation

◆ asImp_() [1/2]

template<class Scalar , class GridGeometry , class Implementation >
Implementation & Dumux::FVSpatialParamsElastic< Scalar, GridGeometry, Implementation >::asImp_ ( )
inlineprotected

◆ asImp_() [2/2]

template<class Scalar , class GridGeometry , class Implementation >
const Implementation & Dumux::FVSpatialParamsElastic< Scalar, GridGeometry, Implementation >::asImp_ ( ) const
inlineprotected

◆ gravity()

template<class Scalar , class GridGeometry , class Implementation >
const GlobalPosition & Dumux::FVSpatialParamsElastic< Scalar, GridGeometry, Implementation >::gravity ( const GlobalPosition &  pos) const
inline

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
posthe spatial position at which to evaulate the gravity vector

◆ gridGeometry()

template<class Scalar , class GridGeometry , class Implementation >
const GridGeometry & Dumux::FVSpatialParamsElastic< Scalar, GridGeometry, Implementation >::gridGeometry ( ) const
inline

The finite volume grid geometry.

◆ inertVolumeFraction()

template<class Scalar , class GridGeometry , class Implementation >
template<class SolidSystem , class ElementSolution >
Scalar Dumux::FVSpatialParamsElastic< Scalar, GridGeometry, 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
elementThe current element
scvThe sub-control volume inside the element.
elemSolThe solution at the dofs connected to the element.
compIdxThe solid component index
Returns
the volume fraction of the inert solid component with index compIdx

◆ inertVolumeFractionAtPos()

template<class Scalar , class GridGeometry , class Implementation >
template<class SolidSystem >
Scalar Dumux::FVSpatialParamsElastic< Scalar, GridGeometry, Implementation >::inertVolumeFractionAtPos ( const GlobalPosition &  globalPos,
int  compIdx 
) const
inline

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

Parameters
globalPosThe global position
compIdxThe solid component index
Returns
the volume fraction of the inert solid component with index compIdx

◆ lameParams()

template<class Scalar , class GridGeometry , class Implementation >
template<class ElemVolVars , class FluxVarsCache >
decltype(auto) Dumux::FVSpatialParamsElastic< Scalar, GridGeometry, 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
elementThe current element
fvGeometryThe local finite volume geometry
elemVolVarsPrimary/Secondary variables inside the element
fluxVarsCacheContains data on shape functions at the integration point
Returns
lame parameters

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