Base class for scalar damage models. More...

#include <ScalarDamageBase.h>

Inheritance diagram for ScalarDamageBase:

Public Member Functions
	ScalarDamageBase (const InputParameters &parameters)

virtual void	initQpStatefulProperties () override

virtual void	updateDamage () override
	Update the internal variable(s) that evolve the damage. More...

virtual void	updateStressForDamage (RankTwoTensor &stress_new) override
	Update the current stress tensor for effects of damage. More...

virtual void	updateJacobianMultForDamage (RankFourTensor &jacobian_mult) override
	Update the material constitutive matrix. More...

virtual void	computeUndamagedOldStress (RankTwoTensor &stress_old) override

virtual Real	computeTimeStepLimit () override
	Compute the limiting value of the time step for this material. More...

const Real &	getQpDamageIndex (unsigned int qp)

const std::string	getDamageIndexName () const

virtual void	finiteStrainRotation (const RankTwoTensor &rotation_increment)
	Perform any necessary rotation of internal variables for finite strain. More...

void	setQp (unsigned int qp)
	Sets the value of the member variable _qp for use in inheriting classes. More...


void	resetQpProperties () final
	Retained as empty methods to avoid a warning from Material.C in framework. These methods are unused in all inheriting classes and should not be overwritten. More...

void	resetProperties () final

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual void	updateQpDamageIndex ()=0
	Update the damage index at the current qpoint. More...

Protected Attributes
const std::string	_damage_index_name
	Name of the material property where the damage index is stored. More...

const bool	_use_old_damage
	If true, use the damage index from the old state (rather than the current state) More...

const Real &	_residual_stiffness_fraction
	Residual fraction of stiffness used for material that is fully damaged. More...

const Real &	_maximum_damage_increment
	Maximum damage increment allowed for the time step. More...

const std::string	_base_name
	Base name optionally used as prefix to material tensor names. More...


MaterialProperty< Real > &	_damage_index
	Material property that provides the damage index. More...

const MaterialProperty< Real > &	_damage_index_old

const MaterialProperty< Real > &	_damage_index_older

Detailed Description

Base class for scalar damage models.

Definition at line 23 of file ScalarDamageBase.h.

Constructor & Destructor Documentation

◆ ScalarDamageBase()

ScalarDamageBase::ScalarDamageBase ( const InputParameters & parameters )

Definition at line 41 of file ScalarDamageBase.C.

   : DamageBase(parameters),
     _damage_index_name(getParam<std::string>("damage_index_name")),
     _damage_index(declareProperty<Real>(_base_name + _damage_index_name)),
     _damage_index_old(getMaterialPropertyOld<Real>(_base_name + _damage_index_name)),
     _damage_index_older(getMaterialPropertyOlder<Real>(_base_name + _damage_index_name)),
     _use_old_damage(getParam<bool>("use_old_damage")),
     _residual_stiffness_fraction(getParam<Real>("residual_stiffness_fraction")),
     _maximum_damage_increment(getParam<Real>("maximum_damage_increment"))
 {
 }

Member Function Documentation

◆ computeTimeStepLimit()

Real ScalarDamageBase::computeTimeStepLimit ( )

overridevirtual

Compute the limiting value of the time step for this material.

Returns: Limiting time step

Reimplemented from DamageBase.

Definition at line 100 of file ScalarDamageBase.C.

 {
   Real current_damage_increment = (_damage_index[_qp] - _damage_index_old[_qp]);
   if (MooseUtils::absoluteFuzzyEqual(current_damage_increment, 0.0))
     return std::numeric_limits<Real>::max();
  
   return _dt * _maximum_damage_increment / current_damage_increment;
 }

◆ computeUndamagedOldStress()

void ScalarDamageBase::computeUndamagedOldStress ( RankTwoTensor & stress_old )

overridevirtual

Implements DamageBase.

Definition at line 83 of file ScalarDamageBase.C.

 {
   Real damage_index_old =
       std::max((1.0 - (_use_old_damage ? _damage_index_older[_qp] : _damage_index_old[_qp])), 0.0);
  
   if (damage_index_old > 0.0)
     stress_old /= damage_index_old;
 }

