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

RadialReturnStressUpdate computes the radial return stress increment for an isotropic viscoplasticity plasticity model after interating on the difference between new and old trial stress increments. More...

#include <RadialReturnStressUpdate.h>

Inheritance diagram for RadialReturnStressUpdate:
[legend]

Public Member Functions

 RadialReturnStressUpdate (const InputParameters &parameters, const std::string inelastic_strain_name="")
 
virtual void updateState (RankTwoTensor &strain_increment, RankTwoTensor &inelastic_strain_increment, const RankTwoTensor &rotation_increment, RankTwoTensor &stress_new, const RankTwoTensor &stress_old, const RankFourTensor &elasticity_tensor, const RankTwoTensor &elastic_strain_old, bool compute_full_tangent_operator, RankFourTensor &tangent_operator) override
 A radial return (J2) mapping method is performed with return mapping iterations. More...
 
virtual Real computeReferenceResidual (const Real effective_trial_stress, const Real scalar_effective_inelastic_strain) override
 Compute a reference quantity to be used for checking relative convergence. More...
 
virtual Real maximumPermissibleValue (const Real effective_trial_stress) const override
 Compute the maximum permissible value of the scalar. More...
 
virtual Real computeTimeStepLimit () override
 Compute the limiting value of the time step for this material. More...
 
bool requiresIsotropicTensor () override
 Does the model require the elasticity tensor to be isotropic? More...
 
void setQp (unsigned int qp)
 Sets the value of the global variable _qp for inheriting classes. More...
 
virtual void propagateQpStatefulProperties ()
 If updateState is not called during a timestep, this will be. More...
 
void setMaxIts (unsigned int max_its)
 Functions for setting old default tolerances with legacy_return_mapping: More...
 
void setRelativeTolerance (Real relative_tolerance)
 
void setAbsoluteTolerance (Real absolute_tolerance)
 
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 initQpStatefulProperties () override
 
void propagateQpStatefulPropertiesRadialReturn ()
 Propagate the properties pertaining to this intermediate class. More...
 
virtual void computeStressInitialize (const Real, const RankFourTensor &)
 Perform any necessary initialization before return mapping iterations. More...
 
virtual void computeStressFinalize (const RankTwoTensor &)
 Perform any necessary steps to finalize state after return mapping iterations. More...
 
void returnMappingSolve (const Real effective_trial_stress, Real &scalar, const ConsoleStream &console)
 Perform the return mapping iterations. More...
 
virtual Real computeResidual (const Real effective_trial_stress, const Real scalar)=0
 Compute the residual for a predicted value of the scalar. More...
 
virtual Real computeDerivative (const Real effective_trial_stress, const Real scalar)=0
 Compute the derivative of the residual as a function of the scalar variable. More...
 
virtual void iterationFinalize (Real)
 Finalize internal state variables for a model for a given iteration. More...
 

Protected Attributes

Real _three_shear_modulus
 3 * shear modulus More...
 
MaterialProperty< Real > & _effective_inelastic_strain
 
const MaterialProperty< Real > & _effective_inelastic_strain_old
 
Real _max_inelastic_increment
 
bool _legacy_return_mapping
 Whether to use the legacy return mapping algorithm and compute residuals in the legacy manner. More...
 
bool _check_range
 Whether to check to see whether iterative solution is within admissible range, and set within that range if outside. More...
 

Detailed Description

RadialReturnStressUpdate computes the radial return stress increment for an isotropic viscoplasticity plasticity model after interating on the difference between new and old trial stress increments.

This radial return mapping class acts as a base class for the radial return creep and plasticity classes / combinations. The stress increment computed by RadialReturnStressUpdate is used by ComputeRadialReturnMappingStress which computes the elastic stress for finite strains. This return mapping class is acceptable for finite strains but not total strains. This class is based on the Elasto-viscoplasticity algorithm in F. Dunne and N. Petrinic's Introduction to Computational Plasticity (2004) Oxford University Press.

Definition at line 32 of file RadialReturnStressUpdate.h.

Constructor & Destructor Documentation

