Contains the quantities which are constant within a finite volume in the poroelastic model. More...

#include <dumux/geomechanics/poroelastic/volumevariables.hh>

Description

template<class Traits>
class Dumux::PoroElasticVolumeVariables< Traits >

Contains the quantities which are constant within a finite volume in the poroelastic model.

Template Parameters

Traits Class encapsulating types to be used by the vol vars

Public Types
using	PrimaryVariables = typename Traits::PrimaryVariables
	export the type used for the primary variables More...

using	DisplacementVector = typename Traits::DisplacementVector
	export the type used for displacement vectors More...

using	Indices = typename ModelTraits::Indices
	export the type encapsulating primary variable indices More...

using	SolidState = typename Traits::SolidState
	export type of solid state More...

using	SolidSystem = typename Traits::SolidSystem
	export the solid system used More...

Public Member Functions
template<class ElemSol , class Problem , class Element , class Scv >
void	update (const ElemSol &elemSol, const Problem &problem, const Element &element, const Scv &scv)
	Update all quantities for a given control volume. More...

Scalar	solidDensity () const
	Return the average porosity \(\mathrm{[-]}\) within the scv. More...

Scalar	porosity () const
	Return the average porosity \(\mathrm{[-]}\) within the scv. More...

Scalar	displacement (unsigned int dir) const
	Returns the permeability within the scv in \([m^2]\). More...

DisplacementVector	displacement () const
	Returns the displacement vector within the scv in \([m]\). More...

Scalar	priVar (const int pvIdx) const
	Return a component of primary variable vector for a given index. More...

const PrimaryVariables &	priVars () const
	Return the vector of primary variables. More...

Static Public Member Functions
static constexpr Scalar	extrusionFactor ()
	TODO We don't know yet how to interpret extrusion for mechanics. More...

Member Typedef Documentation

◆ DisplacementVector

template<class Traits >

using Dumux::PoroElasticVolumeVariables< Traits >::DisplacementVector = typename Traits::DisplacementVector

export the type used for displacement vectors

◆ Indices

template<class Traits >

using Dumux::PoroElasticVolumeVariables< Traits >::Indices = typename ModelTraits::Indices

export the type encapsulating primary variable indices

◆ PrimaryVariables

template<class Traits >

using Dumux::PoroElasticVolumeVariables< Traits >::PrimaryVariables = typename Traits::PrimaryVariables

export the type used for the primary variables

◆ SolidState

template<class Traits >

using Dumux::PoroElasticVolumeVariables< Traits >::SolidState = typename Traits::SolidState

export type of solid state

◆ SolidSystem

template<class Traits >

using Dumux::PoroElasticVolumeVariables< Traits >::SolidSystem = typename Traits::SolidSystem

export the solid system used

Member Function Documentation

◆ displacement() [1/2]

template<class Traits >

DisplacementVector Dumux::PoroElasticVolumeVariables< Traits >::displacement ( ) const

inline

Returns the displacement vector within the scv in \([m]\).

◆ displacement() [2/2]

template<class Traits >

Scalar Dumux::PoroElasticVolumeVariables< Traits >::displacement ( unsigned int dir ) const

inline

Returns the permeability within the scv in \([m^2]\).

◆ extrusionFactor()

template<class Traits >

static constexpr Scalar Dumux::PoroElasticVolumeVariables< Traits >::extrusionFactor ( )

inlinestaticconstexpr

TODO We don't know yet how to interpret extrusion for mechanics.

◆ porosity()

template<class Traits >

Scalar Dumux::PoroElasticVolumeVariables< Traits >::porosity ( ) const

inline

Return the average porosity \(\mathrm{[-]}\) within the scv.

◆ priVar()

template<class Traits >

Scalar Dumux::PoroElasticVolumeVariables< Traits >::priVar ( const int pvIdx ) const

inline

Return a component of primary variable vector for a given index.

◆ priVars()

template<class Traits >

const PrimaryVariables & Dumux::PoroElasticVolumeVariables< Traits >::priVars ( ) const

inline

Return the vector of primary variables.

◆ solidDensity()

template<class Traits >

Scalar Dumux::PoroElasticVolumeVariables< Traits >::solidDensity ( ) const

inline

Return the average porosity \(\mathrm{[-]}\) within the scv.

◆ update()

template<class Traits >

template<class ElemSol , class Problem , class Element , class Scv >

void Dumux::PoroElasticVolumeVariables< Traits >::update	(	const ElemSol &	elemSol,
		const Problem &	problem,
		const Element &	element,
		const Scv &	scv
	)

inline

Update all quantities for a given control volume.

Parameters

elemSol	A vector containing all primary variables connected to the element
problem	The object specifying the problem which ought to be simulated
element	An element which contains part of the control volume
scv	The sub-control volume

set the volume fractions of the solid components

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

geomechanics/poroelastic/volumevariables.hh

Description

Public Types

Public Member Functions

Static Public Member Functions

Member Typedef Documentation

◆ DisplacementVector

◆ Indices

◆ PrimaryVariables

◆ SolidState

◆ SolidSystem

Member Function Documentation

◆ displacement() [1/2]

◆ displacement() [2/2]

◆ extrusionFactor()

◆ porosity()

◆ priVar()

◆ priVars()

◆ solidDensity()

◆ update()