ComputeStrainBase is the base class for strain tensors. More...

#include <ComputeStrainBase.h>

Inheritance diagram for ComputeStrainBase:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	ComputeStrainBase (const InputParameters &parameters)

void	initialSetup () override

const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialProperty (const std::string &name)

const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialPropertyByName (const std::string &name)

void	validateDerivativeMaterialPropertyBase (const std::string &base)

const MaterialPropertyName	derivativePropertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	derivativePropertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	derivativePropertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	derivativePropertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)

void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)

void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual void	initQpStatefulProperties () override

virtual void	displacementIntegrityCheck ()

Protected Attributes
unsigned int	_ndisp
	Coupled displacement variables.

std::vector< const VariableValue * >	_disp
	Displacement variables.

std::vector< const VariableGradient * >	_grad_disp
	Gradient of displacements.

const std::string	_base_name
	Base name of the material system.

MaterialProperty< RankTwoTensor > &	_mechanical_strain

MaterialProperty< RankTwoTensor > &	_total_strain

std::vector< MaterialPropertyName >	_eigenstrain_names

std::vector< const MaterialProperty< RankTwoTensor > * >	_eigenstrains

const MaterialProperty< RankTwoTensor > *const	_global_strain

const bool	_volumetric_locking_correction

const Real &	_current_elem_volume

Private Member Functions
bool	haveMaterialProperty (const std::string &prop_name)

std::vector< VariableName >	buildVariableVector (const VariableName &c1, const VariableName &c2, const VariableName &c3)

void	validateCouplingHelper (const MaterialPropertyName &base, const std::vector< VariableName > &c, const System &system, std::vector< VariableName > &missing)

bool	isNotObjectVariable (const VariableName &name)

Private Attributes
FEProblemBase &	_dmi_fe_problem

Detailed Description

ComputeStrainBase is the base class for strain tensors.

Definition at line 21 of file ComputeStrainBase.h.

Constructor & Destructor Documentation

◆ ComputeStrainBase()

ComputeStrainBase::ComputeStrainBase ( const InputParameters & parameters )

Definition at line 36 of file ComputeStrainBase.C.

  : DerivativeMaterialInterface<Material>(parameters),
    _ndisp(coupledComponents("displacements")),
    _disp(coupledValues("displacements")),
    _grad_disp(coupledGradients("displacements")),
    _base_name(isParamValid("base_name") ? getParam<std::string>("base_name") + "_" : ""),
    _mechanical_strain(declareProperty<RankTwoTensor>(_base_name + "mechanical_strain")),
    _total_strain(declareProperty<RankTwoTensor>(_base_name + "total_strain")),
    _eigenstrain_names(getParam<std::vector<MaterialPropertyName>>("eigenstrain_names")),
    _eigenstrains(_eigenstrain_names.size()),
    _global_strain(isParamValid("global_strain")
                       ? &getMaterialProperty<RankTwoTensor>(_base_name + "global_strain")
                       : nullptr),
    _volumetric_locking_correction(getParam<bool>("volumetric_locking_correction") &&
                                   !isBoundaryMaterial()),
    _current_elem_volume(_assembly.elemVolume())
{
  for (unsigned int i = 0; i < _eigenstrains.size(); ++i)
  {
    _eigenstrain_names[i] = _base_name + _eigenstrain_names[i];
    _eigenstrains[i] = &getMaterialProperty<RankTwoTensor>(_eigenstrain_names[i]);
  }
 
  // set unused dimensions to zero
  _disp.resize(3, &_zero);
  _grad_disp.resize(3, &_grad_zero);
 
  if (_ndisp == 1 && _volumetric_locking_correction)
    paramError("volumetric_locking_correction", "has to be set to false for 1-D problems.");
 
  if (getParam<bool>("use_displaced_mesh"))
    paramError("use_displaced_mesh", "The strain calculator needs to run on the undisplaced mesh.");
 
  // Generate warning when volumetric locking correction is used with second order elements
  if (_mesh.hasSecondOrderElements() && _volumetric_locking_correction)
    mooseWarning("Volumetric locking correction is not required for second order elements. Using "
                 "volumetric locking with second order elements could cause zigzag patterns in "
                 "stresses and strains.");
}

Member Function Documentation

◆ displacementIntegrityCheck()

void ComputeStrainBase::displacementIntegrityCheck ( )

protectedvirtual

