MaterialLib::Solids::MechanicsBase< DisplacementDim > Struct Template Reference

Detailed Description

template<int DisplacementDim>
struct MaterialLib::Solids::MechanicsBase< DisplacementDim >

Interface for mechanical solid material models. Provides updates of the stress for a given current state and also a tangent at that position. If the implemented material model stores an internal state, the nested MaterialStateVariables class should be used; it's only responsibility is to provide state's push back possibility.

Definition at line 25 of file ThermoMechanicsProcessData.h.

#include <MechanicsBase.h>

Inheritance diagram for MaterialLib::Solids::MechanicsBase< DisplacementDim >:

Classes
struct	InternalVariable
	Helper type for providing access to internal variables. More...
struct	MaterialStateVariables

Public Types
using	KelvinVector
using	KelvinMatrix

Public Member Functions
virtual std::unique_ptr< MaterialStateVariables >	createMaterialStateVariables () const
virtual void	initializeInternalStateVariables (double const, ParameterLib::SpatialPosition const &, typename MechanicsBase< DisplacementDim >::MaterialStateVariables &) const
virtual std::optional< std::tuple< KelvinVector, std::unique_ptr< MaterialStateVariables >, KelvinMatrix > >	integrateStress (MaterialPropertyLib::VariableArray const &variable_array_prev, MaterialPropertyLib::VariableArray const &variable_array, double const t, ParameterLib::SpatialPosition const &x, double const dt, MaterialStateVariables const &material_state_variables) const =0
virtual std::vector< InternalVariable >	getInternalVariables () const
virtual ConstitutiveModel	getConstitutiveModel () const
	Gets the type of constitutive model.
virtual double	getBulkModulus (double const, ParameterLib::SpatialPosition const &, KelvinMatrix const *const =nullptr) const
virtual double	getTemperatureRelatedCoefficient (double const, double const, ParameterLib::SpatialPosition const &, double const, double const) const
virtual double	computeFreeEnergyDensity (double const t, ParameterLib::SpatialPosition const &x, double const dt, KelvinVector const &eps, KelvinVector const &sigma, MaterialStateVariables const &material_state_variables) const =0
virtual	~MechanicsBase ()=default

Member Typedef Documentation

KelvinMatrix

template<int DisplacementDim>

using MaterialLib::Solids::MechanicsBase< DisplacementDim >::KelvinMatrix

Initial value:

 
        MathLib::KelvinVector::KelvinMatrixType<DisplacementDim>

Definition at line 83 of file MechanicsBase.h.

KelvinVector

template<int DisplacementDim>

using MaterialLib::Solids::MechanicsBase< DisplacementDim >::KelvinVector

Initial value:

 
        MathLib::KelvinVector::KelvinVectorType<DisplacementDim>

Definition at line 81 of file MechanicsBase.h.

Constructor & Destructor Documentation

~MechanicsBase()

template<int DisplacementDim>

virtual MaterialLib::Solids::MechanicsBase< DisplacementDim >::~MechanicsBase ( )

virtualdefault

Member Function Documentation

computeFreeEnergyDensity()

template<int DisplacementDim>

virtual double MaterialLib::Solids::MechanicsBase< DisplacementDim >::computeFreeEnergyDensity ( double const t, ParameterLib::SpatialPosition const & x, double const dt, KelvinVector const & eps, KelvinVector const & sigma, MaterialStateVariables const & material_state_variables ) const

pure virtual

createMaterialStateVariables()

template<int DisplacementDim>

virtual std::unique_ptr< MaterialStateVariables > MaterialLib::Solids::MechanicsBase< DisplacementDim >::createMaterialStateVariables ( ) const

inlinevirtual

Polymorphic creator for MaterialStateVariables objects specific for a material model.

Reimplemented in MaterialLib::Solids::Creep::CreepBGRa< DisplacementDim >, MaterialLib::Solids::Ehlers::SolidEhlers< DisplacementDim >, MaterialLib::Solids::Lubby2::Lubby2< DisplacementDim >, and MaterialLib::Solids::MFront::MFront< DisplacementDim >.

Definition at line 69 of file MechanicsBase.h.

    {
        return std::make_unique<MaterialStateVariables>();
    }

Referenced by ProcessLib::ThermoHydroMechanics::IntegrationPointData< BMatricesType, ShapeMatrixTypeDisplacement, ShapeMatricesTypePressure, DisplacementDim, NPoints >::updateConstitutiveRelationIce().

getBulkModulus()

template<int DisplacementDim>

virtual double MaterialLib::Solids::MechanicsBase< DisplacementDim >::getBulkModulus ( double const , ParameterLib::SpatialPosition const & , KelvinMatrix const * const = nullptr ) const

inlinevirtual

Reimplemented in MaterialLib::Solids::Ehlers::SolidEhlers< DisplacementDim >, MaterialLib::Solids::LinearElasticIsotropic< DisplacementDim >, MaterialLib::Solids::LinearElasticOrthotropic< DisplacementDim >, MaterialLib::Solids::LinearElasticTransverseIsotropic< DisplacementDim >, MaterialLib::Solids::Lubby2::Lubby2< DisplacementDim >, and MaterialLib::Solids::MFront::MFront< DisplacementDim >.