RadialReturnStressUpdate::RadialReturnStressUpdate ( const InputParameters &  parameters,
const std::string  inelastic_strain_name = "" 
)

Definition at line 28 of file RadialReturnStressUpdate.C.

30  : StressUpdateBase(parameters),
33  declareProperty<Real>("effective_" + inelastic_strain_name + "_strain")),
35  getMaterialPropertyOld<Real>("effective_" + inelastic_strain_name + "_strain")),
36  _max_inelastic_increment(parameters.get<Real>("max_inelastic_increment"))
37 {
38 }
SingleVariableReturnMappingSolution(const InputParameters &parameters)
const MaterialProperty< Real > & _effective_inelastic_strain_old
MaterialProperty< Real > & _effective_inelastic_strain
StressUpdateBase(const InputParameters &parameters)

Member Function Documentation

virtual Real SingleVariableReturnMappingSolution::computeDerivative ( const Real  effective_trial_stress,
const Real  scalar 
)
protectedpure virtualinherited

Compute the derivative of the residual as a function of the scalar variable.

The residual should be in strain increment units for all models for consistency.

Parameters
effective_trial_stressEffective trial stress
scalarInelastic strain increment magnitude being solved for

Implemented in IsotropicPlasticityStressUpdate, PowerLawCreepStressUpdate, IsotropicPlasticity, CLSHPlasticModel, and PowerLawCreepModel.

Referenced by SingleVariableReturnMappingSolution::internalSolve(), SingleVariableReturnMappingSolution::internalSolveLegacy(), and SingleVariableReturnMappingSolution::setAbsoluteTolerance().

Real RadialReturnStressUpdate::computeReferenceResidual ( const Real  effective_trial_stress,
const Real  scalar 
)
overridevirtual

Compute a reference quantity to be used for checking relative convergence.

This should be in strain increment units for all models for consistency.

Parameters
effective_trial_stressEffective trial stress
scalarInelastic strain increment magnitude being solved for

Implements SingleVariableReturnMappingSolution.

Definition at line 106 of file RadialReturnStressUpdate.C.

108 {
109  return effective_trial_stress / _three_shear_modulus - scalar_effective_inelastic_strain;
110 }
Real _three_shear_modulus
3 * shear modulus
virtual Real SingleVariableReturnMappingSolution::computeResidual ( const Real  effective_trial_stress,
const Real  scalar 
)
protectedpure virtualinherited

Compute the residual for a predicted value of the scalar.

This residual should be in strain increment units for all models for consistency.

Parameters
effective_trial_stressEffective trial stress
scalarInelastic strain increment magnitude being solved for

Implemented in IsotropicPlasticityStressUpdate, PowerLawCreepStressUpdate, IsotropicPlasticity, CLSHPlasticModel, and PowerLawCreepModel.

Referenced by SingleVariableReturnMappingSolution::internalSolve(), SingleVariableReturnMappingSolution::internalSolveLegacy(), and SingleVariableReturnMappingSolution::setAbsoluteTolerance().

virtual void RadialReturnStressUpdate::computeStressFinalize ( const RankTwoTensor &  )
inlineprotectedvirtual

Perform any necessary steps to finalize state after return mapping iterations.

Parameters
inelasticStrainIncrementInelastic strain increment

Reimplemented in IsotropicPlasticityStressUpdate, and PowerLawCreepStressUpdate.

Definition at line 104 of file RadialReturnStressUpdate.h.

Referenced by updateState().

104 {}
virtual void RadialReturnStressUpdate::computeStressInitialize ( const Real  ,
const RankFourTensor &   
)
inlineprotectedvirtual

Perform any necessary initialization before return mapping iterations.

Parameters
effective_trial_stressEffective trial stress
elasticityTensorElasticity tensor

Reimplemented in IsotropicPlasticityStressUpdate, IsotropicPowerLawHardeningStressUpdate, PowerLawCreepStressUpdate, and TemperatureDependentHardeningStressUpdate.

Definition at line 95 of file RadialReturnStressUpdate.h.

