www.mooseframework.org
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ScalarDamageBase Class Referenceabstract

Base class for scalar damage models. More...

#include <ScalarDamageBase.h>

Inheritance diagram for ScalarDamageBase:
[legend]

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

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
 

Detailed Description

Base class for scalar damage models.

Definition at line 24 of file ScalarDamageBase.h.

Constructor & Destructor Documentation

◆ ScalarDamageBase()

ScalarDamageBase::ScalarDamageBase ( const InputParameters &  parameters)

Definition at line 40 of file ScalarDamageBase.C.

41  : DamageBase(parameters),
42  _damage_index_name(getParam<std::string>("damage_index_name")),
43  _damage_index(declareProperty<Real>(_base_name + _damage_index_name)),
44  _damage_index_old(getMaterialPropertyOld<Real>(_base_name + _damage_index_name)),
45  _use_old_damage(getParam<bool>("use_old_damage")),
46  _residual_stiffness_fraction(getParam<Real>("residual_stiffness_fraction")),
47  _maximum_damage_increment(getParam<Real>("maximum_damage_increment"))
48 {
49 }
const bool _use_old_damage
If true, use the damage index from the old state (rather than the current state)
DamageBase(const InputParameters &parameters)
Definition: DamageBase.C:32
const std::string _base_name
Base name optionally used as prefix to material tensor names.
Definition: DamageBase.h:75
const std::string _damage_index_name
Name of the material property where the damage index is stored.
const MaterialProperty< Real > & _damage_index_old
const Real & _maximum_damage_increment
Maximum damage increment allowed for the time step.
const Real & _residual_stiffness_fraction
Residual fraction of stiffness used for material that is fully damaged.
MaterialProperty< Real > & _damage_index
Material property that provides the damage index.

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 88 of file ScalarDamageBase.C.

89 {
90  Real current_damage_increment = (_damage_index[_qp] - _damage_index_old[_qp]);
91  if (MooseUtils::absoluteFuzzyEqual(current_damage_increment, 0.0))
92  return std::numeric_limits<Real>::max();
93 
94  return _dt * _maximum_damage_increment / current_damage_increment;
95 }
const MaterialProperty< Real > & _damage_index_old
const Real & _maximum_damage_increment
Maximum damage increment allowed for the time step.
MaterialProperty< Real > & _damage_index
Material property that provides the damage index.

◆ finiteStrainRotation()

void DamageBase::finiteStrainRotation ( const RankTwoTensor &  rotation_increment)
virtualinherited

Perform any necessary rotation of internal variables for finite strain.

Parameters
rotation_incrementThe finite-strain rotation increment

Definition at line 56 of file DamageBase.C.

Referenced by ComputeDamageStress::computeQpStress().

57 {
58 }

◆ getDamageIndexName()

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

Definition at line 41 of file ScalarDamageBase.h.

41 { return _damage_index_name; }
const std::string _damage_index_name
Name of the material property where the damage index is stored.

◆ getQpDamageIndex()

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

Definition at line 58 of file ScalarDamageBase.C.

Referenced by CombinedScalarDamage::updateQpDamageIndex().

59 {
60  setQp(qp);
62  return _damage_index[_qp];
63 }
void setQp(unsigned int qp)
Sets the value of the member variable _qp for use in inheriting classes.
Definition: DamageBase.C:39
virtual void updateQpDamageIndex()=0
Update the damage index at the current qpoint.
MaterialProperty< Real > & _damage_index
Material property that provides the damage index.

◆ initQpStatefulProperties()

void ScalarDamageBase::initQpStatefulProperties ( )
overridevirtual

Definition at line 52 of file ScalarDamageBase.C.

53 {
54  _damage_index[_qp] = 0.0;
55 }
MaterialProperty< Real > & _damage_index
Material property that provides the damage index.

◆ resetProperties()

void DamageBase::resetProperties ( )
inlinefinalinherited

Definition at line 70 of file DamageBase.h.

70 {}

◆ 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 69 of file DamageBase.h.

69 {}

◆ setQp()

void DamageBase::setQp ( unsigned int  qp)
inherited

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

Definition at line 39 of file DamageBase.C.

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

40 {
41  _qp = qp;
42 }

◆ updateDamage()

void ScalarDamageBase::updateDamage ( )
overridevirtual

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

Reimplemented from DamageBase.

Definition at line 66 of file ScalarDamageBase.C.

67 {
69 }
virtual void updateQpDamageIndex()=0
Update the damage index at the current qpoint.

◆ updateJacobianMultForDamage()

void ScalarDamageBase::updateJacobianMultForDamage ( RankFourTensor &  jacobian_mult)
overridevirtual

Update the material constitutive matrix.

Parameters
jacobian_multMaterial constitutive matrix to be modified for effects of damage

Implements DamageBase.

Definition at line 81 of file ScalarDamageBase.C.

82 {
83  jacobian_mult *= std::max((1.0 - (_use_old_damage ? _damage_index_old[_qp] : _damage_index[_qp])),
85 }
const bool _use_old_damage
If true, use the damage index from the old state (rather than the current state)
const MaterialProperty< Real > & _damage_index_old
const Real & _residual_stiffness_fraction
Residual fraction of stiffness used for material that is fully damaged.
MaterialProperty< Real > & _damage_index
Material property that provides the damage index.

◆ 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_newUndamaged stress to be modified by the damage model

Implements DamageBase.

Definition at line 72 of file ScalarDamageBase.C.

73 {
74  // Avoid multiplying by a small negative number, which could occur if damage_index
75  // is slightly greater than 1.0
76  stress_new *=
77  std::max((1.0 - (_use_old_damage ? _damage_index_old[_qp] : _damage_index[_qp])), 0.0);
78 }
const bool _use_old_damage
If true, use the damage index from the old state (rather than the current state)
const MaterialProperty< Real > & _damage_index_old
MaterialProperty< Real > & _damage_index
Material property that provides the damage index.

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 75 of file DamageBase.h.

Referenced by ScalarMaterialDamage::updateQpDamageIndex().

◆ _damage_index

MaterialProperty<Real>& ScalarDamageBase::_damage_index
protected

◆ _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 45 of file ScalarDamageBase.h.

Referenced by getDamageIndexName().

◆ _damage_index_old

const MaterialProperty<Real>& ScalarDamageBase::_damage_index_old
protected

◆ _maximum_damage_increment

const Real& ScalarDamageBase::_maximum_damage_increment
protected

Maximum damage increment allowed for the time step.

Definition at line 62 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 59 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 56 of file ScalarDamageBase.h.

Referenced by updateJacobianMultForDamage(), and updateStressForDamage().


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