Definition at line 136 of file MechanicsBase.h.

    {
        OGS_FATAL(
            "getBulkModulus is not yet implemented for this Solid Material.");
    }

References OGS_FATAL.

Referenced by ProcessLib::RichardsMechanics::RichardsMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assembleWithJacobianEvalConstitutiveSetting().

getConstitutiveModel()

template<int DisplacementDim>

virtual ConstitutiveModel MaterialLib::Solids::MechanicsBase< DisplacementDim >::getConstitutiveModel ( ) const

inlinevirtual

Gets the type of constitutive model.

Reimplemented in MaterialLib::Solids::Creep::CreepBGRa< DisplacementDim >.

Definition at line 131 of file MechanicsBase.h.

    {
        return ConstitutiveModel::Invalid;
    }

References MaterialLib::Solids::Invalid.

getInternalVariables()

template<int DisplacementDim>

virtual std::vector< InternalVariable > MaterialLib::Solids::MechanicsBase< DisplacementDim >::getInternalVariables ( ) const

inlinevirtual

Returns internal variables defined by the specific material model, if any.

Reimplemented in MaterialLib::Solids::Ehlers::SolidEhlers< DisplacementDim >, and MaterialLib::Solids::MFront::MFront< DisplacementDim >.

Definition at line 125 of file MechanicsBase.h.

    {
        return {};
    }

getTemperatureRelatedCoefficient()

template<int DisplacementDim>

virtual double MaterialLib::Solids::MechanicsBase< DisplacementDim >::getTemperatureRelatedCoefficient ( double const , double const , ParameterLib::SpatialPosition const & , double const , double const  ) const

inlinevirtual

Get temperature related coefficient for the global assembly if there is one.

Reimplemented in MaterialLib::Solids::Creep::CreepBGRa< DisplacementDim >.

Definition at line 147 of file MechanicsBase.h.

    {
        return 0.0;
    }

initializeInternalStateVariables()

template<int DisplacementDim>

virtual void MaterialLib::Solids::MechanicsBase< DisplacementDim >::initializeInternalStateVariables ( double const , ParameterLib::SpatialPosition const & , typename MechanicsBase< DisplacementDim >::MaterialStateVariables &  ) const

inlinevirtual

Reimplemented in MaterialLib::Solids::MFront::MFront< DisplacementDim >.

Definition at line 74 of file MechanicsBase.h.

    {
    }

Referenced by ProcessLib::ThermoHydroMechanics::IntegrationPointData< BMatricesType, ShapeMatrixTypeDisplacement, ShapeMatricesTypePressure, DisplacementDim, NPoints >::updateConstitutiveRelationIce().

integrateStress()

template<int DisplacementDim>

virtual std::optional< std::tuple< KelvinVector, std::unique_ptr< MaterialStateVariables >, KelvinMatrix > > MaterialLib::Solids::MechanicsBase< DisplacementDim >::integrateStress ( MaterialPropertyLib::VariableArray const & variable_array_prev, MaterialPropertyLib::VariableArray const & variable_array, double const t, ParameterLib::SpatialPosition const & x, double const dt, MaterialStateVariables const & material_state_variables ) const

pure virtual

Computation of the constitutive relation for specific material model. This should be implemented in the derived model. Fixed Kelvin vector and matrix size version; for dynamic size arguments there is an overloaded wrapper function. Returns nothing in case of errors in the computation if Newton iterations did not converge, for example.

Referenced by ProcessLib::RichardsMechanics::IntegrationPointData< BMatricesType, ShapeMatrixTypeDisplacement, ShapeMatricesTypePressure, DisplacementDim, NPoints >::computeElasticTangentStiffness(), and ProcessLib::ThermoHydroMechanics::IntegrationPointData< BMatricesType, ShapeMatrixTypeDisplacement, ShapeMatricesTypePressure, DisplacementDim, NPoints >::updateConstitutiveRelationIce().

---

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

• MaterialLib/SolidModels/CreateConstitutiveRelation.h
• MaterialLib/SolidModels/CreateConstitutiveRelationIce.h
• MaterialLib/SolidModels/CreateCreepBGRa.h
• MaterialLib/SolidModels/MechanicsBase.h
• ProcessLib/HydroMechanics/HydroMechanicsProcessData.h
• ProcessLib/LargeDeformation/LargeDeformationProcessData.h
• ProcessLib/PhaseField/PhaseFieldProcessData.h
• ProcessLib/RichardsMechanics/RichardsMechanicsProcessData.h
• ProcessLib/SmallDeformation/SmallDeformationProcessData.h
• ProcessLib/SmallDeformationNonlocal/SmallDeformationNonlocalProcessData.h
• ProcessLib/ThermoHydroMechanics/ThermoHydroMechanicsProcessData.h
• ProcessLib/ThermoMechanicalPhaseField/ThermoMechanicalPhaseFieldProcessData.h
• ProcessLib/ThermoMechanics/ThermoMechanicsProcessData.h