Referenced by updateState().

97  {
98  }
Real RadialReturnStressUpdate::computeTimeStepLimit ( )
overridevirtual

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

Returns
Limiting time step

Reimplemented from StressUpdateBase.

Definition at line 119 of file RadialReturnStressUpdate.C.

120 {
121  Real scalar_inelastic_strain_incr;
122 
123  scalar_inelastic_strain_incr =
125  if (MooseUtils::absoluteFuzzyEqual(scalar_inelastic_strain_incr, 0.0))
126  return std::numeric_limits<Real>::max();
127 
128  return _dt * _max_inelastic_increment / scalar_inelastic_strain_incr;
129 }
const MaterialProperty< Real > & _effective_inelastic_strain_old
MaterialProperty< Real > & _effective_inelastic_strain
void RadialReturnStressUpdate::initQpStatefulProperties ( )
overrideprotectedvirtual

Reimplemented in IsotropicPlasticityStressUpdate, and PowerLawCreepStressUpdate.

Definition at line 41 of file RadialReturnStressUpdate.C.

Referenced by requiresIsotropicTensor().

42 {
44 }
MaterialProperty< Real > & _effective_inelastic_strain
virtual void SingleVariableReturnMappingSolution::iterationFinalize ( Real  )
inlineprotectedvirtualinherited

Finalize internal state variables for a model for a given iteration.

Parameters
scalarInelastic strain increment magnitude being solved for

Reimplemented in IsotropicPlasticityStressUpdate, IsotropicPlasticity, and CLSHPlasticModel.

Definition at line 79 of file SingleVariableReturnMappingSolution.h.

Referenced by SingleVariableReturnMappingSolution::internalSolve(), and SingleVariableReturnMappingSolution::internalSolveLegacy().

79 {}
Real RadialReturnStressUpdate::maximumPermissibleValue ( const Real  effective_trial_stress) const
overridevirtual

Compute the maximum permissible value of the scalar.

For some models, the magnitude of this may be known.

Parameters
effective_trial_stressEffective trial stress

Reimplemented from SingleVariableReturnMappingSolution.

Definition at line 113 of file RadialReturnStressUpdate.C.

114 {
115  return effective_trial_stress / _three_shear_modulus;
116 }
Real _three_shear_modulus
3 * shear modulus
void StressUpdateBase::propagateQpStatefulProperties ( )
virtualinherited

If updateState is not called during a timestep, this will be.

This method allows derived classes to set internal parameters from their Old values, for instance

Reimplemented in MultiParameterPlasticityStressUpdate, LinearViscoelasticStressUpdate, IsotropicPlasticityStressUpdate, and PowerLawCreepStressUpdate.

Definition at line 36 of file StressUpdateBase.C.

37 {
38  mooseError(
39  "propagateQpStatefulProperties called: it needs to be implemented by your inelastic model");
40 }
void RadialReturnStressUpdate::propagateQpStatefulPropertiesRadialReturn ( )
protected

Propagate the properties pertaining to this intermediate class.

This is intended to be called from propagateQpStatefulProperties() in classes that inherit from this one. This is intentionally named uniquely because almost all models that derive from this class have their own stateful properties, and this forces them to define their own implementations of propagateQpStatefulProperties().

Definition at line 47 of file RadialReturnStressUpdate.C.

Referenced by PowerLawCreepStressUpdate::propagateQpStatefulProperties(), IsotropicPlasticityStressUpdate::propagateQpStatefulProperties(), and requiresIsotropicTensor().

48 {
50 }
const MaterialProperty< Real > & _effective_inelastic_strain_old
MaterialProperty< Real > & _effective_inelastic_strain
bool RadialReturnStressUpdate::requiresIsotropicTensor ( )
inlineoverridevirtual

Does the model require the elasticity tensor to be isotropic?

Implements StressUpdateBase.

Definition at line 75 of file RadialReturnStressUpdate.h.

75 { return true; }
void StressUpdateBase::resetProperties ( )
inlinefinalinherited

Definition at line 93 of file StressUpdateBase.h.