◆ finiteStrainRotation()

void DamageBase::finiteStrainRotation ( const RankTwoTensor & rotation_increment )

virtualinherited

Perform any necessary rotation of internal variables for finite strain.

Parameters

rotation_increment The finite-strain rotation increment

Definition at line 57 of file DamageBase.C.

58 {

59 }

Referenced by ComputeDamageStress::computeQpStress(), and ComputeMultipleInelasticStress::computeQpStress().

◆ getDamageIndexName()

const std::string ScalarDamageBase::getDamageIndexName ( ) const

inline

Definition at line 44 of file ScalarDamageBase.h.

44 { return _damage_index_name; }

◆ getQpDamageIndex()

const Real & ScalarDamageBase::getQpDamageIndex ( unsigned int qp )

Definition at line 60 of file ScalarDamageBase.C.

 {
   setQp(qp);
   updateQpDamageIndex();
   return _damage_index[_qp];
 }

Referenced by CombinedScalarDamage::updateQpDamageIndex().

◆ initQpStatefulProperties()

void ScalarDamageBase::initQpStatefulProperties ( )

overridevirtual

Definition at line 54 of file ScalarDamageBase.C.

 {
   _damage_index[_qp] = 0.0;
 }

◆ resetProperties()

void DamageBase::resetProperties ( )

inlinefinalinherited

Definition at line 72 of file DamageBase.h.

72 {}

◆ resetQpProperties()

void DamageBase::resetQpProperties ( )

inlinefinalinherited

Retained as empty methods to avoid a warning from Material.C in framework. These methods are unused in all inheriting classes and should not be overwritten.

Definition at line 71 of file DamageBase.h.

71 {}

◆ setQp()

void DamageBase::setQp ( unsigned int qp )

inherited

Sets the value of the member variable _qp for use in inheriting classes.

Definition at line 40 of file DamageBase.C.

 {
   _qp = qp;
 }

Referenced by ComputeDamageStress::computeQpStress(), ComputeMultipleInelasticStress::computeQpStress(), and getQpDamageIndex().

◆ updateDamage()

void ScalarDamageBase::updateDamage ( )

overridevirtual

Update the internal variable(s) that evolve the damage.

Reimplemented from DamageBase.

Definition at line 68 of file ScalarDamageBase.C.

 {
   updateQpDamageIndex();
 }

◆ updateJacobianMultForDamage()

void ScalarDamageBase::updateJacobianMultForDamage ( RankFourTensor & jacobian_mult )

overridevirtual

Update the material constitutive matrix.

Parameters

jacobian_mult Material constitutive matrix to be modified for effects of damage

Implements DamageBase.

Definition at line 93 of file ScalarDamageBase.C.

 {
   jacobian_mult *= std::max((1.0 - (_use_old_damage ? _damage_index_old[_qp] : _damage_index[_qp])),
                             _residual_stiffness_fraction);
 }

◆ updateQpDamageIndex()

virtual void ScalarDamageBase::updateQpDamageIndex ( )

protectedpure virtual

Update the damage index at the current qpoint.

Implemented in CombinedScalarDamage, and ScalarMaterialDamage.

Referenced by getQpDamageIndex(), and updateDamage().

◆ updateStressForDamage()

void ScalarDamageBase::updateStressForDamage ( RankTwoTensor & stress_new )

overridevirtual

Update the current stress tensor for effects of damage.

Parameters

stress_new Undamaged stress to be modified by the damage model

Implements DamageBase.

Definition at line 74 of file ScalarDamageBase.C.

 {
   // Avoid multiplying by a small negative number, which could occur if damage_index
   // is slightly greater than 1.0
   stress_new *=
       std::max((1.0 - (_use_old_damage ? _damage_index_old[_qp] : _damage_index[_qp])), 0.0);
 }

◆ validParams()

InputParameters ScalarDamageBase::validParams ( )

static