Reimplemented in Compute2DFiniteStrain, Compute2DIncrementalStrain, and Compute2DSmallStrain.

Definition at line 83 of file ComputeStrainBase.C.

{
  // Checking for consistency between mesh size and length of the provided displacements vector
  if (_ndisp != _mesh.dimension())
    paramError(
        "displacements",
        "The number of variables supplied in 'displacements' must match the mesh dimension.");
}

Referenced by initialSetup().

◆ initialSetup()

void ComputeStrainBase::initialSetup ( )

override

Definition at line 77 of file ComputeStrainBase.C.

{
  displacementIntegrityCheck();
}

Referenced by ComputeAxisymmetric1DSmallStrain::initialSetup(), and ComputeIncrementalStrainBase::initialSetup().

◆ initQpStatefulProperties()

void ComputeStrainBase::initQpStatefulProperties ( )

overrideprotectedvirtual

Reimplemented in ComputeCosseratIncrementalSmallStrain, and ComputeIncrementalStrainBase.

Definition at line 93 of file ComputeStrainBase.C.

{
  _mechanical_strain[_qp].zero();
  _total_strain[_qp].zero();
}

◆ validParams()

InputParameters ComputeStrainBase::validParams ( )

static

Definition at line 15 of file ComputeStrainBase.C.

{
  InputParameters params = Material::validParams();
  params.addRequiredCoupledVar(
      "displacements",
      "The displacements appropriate for the simulation geometry and coordinate system");
  params.addParam<std::string>("base_name",
                               "Optional parameter that allows the user to define "
                               "multiple mechanics material systems on the same "
                               "block, i.e. for multiple phases");
  params.addParam<bool>(
      "volumetric_locking_correction", false, "Flag to correct volumetric locking");
  params.addParam<std::vector<MaterialPropertyName>>(
      "eigenstrain_names", {}, "List of eigenstrains to be applied in this strain calculation");
  params.addParam<MaterialPropertyName>("global_strain",
                                        "Optional material property holding a global strain "
                                        "tensor applied to the mesh as a whole");
  params.suppressParameter<bool>("use_displaced_mesh");
  return params;
}

Referenced by ComputeCosseratSmallStrain::validParams(), ComputeIncrementalStrainBase::validParams(), ComputeSmallStrain::validParams(), and ComputeCrackTipEnrichmentSmallStrain::validParams().

Member Data Documentation

◆ _base_name

const std::string ComputeStrainBase::_base_name

protected

Base name of the material system.

Definition at line 44 of file ComputeStrainBase.h.

Referenced by ComputeStrainBase().

◆ _current_elem_volume

const Real& ComputeStrainBase::_current_elem_volume

protected

Definition at line 56 of file ComputeStrainBase.h.

Referenced by Compute2DFiniteStrain::computeProperties(), Compute2DSmallStrain::computeProperties(), ComputeFiniteStrain::computeProperties(), ComputeIncrementalStrain::computeProperties(), and ComputeSmallStrain::computeProperties().

◆ _disp

std::vector<const VariableValue *> ComputeStrainBase::_disp

protected

Displacement variables.

Definition at line 38 of file ComputeStrainBase.h.

Referenced by ComputeAxisymmetric1DFiniteStrain::computeGradDispZZ(), ComputeAxisymmetric1DIncrementalStrain::computeGradDispZZ(), ComputeAxisymmetricRZFiniteStrain::computeOutOfPlaneGradDisp(), ComputeAxisymmetricRZIncrementalStrain::computeOutOfPlaneGradDisp(), ComputeAxisymmetricRZSmallStrain::computeOutOfPlaneStrain(), ComputeRSphericalFiniteStrain::computeProperties(), ComputeRSphericalSmallStrain::computeProperties(), ComputeStrainBase(), ComputeAxisymmetric1DSmallStrain::computeStrainZZ(), ComputeRSphericalIncrementalStrain::computeTotalStrainIncrement(), Compute2DFiniteStrain::initialSetup(), Compute2DIncrementalStrain::initialSetup(), and Compute2DSmallStrain::initialSetup().

◆ _eigenstrain_names

std::vector<MaterialPropertyName> ComputeStrainBase::_eigenstrain_names

protected

Definition at line 50 of file ComputeStrainBase.h.

Referenced by ComputeIncrementalStrainBase::ComputeIncrementalStrainBase(), and ComputeStrainBase().

◆ _eigenstrains

std::vector<const MaterialProperty<RankTwoTensor> *> ComputeStrainBase::_eigenstrains