93 {}
void StressUpdateBase::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 92 of file StressUpdateBase.h.

92 {}
void SingleVariableReturnMappingSolution::returnMappingSolve ( const Real  effective_trial_stress,
Real &  scalar,
const ConsoleStream &  console 
)
protectedinherited

Perform the return mapping iterations.

Parameters
effective_trial_stressEffective trial stress
scalarInelastic strain increment magnitude being solved for
consoleConsole output

Definition at line 91 of file SingleVariableReturnMappingSolution.C.

Referenced by ReturnMappingModel::computeStress(), SingleVariableReturnMappingSolution::setAbsoluteTolerance(), and updateState().

94 {
95  std::stringstream iter_output;
96  std::stringstream * iter_output_ptr = (_output_iteration_info ? &iter_output : nullptr);
97 
99  {
100  if (!internalSolve(effective_trial_stress, scalar, iter_output_ptr))
101  {
102  if (iter_output_ptr)
103  mooseError(iter_output_ptr->str());
104  else
105  {
106  internalSolve(effective_trial_stress, scalar, &iter_output);
107  mooseError(iter_output.str());
108  }
109  }
110  else if (iter_output_ptr)
111  console << iter_output_ptr->str();
112  }
113  else
114  {
115  if (!internalSolveLegacy(effective_trial_stress, scalar, iter_output_ptr))
116  {
117  if (iter_output_ptr)
118  mooseError(iter_output_ptr->str());
119  else
120  {
121  internalSolveLegacy(effective_trial_stress, scalar, &iter_output);
122  mooseError(iter_output.str());
123  }
124  }
125  else if (iter_output_ptr)
126  console << iter_output_ptr->str();
127  }
128 }
bool internalSolveLegacy(const Real effective_trial_stress, Real &scalar, std::stringstream *iter_output)
Method called from within this class to perform the actual return mappping iterations.
bool internalSolve(const Real effective_trial_stress, Real &scalar, std::stringstream *iter_output)
Method called from within this class to perform the actual return mappping iterations.
bool _legacy_return_mapping
Whether to use the legacy return mapping algorithm and compute residuals in the legacy manner...
const bool _output_iteration_info
Whether to output iteration information all the time (regardless of whether iterations converge) ...
void SingleVariableReturnMappingSolution::setAbsoluteTolerance ( Real  absolute_tolerance)
inlineinherited

Definition at line 31 of file SingleVariableReturnMappingSolution.h.

31 { _absolute_tolerance = absolute_tolerance; }
Real _absolute_tolerance
Absolute convergence tolerance.
void SingleVariableReturnMappingSolution::setMaxIts ( unsigned int  max_its)
inlineinherited

Functions for setting old default tolerances with legacy_return_mapping:

Definition at line 29 of file SingleVariableReturnMappingSolution.h.

29 { _max_its = max_its; }
unsigned int _max_its
Maximum number of return mapping iterations (used only in legacy return mapping)
void StressUpdateBase::setQp ( unsigned int  qp)
inherited

Sets the value of the global variable _qp for inheriting classes.

Definition at line 30 of file StressUpdateBase.C.

31 {
32  _qp = qp;
33 }
void SingleVariableReturnMappingSolution::setRelativeTolerance ( Real  relative_tolerance)
inlineinherited

Definition at line 30 of file SingleVariableReturnMappingSolution.h.

30 { _relative_tolerance = relative_tolerance; }
Real _relative_tolerance
Relative convergence tolerance.
void RadialReturnStressUpdate::updateState ( RankTwoTensor &  strain_increment,
RankTwoTensor &  inelastic_strain_increment,
const RankTwoTensor &  rotation_increment,
RankTwoTensor &  stress_new,
const RankTwoTensor &  stress_old,
const RankFourTensor &  elasticity_tensor,
const RankTwoTensor &  elastic_strain_old,
bool  compute_full_tangent_operator,
RankFourTensor &  tangent_operator 
)
overridevirtual

A radial return (J2) mapping method is performed with return mapping iterations.

