opm-common
Opm::MaterialStateTPSA< Scalar > Class Template Reference
Inheritance diagram for Opm::MaterialStateTPSA< Scalar >:
Opm::GenericMaterialState< Scalar >

Public Member Functions

 MaterialStateTPSA ()
 Constructor.
 
const Scalar rotation (unsigned dirIdx) const
 Return direction (x-, y- or z-) component of rotation. More...
 
const Scalar solidPressure () const
 Return solid pressure.
 
void setRotation (unsigned dirIdx, const Scalar value)
 Set a direction (x-, y- or z-) component of rotation. More...
 
void setSolidPressure (const Scalar value)
 Set solid pressure. More...
 
template<class MaterialState >
void assign (const MaterialState &ms)
 Assign from another material state container. More...
 
void checkDefined () const
 Instruct Valgrind to check the definedness of all attributes of this class.
 
- Public Member Functions inherited from Opm::GenericMaterialState< Scalar >
 GenericMaterialState ()
 Constructor.
 
virtual ~GenericMaterialState ()=default
 Destructor.
 
const Scalar displacement (unsigned dirIdx) const
 Return direction (x-, y- or z-) component of displacement. More...
 
void setDisplacement (unsigned dirIdx, const Scalar value)
 Set a direction (x-, y- or z-) component of displacement. More...
 
template<class MaterialState >
void assign (const MaterialState &ms)
 Assign from another material state container. More...
 
void checkDefined () const
 Instruct Valgrind to check the definedness of all attributes of this class.
 

Protected Attributes

std::array< Scalar, 3 > rotation_ {}
 
Scalar solidPressure_ {}
 
- Protected Attributes inherited from Opm::GenericMaterialState< Scalar >
std::array< Scalar, 3 > displacement_ {}
 

Member Function Documentation

◆ assign()

template<class Scalar >
template<class MaterialState >
void Opm::MaterialStateTPSA< Scalar >::assign ( const MaterialState &  ms)
inline

Assign from another material state container.

Parameters
msIncoming material state container

◆ rotation()

template<class Scalar >
const Scalar Opm::MaterialStateTPSA< Scalar >::rotation ( unsigned  dirIdx) const
inline

Return direction (x-, y- or z-) component of rotation.

Parameters
dirIdxDirection component index

◆ setRotation()

template<class Scalar >
void Opm::MaterialStateTPSA< Scalar >::setRotation ( unsigned  dirIdx,
const Scalar  value 
)
inline

Set a direction (x-, y- or z-) component of rotation.

Parameters
dirIdxDirection component index
valueRotation value

◆ setSolidPressure()

template<class Scalar >
void Opm::MaterialStateTPSA< Scalar >::setSolidPressure ( const Scalar  value)
inline

Set solid pressure.

Parameters
valueSolid pressure value

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