protected

Definition at line 51 of file ComputeStrainBase.h.

Referenced by Compute1DSmallStrain::computeProperties(), Compute2DSmallStrain::computeProperties(), ComputeRSphericalSmallStrain::computeProperties(), ComputeSmallStrain::computeProperties(), ComputeCosseratSmallStrain::computeQpProperties(), ComputeCrackTipEnrichmentSmallStrain::computeQpProperties(), ComputeStrainBase(), and ComputeIncrementalStrainBase::subtractEigenstrainIncrementFromStrain().

◆ _global_strain

const MaterialProperty<RankTwoTensor>* const ComputeStrainBase::_global_strain

protected

Definition at line 53 of file ComputeStrainBase.h.

Referenced by ComputeSmallStrain::computeProperties(), and ComputeFiniteStrain::computeQpStrain().

◆ _grad_disp

std::vector<const VariableGradient *> ComputeStrainBase::_grad_disp

protected

Gradient of displacements.

Definition at line 41 of file ComputeStrainBase.h.

◆ _mechanical_strain

MaterialProperty<RankTwoTensor>& ComputeStrainBase::_mechanical_strain

protected

Definition at line 46 of file ComputeStrainBase.h.

Referenced by Compute1DSmallStrain::computeProperties(), Compute2DSmallStrain::computeProperties(), ComputeIncrementalStrain::computeProperties(), ComputeRSphericalSmallStrain::computeProperties(), ComputeSmallStrain::computeProperties(), ComputeCosseratIncrementalSmallStrain::computeQpProperties(), ComputeCosseratSmallStrain::computeQpProperties(), ComputeCrackTipEnrichmentSmallStrain::computeQpProperties(), ComputeFiniteStrain::computeQpStrain(), ComputeIncrementalStrainBase::initQpStatefulProperties(), and initQpStatefulProperties().

◆ _ndisp

unsigned int ComputeStrainBase::_ndisp

protected

Coupled displacement variables.

Definition at line 35 of file ComputeStrainBase.h.

Referenced by ComputeCrackTipEnrichmentSmallStrain::ComputeCrackTipEnrichmentSmallStrain(), ComputeCrackTipEnrichmentSmallStrain::computeQpProperties(), ComputeStrainBase(), displacementIntegrityCheck(), Compute2DFiniteStrain::displacementIntegrityCheck(), Compute2DIncrementalStrain::displacementIntegrityCheck(), Compute2DSmallStrain::displacementIntegrityCheck(), and ComputeIncrementalStrainBase::initialSetup().

◆ _total_strain

MaterialProperty<RankTwoTensor>& ComputeStrainBase::_total_strain

protected

Definition at line 48 of file ComputeStrainBase.h.

Referenced by Compute1DSmallStrain::computeProperties(), Compute2DSmallStrain::computeProperties(), ComputeIncrementalStrain::computeProperties(), ComputeRSphericalSmallStrain::computeProperties(), ComputeSmallStrain::computeProperties(), ComputeCosseratIncrementalSmallStrain::computeQpProperties(), ComputeCosseratSmallStrain::computeQpProperties(), ComputeCrackTipEnrichmentSmallStrain::computeQpProperties(), ComputeFiniteStrain::computeQpStrain(), ComputeIncrementalStrainBase::initQpStatefulProperties(), and initQpStatefulProperties().

◆ _volumetric_locking_correction

const bool ComputeStrainBase::_volumetric_locking_correction

protected

Definition at line 55 of file ComputeStrainBase.h.

Referenced by Compute2DFiniteStrain::computeProperties(), Compute2DSmallStrain::computeProperties(), ComputeFiniteStrain::computeProperties(), ComputeIncrementalStrain::computeProperties(), ComputeSmallStrain::computeProperties(), and ComputeStrainBase().

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

solid_mechanics/include/materials/ComputeStrainBase.h
solid_mechanics/src/materials/ComputeStrainBase.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ComputeStrainBase()

Member Function Documentation

◆ displacementIntegrityCheck()

◆ initialSetup()

◆ initQpStatefulProperties()

◆ validParams()

Member Data Documentation

◆ _base_name

◆ _current_elem_volume

◆ _disp

◆ _eigenstrain_names

◆ _eigenstrains

◆ _global_strain

◆ _grad_disp

◆ _mechanical_strain

◆ _ndisp

◆ _total_strain

◆ _volumetric_locking_correction