SumTensorIncrements update a tensor by summing tensor increments passed as property. More...

#include <SumTensorIncrements.h>

Inheritance diagram for SumTensorIncrements:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	SumTensorIncrements (const InputParameters &parameters)

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 ()

virtual void	computeQpProperties ()

Protected Attributes
std::vector< MaterialPropertyName >	_property_names

unsigned int	_num_property

MaterialProperty< RankTwoTensor > &	_tensor

const MaterialProperty< RankTwoTensor > &	_tensor_old

MaterialProperty< RankTwoTensor > &	_tensor_increment

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

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

SumTensorIncrements update a tensor by summing tensor increments passed as property.

Definition at line 19 of file SumTensorIncrements.h.

Constructor & Destructor Documentation

◆ SumTensorIncrements()

SumTensorIncrements::SumTensorIncrements ( const InputParameters & parameters )

Definition at line 26 of file SumTensorIncrements.C.

  : DerivativeMaterialInterface<Material>(parameters),
    _property_names(getParam<std::vector<MaterialPropertyName>>("coupled_tensor_increment_names")),
    _tensor(declareProperty<RankTwoTensor>(getParam<MaterialPropertyName>("tensor_name"))),
    _tensor_old(
        getMaterialPropertyOld<RankTwoTensor>(getParam<MaterialPropertyName>("tensor_name"))),
    _tensor_increment(declareProperty<RankTwoTensor>(getParam<MaterialPropertyName>("tensor_name") +
                                                     "_increment"))
{
  _num_property = _property_names.size();
 
  if (_num_property > 0)
  {
    _coupled_tensor_increments.resize(_num_property);
 
    for (unsigned int i = 0; i < _num_property; ++i)
      _coupled_tensor_increments[i] = &getMaterialProperty<RankTwoTensor>(_property_names[i]);
  }
}

Member Function Documentation

◆ computeQpProperties()

void SumTensorIncrements::computeQpProperties ( )

protectedvirtual

Definition at line 54 of file SumTensorIncrements.C.

{
  _tensor_increment[_qp].zero();
 
  for (unsigned int i = 0; i < _num_property; ++i)
    _tensor_increment[_qp] += (*_coupled_tensor_increments[i])[_qp];
 
  _tensor[_qp] = _tensor_old[_qp] + _tensor_increment[_qp];
}

◆ initQpStatefulProperties()

void SumTensorIncrements::initQpStatefulProperties ( )

protectedvirtual

Definition at line 47 of file SumTensorIncrements.C.

{
  _tensor[_qp].zero();
  _tensor_increment[_qp].zero();
}

◆ validParams()

InputParameters SumTensorIncrements::validParams ( )

static

Definition at line 16 of file SumTensorIncrements.C.

{
  InputParameters params = Material::validParams();
  params.addClassDescription("Compute tensor property by summing tensor increments");
  params.addRequiredParam<MaterialPropertyName>("tensor_name", "Name of strain property");
  params.addParam<std::vector<MaterialPropertyName>>("coupled_tensor_increment_names",
                                                     "Name of strain increment properties");
  return params;
}

Member Data Documentation

◆ _coupled_tensor_increments

std::vector<const MaterialProperty<RankTwoTensor> *> SumTensorIncrements::_coupled_tensor_increments

protected

Definition at line 37 of file SumTensorIncrements.h.

Referenced by computeQpProperties(), and SumTensorIncrements().

◆ _num_property

unsigned int SumTensorIncrements::_num_property

protected

Definition at line 31 of file SumTensorIncrements.h.

Referenced by computeQpProperties(), and SumTensorIncrements().

◆ _property_names

std::vector<MaterialPropertyName> SumTensorIncrements::_property_names

protected

Definition at line 30 of file SumTensorIncrements.h.

Referenced by SumTensorIncrements().

◆ _tensor

MaterialProperty<RankTwoTensor>& SumTensorIncrements::_tensor

protected

Definition at line 33 of file SumTensorIncrements.h.

Referenced by computeQpProperties(), and initQpStatefulProperties().

◆ _tensor_increment

MaterialProperty<RankTwoTensor>& SumTensorIncrements::_tensor_increment

protected

Definition at line 35 of file SumTensorIncrements.h.

Referenced by computeQpProperties(), and initQpStatefulProperties().

◆ _tensor_old

const MaterialProperty<RankTwoTensor>& SumTensorIncrements::_tensor_old

protected

Definition at line 34 of file SumTensorIncrements.h.

Referenced by computeQpProperties().

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

solid_mechanics/include/materials/SumTensorIncrements.h
solid_mechanics/src/materials/SumTensorIncrements.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

◆ SumTensorIncrements()

Member Function Documentation

◆ computeQpProperties()

◆ initQpStatefulProperties()

◆ validParams()

Member Data Documentation

◆ _coupled_tensor_increments

◆ _num_property

◆ _property_names

◆ _tensor

◆ _tensor_increment

◆ _tensor_old