Definition at line 16 of file ScalarDamageBase.C.

 {
   InputParameters params = DamageBase::validParams();
   params.addClassDescription("Base class for damage model based on a scalar damage parameter");
   params.addParam<bool>(
       "use_old_damage",
       false,
       "Whether to use the damage index from the previous step in the stress computation");
   params.addRangeCheckedParam<Real>(
       "residual_stiffness_fraction",
       1.e-8,
       "residual_stiffness_fraction>=0 & residual_stiffness_fraction<1",
       "Minimum fraction of original material stiffness retained for fully "
       "damaged material (when damage_index=1)");
   params.addRangeCheckedParam<Real>(
       "maximum_damage_increment",
       0.1,
       "maximum_damage_increment>0 & maximum_damage_increment<1",
       "maximum damage increment allowed for simulations with adaptive time step");
   params.addParam<std::string>("damage_index_name",
                                "damage_index",
                                "name of the material property where the damage index is stored");
   return params;
 }

Referenced by CombinedScalarDamage::validParams(), and ScalarMaterialDamage::validParams().

Member Data Documentation

◆ _base_name

const std::string DamageBase::_base_name

protectedinherited

Base name optionally used as prefix to material tensor names.

Definition at line 77 of file DamageBase.h.

Referenced by ScalarMaterialDamage::updateQpDamageIndex().

◆ _damage_index

MaterialProperty<Real>& ScalarDamageBase::_damage_index

protected

Material property that provides the damage index.

Definition at line 54 of file ScalarDamageBase.h.

Referenced by computeTimeStepLimit(), getQpDamageIndex(), initQpStatefulProperties(), updateJacobianMultForDamage(), ScalarMaterialDamage::updateQpDamageIndex(), CombinedScalarDamage::updateQpDamageIndex(), and updateStressForDamage().

◆ _damage_index_name

const std::string ScalarDamageBase::_damage_index_name

protected

Name of the material property where the damage index is stored.

Definition at line 48 of file ScalarDamageBase.h.

Referenced by getDamageIndexName().

◆ _damage_index_old

const MaterialProperty<Real>& ScalarDamageBase::_damage_index_old

protected

Definition at line 55 of file ScalarDamageBase.h.

Referenced by computeTimeStepLimit(), computeUndamagedOldStress(), updateJacobianMultForDamage(), CombinedScalarDamage::updateQpDamageIndex(), and updateStressForDamage().

◆ _damage_index_older

const MaterialProperty<Real>& ScalarDamageBase::_damage_index_older

protected

Definition at line 56 of file ScalarDamageBase.h.

Referenced by computeUndamagedOldStress().

◆ _maximum_damage_increment

const Real& ScalarDamageBase::_maximum_damage_increment

protected

Maximum damage increment allowed for the time step.

Definition at line 66 of file ScalarDamageBase.h.

Referenced by computeTimeStepLimit().

◆ _residual_stiffness_fraction

const Real& ScalarDamageBase::_residual_stiffness_fraction

protected

Residual fraction of stiffness used for material that is fully damaged.

Definition at line 63 of file ScalarDamageBase.h.

Referenced by updateJacobianMultForDamage().

◆ _use_old_damage

const bool ScalarDamageBase::_use_old_damage

protected

If true, use the damage index from the old state (rather than the current state)

Definition at line 60 of file ScalarDamageBase.h.

Referenced by computeUndamagedOldStress(), updateJacobianMultForDamage(), and updateStressForDamage().

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

tensor_mechanics/include/materials/ScalarDamageBase.h
tensor_mechanics/src/materials/ScalarDamageBase.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ScalarDamageBase()

Member Function Documentation

◆ computeTimeStepLimit()

◆ computeUndamagedOldStress()

◆ finiteStrainRotation()

◆ getDamageIndexName()

◆ getQpDamageIndex()

◆ initQpStatefulProperties()

◆ resetProperties()

◆ resetQpProperties()

◆ setQp()

◆ updateDamage()

◆ updateJacobianMultForDamage()

◆ updateQpDamageIndex()

◆ updateStressForDamage()

◆ validParams()

Member Data Documentation

◆ _base_name

◆ _damage_index

◆ _damage_index_name

◆ _damage_index_old

◆ _damage_index_older

◆ _maximum_damage_increment

◆ _residual_stiffness_fraction

◆ _use_old_damage