Parameters
strain_incrementSum of elastic and inelastic strain increments
inelastic_strain_incrementInelastic strain increment calculated by this class
rotationincrement Not used by this class
stress_newNew trial stress from pure elastic calculation
stress_oldOld state of stress
elasticity_tensorRank 4 C_{ijkl}, must be isotropic
elastic_strain_oldOld state of total elastic strain
compute_full_tangent_operatorFlag currently unused by this class
tangent_operatorCurrently a copy of the elasticity tensor in this class

Note! The tangent operator for this class, and derived class is currently just the elasticity tensor, irrespective of compute_full_tangent_operator

Implements StressUpdateBase.

Definition at line 53 of file RadialReturnStressUpdate.C.

62 {
63  // compute the deviatoric trial stress and trial strain from the current intermediate
64  // configuration
65  RankTwoTensor deviatoric_trial_stress = stress_new.deviatoric();
66 
67  // compute the effective trial stress
68  Real dev_trial_stress_squared =
69  deviatoric_trial_stress.doubleContraction(deviatoric_trial_stress);
70  Real effective_trial_stress = std::sqrt(3.0 / 2.0 * dev_trial_stress_squared);
71 
72  // Set the value of 3 * shear modulus for use as a reference residual value
74 
75  computeStressInitialize(effective_trial_stress, elasticity_tensor);
76 
77  // Use Newton iteration to determine the scalar effective inelastic strain increment
78  Real scalar_effective_inelastic_strain = 0;
79  returnMappingSolve(effective_trial_stress, scalar_effective_inelastic_strain, _console);
80 
81  if (scalar_effective_inelastic_strain != 0.0)
82  inelastic_strain_increment = deviatoric_trial_stress *
83  (1.5 * scalar_effective_inelastic_strain / effective_trial_stress);
84  else
85  inelastic_strain_increment.zero();
86 
87  strain_increment -= inelastic_strain_increment;
89  _effective_inelastic_strain_old[_qp] + scalar_effective_inelastic_strain;
90 
91  // Use the old elastic strain here because we require tensors used by this class
92  // to be isotropic and this method natively allows for changing in time
93  // elasticity tensors
94  stress_new = elasticity_tensor * (strain_increment + elastic_strain_old);
95 
96  computeStressFinalize(inelastic_strain_increment);
97 
102  tangent_operator = elasticity_tensor;
103 }
virtual void computeStressInitialize(const Real, const RankFourTensor &)
Perform any necessary initialization before return mapping iterations.
const MaterialProperty< Real > & _effective_inelastic_strain_old
virtual void computeStressFinalize(const RankTwoTensor &)
Perform any necessary steps to finalize state after return mapping iterations.
void returnMappingSolve(const Real effective_trial_stress, Real &scalar, const ConsoleStream &console)
Perform the return mapping iterations.
MaterialProperty< Real > & _effective_inelastic_strain
Real getIsotropicShearModulus(const RankFourTensor &elasticity_tensor)
Get the shear modulus for an isotropic elasticity tensor param elasticity_tensor the tensor (must be ...
Real _three_shear_modulus
3 * shear modulus

Member Data Documentation

bool SingleVariableReturnMappingSolution::_check_range
protectedinherited

Whether to check to see whether iterative solution is within admissible range, and set within that range if outside.

Definition at line 86 of file SingleVariableReturnMappingSolution.h.

Referenced by SingleVariableReturnMappingSolution::internalSolve(), and SingleVariableReturnMappingSolution::SingleVariableReturnMappingSolution().

MaterialProperty<Real>& RadialReturnStressUpdate::_effective_inelastic_strain
protected
const MaterialProperty<Real>& RadialReturnStressUpdate::_effective_inelastic_strain_old
protected
bool SingleVariableReturnMappingSolution::_legacy_return_mapping
protectedinherited
Real RadialReturnStressUpdate::_max_inelastic_increment
protected

Definition at line 111 of file RadialReturnStressUpdate.h.

Referenced by computeTimeStepLimit().

Real RadialReturnStressUpdate::_three_shear_modulus
protected

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