https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
IsotropicPlasticityStressUpdateTempl< is_ad > Class Template Reference

This class uses the Discrete material in a radial return isotropic plasticity model. More...

#include <IsotropicPlasticityStressUpdate.h>

Inheritance diagram for IsotropicPlasticityStressUpdateTempl< is_ad >:
[legend]

Public Types

enum  SubsteppingType { SubsteppingType::NONE, SubsteppingType::ERROR_BASED, SubsteppingType::INCREMENT_BASED }
 
using GR2 = GenericRankTwoTensor< is_ad >
 
using GSR2 = Moose::GenericType< RankTwoTensor, is_ad >
 
using GR4 = GenericRankFourTensor< is_ad >
 
using GSR4 = Moose::GenericType< RankFourTensor, is_ad >
 
enum  ConstantTypeEnum { ConstantTypeEnum::NONE, ConstantTypeEnum::ELEMENT, ConstantTypeEnum::SUBDOMAIN }
 
enum  TEST_TYPE
 
typedef DataFileName DataFileParameterType
 

Public Member Functions

 IsotropicPlasticityStressUpdateTempl (const InputParameters &parameters)
 
virtual void computeStressInitialize (const GenericReal< is_ad > &effective_trial_stress, const GenericRankFourTensor< is_ad > &elasticity_tensor) override
 Perform any necessary initialization before return mapping iterations. More...
 
virtual GenericReal< is_ad > computeResidual (const GenericReal< is_ad > &effective_trial_stress, const GenericReal< is_ad > &scalar) override
 Compute the residual for a predicted value of the scalar. More...
 
virtual GenericReal< is_ad > computeDerivative (const GenericReal< is_ad > &effective_trial_stress, const GenericReal< is_ad > &scalar) override
 Compute the derivative of the residual as a function of the scalar variable. More...
 
virtual void computeYieldStress (const GenericRankFourTensor< is_ad > &elasticity_tensor)
 
GenericReal< is_ad > yieldCondition () const
 
virtual void computeStressFinalize (const GenericRankTwoTensor< is_ad > &plastic_strain_increment) override
 Perform any necessary steps to finalize state after return mapping iterations. More...
 
virtual void updateState (GenericRankTwoTensor< is_ad > &strain_increment, GenericRankTwoTensor< is_ad > &inelastic_strain_increment, const GenericRankTwoTensor< is_ad > &rotation_increment, GenericRankTwoTensor< is_ad > &stress_new, const RankTwoTensor &stress_old, const GenericRankFourTensor< is_ad > &elasticity_tensor, const RankTwoTensor &elastic_strain_old, bool compute_full_tangent_operator=false, RankFourTensor &tangent_operator=StressUpdateBaseTempl< is_ad >::_identityTensor) override
 A radial return (J2) mapping method is performed with return mapping iterations. More...
 
virtual void updateState (GR2 &strain_increment, GR2 &inelastic_strain_increment, const GR2 &rotation_increment, GR2 &stress_new, const RankTwoTensor &stress_old, const GR4 &elasticity_tensor, const RankTwoTensor &elastic_strain_old, bool compute_full_tangent_operator=false, RankFourTensor &tangent_operator=StressUpdateBaseTempl< is_ad >::_identityTensor)
 Given a strain increment that results in a trial stress, perform some procedure (such as an iterative return-mapping process) to produce an admissible stress, an elastic strain increment and an inelastic strain increment. More...
 
virtual void updateStateSubstepInternal (GenericRankTwoTensor< is_ad > &, GenericRankTwoTensor< is_ad > &, const GenericRankTwoTensor< is_ad > &, GenericRankTwoTensor< is_ad > &, const RankTwoTensor &, const GenericRankFourTensor< is_ad > &, const RankTwoTensor &, unsigned int total_number_substeps, bool compute_full_tangent_operator=false, RankFourTensor &tangent_operator=StressUpdateBaseTempl< is_ad >::_identityTensor)
 
virtual void updateStateSubstep (GenericRankTwoTensor< is_ad > &, GenericRankTwoTensor< is_ad > &, const GenericRankTwoTensor< is_ad > &, GenericRankTwoTensor< is_ad > &, const RankTwoTensor &, const GenericRankFourTensor< is_ad > &, const RankTwoTensor &, bool compute_full_tangent_operator=false, RankFourTensor &tangent_operator=StressUpdateBaseTempl< is_ad >::_identityTensor) override
 Similar to the updateState function, this method updates the strain and stress for one substep. More...
 
virtual void updateStateSubstep (GR2 &, GR2 &, const GR2 &, GR2 &, const RankTwoTensor &, const GR4 &, const RankTwoTensor &, bool compute_full_tangent_operator=false, RankFourTensor &tangent_operator=StressUpdateBaseTempl< is_ad >::_identityTensor)
 Similar to the updateState function, this method updates the strain and stress for one substep. More...
 
virtual Real computeReferenceResidual (const GenericReal< is_ad > &effective_trial_stress, const GenericReal< is_ad > &scalar_effective_inelastic_strain) override
 Compute a reference quantity to be used for checking relative convergence. More...
 
virtual GenericReal< is_ad > minimumPermissibleValue (const GenericReal< is_ad > &) const override
 Compute the minimum permissible value of the scalar. More...
 
virtual GenericReal< is_ad > maximumPermissibleValue (const GenericReal< is_ad > &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...
 
bool isIsotropic () override
 Radial return mapped models should be isotropic by default! More...
 
virtual int calculateNumberSubsteps (const GenericRankTwoTensor< is_ad > &strain_increment) override
 If substepping is enabled, calculate the number of substeps as a function of the elastic strain increment guess and the maximum inelastic strain increment ratio based on a user-specified tolerance. More...
 
virtual int calculateNumberSubsteps (const GR2 &)
 Given the elastic strain increment compute the number of substeps required to bring a substepped trial stress guess distance from the yield surface into the tolerance specified in the individual child class. More...
 
virtual bool substeppingCapabilityRequested () override
 Has the user requested usage of (possibly) implemented substepping capability for inelastic models. More...
 
const GenericReal< is_ad > & effectiveInelasticStrainIncrement () const
 Current value of scalar inelastic strain. More...
 
void updateEffectiveInelasticStrainIncrement (const GenericReal< is_ad > &eisi)
 
void updateEffectiveInelasticStrain (const GenericReal< is_ad > &increment)
 
void computeTangentOperator (Real effective_trial_stress, const RankTwoTensor &stress_new, RankFourTensor &tangent_operator)
 Calculate the tangent_operator. More...
 
template<>
void computeTangentOperator (Real effective_trial_stress, const RankTwoTensor &stress_new, RankFourTensor &tangent_operator)
 
template<>
void computeTangentOperator (Real effective_trial_stress, const RankTwoTensor &stress_new, RankFourTensor &tangent_operator)
 
void setQp (unsigned int qp)
 Sets the value of the global variable _qp for inheriting classes. More...
 
virtual TangentCalculationMethod getTangentCalculationMethod ()
 
TangentCalculationMethod getTangentCalculationMethod ()
 
virtual bool substeppingCapabilityEnabled ()
 Does the model include the infrastructure for substep decomposition of the elastic strain initially used to calculate the trial stress guess Inheriting classes which wish to use the substepping capability should overwrite this method and set it to return true. More...
 
virtual void storeIncrementalMaterialProperties (const unsigned int)
 Properly set up the incremental calculation storage of the stateful material properties in the inheriting classes. More...
 
virtual void resetIncrementalMaterialProperties ()
 Reset material properties. More...
 
virtual Real computeStrainEnergyRateDensity (const GenericMaterialProperty< RankTwoTensor, is_ad > &, const GenericMaterialProperty< RankTwoTensor, is_ad > &)
 Compute the strain energy rate density for this inelastic model for the current step. More...
 
virtual const dof_id_typegetElementID (const std::string &id_parameter_name, unsigned int comp=0) const override
 
dof_id_type getElementID (const Elem *elem, unsigned int elem_id_index) const
 
virtual const dof_id_typegetElementIDNeighbor (const std::string &id_parameter_name, unsigned int comp=0) const override
 
virtual const dof_id_typegetElementIDByName (const std::string &id_parameter_name) const override
 
virtual const dof_id_typegetElementIDNeighborByName (const std::string &id_parameter_name) const override
 
virtual void computeProperties () override
 
MaterialBasegetMaterial (const std::string &name)
 
MaterialBasegetMaterialByName (const std::string &name, bool no_warn=false, bool no_dep=false)
 
MaterialBasegetMaterialByName (const std::string &name, bool no_warn=false)
 
MaterialBasegetMaterialByName (const std::string &name, bool no_warn=false)
 
virtual bool isBoundaryMaterial () const override
 
virtual const std::unordered_set< unsigned int > & getMatPropDependencies () const override
 
virtual void subdomainSetup () override
 
bool ghostable () const override final
 
virtual void resolveOptionalProperties () override
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
virtual void initStatefulProperties (unsigned int n_points)
 
virtual bool isInterfaceMaterial ()
 
virtual void computePropertiesAtQp (unsigned int qp)
 
const MaterialProperty< T > & getZeroMaterialPropertyByName (Ts... args)
 
virtual const std::set< std::string > & getRequestedItems () override
 
virtual const std::set< std::string > & getSuppliedItems () override
 
const std::set< unsigned int > & getSuppliedPropIDs ()
 
void checkStatefulSanity () const
 
std::set< OutputName > getOutputs ()
 
bool hasStatefulProperties () const
 
void setFaceInfo (const FaceInfo &fi)
 
void setActiveProperties (const std::unordered_set< unsigned int > &needed_props)
 
bool forceStatefulInit () const
 
virtual bool enabled () const
 
std::shared_ptr< MooseObjectgetSharedPtr ()
 
std::shared_ptr< const MooseObjectgetSharedPtr () const
 
MooseAppgetMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParametersparameters () const
 
MooseObjectName uniqueName () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &nm) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
const std::vector< SubdomainName > & blocks () const
 
unsigned int numBlocks () const
 
virtual const std::set< SubdomainID > & blockIDs () const
 
unsigned int blocksMaxDimension () const
 
bool hasBlocks (const SubdomainName &name) const
 
bool hasBlocks (const std::vector< SubdomainName > &names) const
 
bool hasBlocks (const std::set< SubdomainName > &names) const
 
bool hasBlocks (SubdomainID id) const
 
bool hasBlocks (const std::vector< SubdomainID > &ids) const
 
bool hasBlocks (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::vector< SubdomainID > &ids) const
 
bool hasBlockMaterialProperty (const std::string &prop_name)
 
const std::set< SubdomainID > & meshBlockIDs () const
 
virtual bool blockRestricted () const
 
virtual void checkVariable (const MooseVariableFieldBase &variable) const
 
virtual const std::set< BoundaryID > & boundaryIDs () const
 
const std::vector< BoundaryName > & boundaryNames () const
 
unsigned int numBoundaryIDs () const
 
bool hasBoundary (const BoundaryName &name) const
 
bool hasBoundary (const std::vector< BoundaryName > &names) const
 
bool hasBoundary (const BoundaryID &id) const
 
bool hasBoundary (const std::vector< BoundaryID > &ids, TEST_TYPE type=ALL) const
 
bool hasBoundary (const std::set< BoundaryID > &ids, TEST_TYPE type=ALL) const
 
bool isBoundarySubset (const std::set< BoundaryID > &ids) const
 
bool isBoundarySubset (const std::vector< BoundaryID > &ids) const
 
bool hasBoundaryMaterialProperty (const std::string &prop_name) const
 
virtual bool boundaryRestricted () const
 
const std::set< BoundaryID > & meshBoundaryIDs () const
 
virtual bool checkVariableBoundaryIntegrity () const
 
virtual void initialSetup ()
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnumgetExecuteOnEnum () const
 
const std::set< MooseVariableFieldBase *> & getMooseVariableDependencies () const
 
std::set< MooseVariableFieldBase *> checkAllVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_omit={})
 
std::set< MooseVariableFieldBase *> checkVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
void addMooseVariableDependency (MooseVariableFieldBase *var)
 
void addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)
 
const std::vector< MooseVariableScalar *> & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
const FunctiongetFunction (const std::string &name) const
 
const FunctiongetFunctionByName (const FunctionName &name) const
 
bool hasFunction (const std::string &param_name) const
 
bool hasFunctionByName (const FunctionName &name) const
 
UserObjectName getUserObjectName (const std::string &param_name) const
 
const T & getUserObject (const std::string &param_name, bool is_dependency=true) const
 
const T & getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const UserObjectgetUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObjectgetUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
bool isImplicit ()
 
Moose::StateArg determineState () const
 
bool isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessor (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessorByName (const PostprocessorName &name) const
 
std::size_t coupledPostprocessors (const std::string &param_name) const
 
const PostprocessorName & getPostprocessorName (const std::string &param_name, const unsigned int index=0) const
 
const VectorPostprocessorValuegetVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
 
const VectorPostprocessorName & getVectorPostprocessorName (const std::string &param_name) const
 
virtual void meshChanged ()
 
void buildOutputHideVariableList (std::set< std::string > variable_names)
 
void setRandomResetFrequency (ExecFlagType exec_flag)
 
unsigned long getRandomLong () const
 
Real getRandomReal () const
 
unsigned int getSeed (std::size_t id)
 
unsigned int getMasterSeed () const
 
bool isNodal () const
 
ExecFlagType getResetOnTime () const
 
void setRandomDataPointer (RandomData *random_data)
 
virtual unsigned int getElementIDIndex (const std::string &id_parameter_name, unsigned int comp=0) const
 
virtual unsigned int getElementIDIndexByName (const std::string &id_name) const
 
bool hasElementID (const std::string &id_name) const
 
dof_id_type maxElementID (unsigned int elem_id_index) const
 
dof_id_type minElementID (unsigned int elem_id_index) const
 
bool areElemIDsIdentical (const std::string &id_name1, const std::string &id_name2) const
 
std::unordered_map< dof_id_type, std::set< dof_id_type > > getElemIDMapping (const std::string &id_name1, const std::string &id_name2) const
 
std::set< dof_id_typegetAllElemIDs (unsigned int elem_id_index) const
 
std::set< dof_id_typegetElemIDsOnBlocks (unsigned int elem_id_index, const std::set< SubdomainID > &blks) const
 
const std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> > & getCoupledVars () const
 
const std::vector< MooseVariableFieldBase *> & getCoupledMooseVars () const
 
const std::vector< MooseVariable *> & getCoupledStandardMooseVars () const
 
const std::vector< VectorMooseVariable *> & getCoupledVectorMooseVars () const
 
const std::vector< ArrayMooseVariable *> & getCoupledArrayMooseVars () const
 
void addFEVariableCoupleableVectorTag (TagID tag)
 
void addFEVariableCoupleableMatrixTag (TagID tag)
 
std::set< TagID > & getFEVariableCoupleableVectorTags ()
 
const std::set< TagID > & getFEVariableCoupleableVectorTags () const
 
std::set< TagID > & getFEVariableCoupleableMatrixTags ()
 
const std::set< TagID > & getFEVariableCoupleableMatrixTags () const
 
auto & getWritableCoupledVariables () const
 
bool hasWritableCoupledVariables () const
 
const ADVariableValuegetADDefaultValue (const std::string &var_name) const
 
const ADVectorVariableValuegetADDefaultVectorValue (const std::string &var_name) const
 
const ADVariableGradientgetADDefaultGradient () const
 
const ADVectorVariableGradientgetADDefaultVectorGradient () const
 
const ADVariableSecondgetADDefaultSecond () const
 
const ADVectorVariableCurlgetADDefaultCurl () const
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const std::string &prop_name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const std::string &prop_name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const std::string &prop_name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const std::string &prop_name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const std::string &prop_name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const std::string &prop_name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const std::string &prop_name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const std::string &prop_name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (const MaterialPropertyName &name)
 
std::set< SubdomainIDgetMaterialPropertyBlocks (const std::string &name)
 
std::vector< SubdomainName > getMaterialPropertyBlockNames (const std::string &name)
 
std::set< BoundaryIDgetMaterialPropertyBoundaryIDs (const std::string &name)
 
std::vector< BoundaryName > getMaterialPropertyBoundaryNames (const std::string &name)
 
void checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
 
std::unordered_map< SubdomainID, std::vector< MaterialBase *> > buildRequiredMaterials (bool allow_stateful=true)
 
void statefulPropertiesAllowed (bool)
 
bool getMaterialPropertyCalled () const
 
const GenericMaterialProperty< T, is_ad > & getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
MaterialProperty< T > & declarePropertyByName (const std::string &prop_name)
 
MaterialProperty< T > & declarePropertyByName (const std::string &prop_name)
 
MaterialProperty< T > & declareProperty (const std::string &name)
 
MaterialProperty< T > & declareProperty (const std::string &name)
 
ADMaterialProperty< T > & declareADPropertyByName (const std::string &prop_name)
 
ADMaterialProperty< T > & declareADPropertyByName (const std::string &prop_name)
 
ADMaterialProperty< T > & declareADProperty (const std::string &name)
 
ADMaterialProperty< T > & declareADProperty (const std::string &name)
 
auto & declareGenericProperty (const std::string &prop_name)
 
auto & declareGenericProperty (const std::string &prop_name)
 
GenericMaterialProperty< T, is_ad > & declareGenericPropertyByName (const std::string &prop_name)
 
GenericMaterialProperty< T, is_ad > & declareGenericPropertyByName (const std::string &prop_name)
 
const DistributiongetDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const DistributiongetDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const DistributiongetDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const DistributiongetDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
const PostprocessorValuegetPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValuegetPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValuegetPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOlderByName (const PostprocessorName &name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
PenetrationLocatorgetPenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
 
PenetrationLocatorgetQuadraturePenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
 
NearestNodeLocatorgetNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
 
NearestNodeLocatorgetQuadratureNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
 
bool requiresGeometricSearch () const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 
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 ()
 
static std::deque< MaterialBase *> buildRequiredMaterials (const Consumers &mat_consumers, const std::vector< std::shared_ptr< MaterialBase >> &mats, const bool allow_stateful)
 
static bool restricted (const std::set< BoundaryID > &ids)
 
static void sort (typename std::vector< T > &vector)
 
static void sortDFS (typename std::vector< T > &vector)
 
static void cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)
 
static std::string deduceFunctorName (const std::string &name, const InputParameters &params)
 

Public Attributes

unsigned int _qp
 
const Elem *const & _current_elem
 
Real_dt
 
const MooseArray< Point > & _q_point
 
 ALL
 
 ANY
 
const ConsoleStream _console
 

Static Public Attributes

static constexpr PropertyValue::id_type default_property_id
 
static constexpr PropertyValue::id_type zero_property_id
 

Protected Types

enum  QP_Data_Type
 

Protected Member Functions

virtual void initQpStatefulProperties () override
 
virtual void propagateQpStatefulProperties () override
 If updateState is not called during a timestep, this will be. More...
 
virtual void iterationFinalize (const GenericReal< is_ad > &scalar) override
 Finalize internal state variables for a model for a given iteration. More...
 
virtual GenericReal< is_ad > computeHardeningValue (const GenericReal< is_ad > &scalar)
 
virtual GenericReal< is_ad > computeHardeningDerivative (const GenericReal< is_ad > &scalar)
 
void propagateQpStatefulPropertiesRadialReturn ()
 Propagate the properties pertaining to this intermediate class. More...
 
virtual Real computeStressDerivative (const Real, const Real)
 Calculate the derivative of the strain increment with respect to the updated stress. More...
 
void outputIterationSummary (std::stringstream *iter_output, const unsigned int total_it) override
 Output summary information for the convergence history of the model. More...
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state) override
 
virtual const MaterialDatamaterialData () const override
 
virtual MaterialDatamaterialData () override
 
virtual const QBase & qRule () const override
 
virtual void computeQpProperties ()
 
virtual const FEProblemBasemiProblem () const
 
virtual FEProblemBasemiProblem ()
 
bool isPropertyActive (const unsigned int prop_id) const
 
void registerPropName (const std::string &prop_name, bool is_get, const unsigned int state)
 
void checkExecutionStage ()
 
void checkExecutionStage ()
 
virtual bool hasBlockMaterialPropertyHelper (const std::string &prop_name)
 
void initializeBlockRestrictable (const MooseObject *moose_object)
 
Moose::CoordinateSystemType getBlockCoordSystem ()
 
bool hasBoundaryMaterialPropertyHelper (const std::string &prop_name) const
 
bool isCoupledScalar (const std::string &var_name, unsigned int i=0) const
 
unsigned int coupledScalarComponents (const std::string &var_name) const
 
unsigned int coupledScalar (const std::string &var_name, unsigned int comp=0) const
 
libMesh::Order coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< is_ad > & coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const VariableValuecoupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValuecoupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValuecoupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const MooseVariableScalargetScalarVar (const std::string &var_name, unsigned int comp) const
 
virtual void addUserObjectDependencyHelper (const UserObject &) const
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &) const
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const
 
T & declareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< T > declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const T & getRestartableData (const std::string &data_name) const
 
T & declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
T & declareRecoverableData (const std::string &data_name, Args &&... args)
 
T & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
T & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
 
std::string restartableName (const std::string &data_name) const
 
std::string deduceFunctorName (const std::string &name) const
 
const Moose::Functor< T > & getFunctor (const std::string &name)
 
const Moose::Functor< T > & getFunctor (const std::string &name, THREAD_ID tid)
 
const Moose::Functor< T > & getFunctor (const std::string &name, SubProblem &subproblem)
 
const Moose::Functor< T > & getFunctor (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
 
bool isFunctor (const std::string &name) const
 
bool isFunctor (const std::string &name, const SubProblem &subproblem) const
 
Moose::ElemArg makeElemArg (const Elem *elem, bool correct_skewnewss=false) const
 
void checkFunctorSupportsSideIntegration (const std::string &name, bool qp_integration)
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 
virtual void coupledCallback (const std::string &, bool) const
 
virtual bool isCoupled (const std::string &var_name, unsigned int i=0) const
 
virtual bool isCoupledConstant (const std::string &var_name) const
 
unsigned int coupledComponents (const std::string &var_name) const
 
VariableName coupledName (const std::string &var_name, unsigned int comp=0) const
 
std::vector< VariableName > coupledNames (const std::string &var_name) const
 
virtual unsigned int coupled (const std::string &var_name, unsigned int comp=0) const
 
std::vector< unsigned intcoupledIndices (const std::string &var_name) const
 
virtual const VariableValuecoupledValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValues (const std::string &var_name) const
 
std::vector< const VectorVariableValue *> coupledVectorValues (const std::string &var_name) const
 
const GenericVariableValue< is_ad > & coupledGenericValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericValue (const std::string &var_name, unsigned int comp) const
 
const GenericVectorVariableValue< is_ad > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVectorVariableValue< false > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const
 
const GenericVectorVariableValue< true > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const
 
std::vector< const GenericVariableValue< is_ad > *> coupledGenericValues (const std::string &var_name) const
 
std::vector< const GenericVariableValue< false > *> coupledGenericValues (const std::string &var_name) const
 
std::vector< const GenericVariableValue< true > *> coupledGenericValues (const std::string &var_name) const
 
const GenericVariableValue< is_ad > & coupledGenericDofValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDofValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDofValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< is_ad > & coupledGenericDot (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< is_ad > & coupledGenericDotDot (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDotDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDotDot (const std::string &var_name, unsigned int comp) const
 
virtual const VariableValuecoupledValueLower (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableValue *> adCoupledValues (const std::string &var_name) const
 
const ADVariableValueadCoupledLowerValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableValueadCoupledVectorValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVectorVariableValue *> adCoupledVectorValues (const std::string &var_name) const
 
virtual const VariableValuecoupledVectorTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableValuecoupledVectorTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableValue *> coupledVectorTagValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue *> coupledVectorTagValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const ArrayVariableValuecoupledVectorTagArrayValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const ArrayVariableValuecoupledVectorTagArrayValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const ArrayVariableValue *> coupledVectorTagArrayValues (const std::string &var_names, TagID tag) const
 
std::vector< const ArrayVariableValue *> coupledVectorTagArrayValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableGradientcoupledVectorTagGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableGradientcoupledVectorTagGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableGradient *> coupledVectorTagGradients (const std::string &var_names, TagID tag) const
 
std::vector< const VariableGradient *> coupledVectorTagGradients (const std::string &var_names, const std::string &tag_name) const
 
virtual const ArrayVariableGradientcoupledVectorTagArrayGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const ArrayVariableGradientcoupledVectorTagArrayGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const ArrayVariableGradient *> coupledVectorTagArrayGradients (const std::string &var_names, TagID tag) const
 
std::vector< const ArrayVariableGradient *> coupledVectorTagArrayGradients (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableValuecoupledVectorTagDofValue (const std::string &var_name, TagID tag, unsigned int index=0) const
 
virtual const VariableValuecoupledVectorTagDofValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
const ArrayVariableValuecoupledVectorTagArrayDofValue (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledVectorTagDofValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue *> coupledVectorTagDofValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableValuecoupledMatrixTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableValuecoupledMatrixTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableValue *> coupledMatrixTagValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue *> coupledMatrixTagValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VectorVariableValuecoupledVectorValue (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ArrayVariableValue *> coupledArrayValues (const std::string &var_name) const
 
MooseWritableVariablewritableVariable (const std::string &var_name, unsigned int comp=0)
 
virtual VariableValuewritableCoupledValue (const std::string &var_name, unsigned int comp=0)
 
void checkWritableVar (MooseWritableVariable *var)
 
virtual const VariableValuecoupledValueOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValuesOld (const std::string &var_name) const
 
std::vector< const VectorVariableValue *> coupledVectorValuesOld (const std::string &var_name) const
 
virtual const VariableValuecoupledValueOlder (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValuesOlder (const std::string &var_name) const
 
virtual const VariableValuecoupledValuePreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorValueOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorValueOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayValueOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayValueOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradient (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableGradient *> coupledGradients (const std::string &var_name) const
 
const ADVariableGradientadCoupledGradient (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableGradientadCoupledGradientDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableGradient *> adCoupledGradients (const std::string &var_name) const
 
const GenericVariableGradient< is_ad > & coupledGenericGradient (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableGradient< false > & coupledGenericGradient (const std::string &var_name, unsigned int comp) const
 
const GenericVariableGradient< true > & coupledGenericGradient (const std::string &var_name, unsigned int comp) const
 
std::vector< const GenericVariableGradient< is_ad > *> coupledGenericGradients (const std::string &var_name) const
 
std::vector< const GenericVariableGradient< false > *> coupledGenericGradients (const std::string &var_name) const
 
std::vector< const GenericVariableGradient< true > *> coupledGenericGradients (const std::string &var_name) const
 
const ADVectorVariableGradientadCoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableSecondadCoupledSecond (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableSecondadCoupledVectorSecond (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradientOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableGradient *> coupledGradientsOld (const std::string &var_name) const
 
virtual const VariableGradientcoupledGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradientPreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradientDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradientDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradientcoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradientcoupledVectorGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradientcoupledVectorGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradientcoupledArrayGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradientcoupledArrayGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradientcoupledArrayGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradientcoupledArrayGradientDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurlcoupledCurl (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurlcoupledCurlOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurlcoupledCurlOlder (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableCurladCoupledCurl (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergencecoupledDiv (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergencecoupledDivOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergencecoupledDivOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecondcoupledSecond (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecondcoupledSecondOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecondcoupledSecondOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecondcoupledSecondPreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledDots (const std::string &var_name) const
 
virtual const VariableValuecoupledDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableValue *> adCoupledDots (const std::string &var_name) const
 
const ADVariableValueadCoupledDotDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableValueadCoupledVectorDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledVectorDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledVectorDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledArrayDotDu (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValue (const std::string &var_name, unsigned int comp=0) const
 
const Moose::ADType< T >::typeadCoupledNodalValue (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValueOld (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValuePreviousNL (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledNodalDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledNodalDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledNodalDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDofValues (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValues (const std::string &var_name) const
 
virtual const VariableValuecoupledDofValuesOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValuesOld (const std::string &var_name) const
 
virtual const VariableValuecoupledDofValuesOlder (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValuesOlder (const std::string &var_name) const
 
virtual const ArrayVariableValuecoupledArrayDofValues (const std::string &var_name, unsigned int comp=0) const
 
virtual const ADVariableValueadCoupledDofValues (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadZeroValue () const
 
const ADVariableGradientadZeroGradient () const
 
const ADVariableSecondadZeroSecond () const
 
const GenericVariableValue< is_ad > & genericZeroValue ()
 
const GenericVariableValue< false > & genericZeroValue ()
 
const GenericVariableValue< true > & genericZeroValue ()
 
const GenericVariableGradient< is_ad > & genericZeroGradient ()
 
const GenericVariableGradient< false > & genericZeroGradient ()
 
const GenericVariableGradient< true > & genericZeroGradient ()
 
const GenericVariableSecond< is_ad > & genericZeroSecond ()
 
const GenericVariableSecond< false > & genericZeroSecond ()
 
const GenericVariableSecond< true > & genericZeroSecond ()
 
bool checkVar (const std::string &var_name, unsigned int comp=0, unsigned int comp_bound=0) const
 
const MooseVariableFieldBasegetFEVar (const std::string &var_name, unsigned int comp) const
 
const MooseVariableFieldBasegetFieldVar (const std::string &var_name, unsigned int comp) const
 
MooseVariableFieldBasegetFieldVar (const std::string &var_name, unsigned int comp)
 
const T * getVarHelper (const std::string &var_name, unsigned int comp) const
 
T * getVarHelper (const std::string &var_name, unsigned int comp)
 
MooseVariablegetVar (const std::string &var_name, unsigned int comp)
 
const MooseVariablegetVar (const std::string &var_name, unsigned int comp) const
 
VectorMooseVariablegetVectorVar (const std::string &var_name, unsigned int comp)
 
const VectorMooseVariablegetVectorVar (const std::string &var_name, unsigned int comp) const
 
ArrayMooseVariablegetArrayVar (const std::string &var_name, unsigned int comp)
 
const ArrayMooseVariablegetArrayVar (const std::string &var_name, unsigned int comp) const
 
void validateExecutionerType (const std::string &name, const std::string &fn_name) const
 
std::vector< T > coupledVectorHelper (const std::string &var_name, const Func &func) const
 
void markMatPropRequested (const std::string &)
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
void returnMappingSolve (const GenericReal< is_ad > &effective_trial_stress, GenericReal< is_ad > &scalar, const ConsoleStream &console)
 Perform the return mapping iterations. More...
 
virtual GenericReal< is_ad > initialGuess (const GenericReal< is_ad > &)
 Compute an initial guess for the value of the scalar. More...
 
virtual GenericChainedReal< is_ad > computeResidualAndDerivative (const GenericReal< is_ad > &, const GenericChainedReal< is_ad > &)
 Compute the residual and the derivative for a predicted value of the scalar. More...
 
virtual void preStep (const GenericReal< is_ad > &, const GenericReal< is_ad > &, const GenericReal< is_ad > &)
 This method is called before taking a step in the return mapping algorithm. More...
 
virtual void outputIterationStep (std::stringstream *iter_output, const GenericReal< is_ad > &effective_trial_stress, const GenericReal< is_ad > &scalar, const Real reference_residual)
 Output information for a single iteration step to build the convergence history of the model. More...
 
bool converged (const GenericReal< is_ad > &residual, const Real reference)
 Check to see whether the residual is within the convergence limits. More...
 

Protected Attributes

const std::string _plastic_prepend
 a string to prepend to the plastic strain Material Property name More...
 
const Function_yield_stress_function
 
GenericReal< is_ad > _yield_stress
 
const Real _hardening_constant
 
const Function *const _hardening_function
 
GenericReal< is_ad > _yield_condition
 
GenericReal< is_ad > _hardening_slope
 
GenericMaterialProperty< RankTwoTensor, is_ad > & _plastic_strain
 plastic strain in this model More...
 
const MaterialProperty< RankTwoTensor > & _plastic_strain_old
 old value of plastic strain More...
 
GenericMaterialProperty< Real, is_ad > & _hardening_variable
 
const MaterialProperty< Real > & _hardening_variable_old
 
const GenericVariableValue< is_ad > & _temperature
 
GenericReal< is_ad > _three_shear_modulus
 3 * shear modulus More...
 
GenericMaterialProperty< Real, is_ad > & _effective_inelastic_strain
 
const MaterialProperty< Real > & _effective_inelastic_strain_old
 
GenericReal< is_ad > _effective_inelastic_strain_increment
 Stores the scalar effective inelastic strain increment from Newton iteration. More...
 
Real _max_inelastic_increment
 Maximum allowable scalar inelastic strain increment, used to control the timestep size in conjunction with a user object. More...
 
const Real _substep_tolerance
 Used to calculate the number of substeps taken in the radial return algorithm, when substepping is enabled, based on the elastic strain increment ratio to the maximum inelastic increment. More...
 
const RankTwoTensor _identity_two
 Rank two identity tensor. More...
 
const RankFourTensor _identity_symmetric_four
 Rank four symmetric identity tensor. More...
 
const RankFourTensor _deviatoric_projection_four
 Rank four deviatoric projection tensor. More...
 
const bool _apply_strain
 Debugging option to enable specifying instead of calculating strain. More...
 
SubsteppingType _use_substepping
 Whether user has requested the use of substepping technique to improve convergence [make const later]. More...
 
const bool _adaptive_substepping
 Use adaptive substepping, cutting substep sizes until convergence is achieved. More...
 
const unsigned int _maximum_number_substeps
 Maximum number of substeps. If the calculation results in a larger number, cut overall time step. More...
 
Real _dt_original
 original timestep (to be restored after substepping is completed) More...
 
const std::string _base_name
 Name used as a prefix for all material properties related to the stress update model. More...
 
 CURR
 
 PREV
 
bool _bnd
 
bool _neighbor
 
const QBase *const & _qrule
 
const MooseArray< Real > & _JxW
 
const SubdomainID_current_subdomain_id
 
const unsigned int_current_side
 
const ConstantTypeEnum _constant_option
 
SubProblem_subproblem
 
FEProblemBase_fe_problem
 
THREAD_ID _tid
 
Assembly_assembly
 
const MooseArray< Real > & _coord
 
const MooseArray< Point > & _normals
 
MooseMesh_mesh
 
const Moose::CoordinateSystemType_coord_sys
 
std::set< std::string > _requested_props
 
std::set< std::string > _supplied_props
 
std::set< unsigned int_supplied_prop_ids
 
std::unordered_set< unsigned int_active_prop_ids
 
const bool _compute
 
std::unordered_map< unsigned int, unsigned int_props_to_min_states
 
std::vector< unsigned int_displacements
 
bool _has_stateful_property
 
bool _overrides_init_stateful_props
 
const FaceInfo_face_info
 
const bool & _enabled
 
MooseApp_app
 
const std::string _type
 
const std::string _name
 
const InputParameters_pars
 
Factory_factory
 
ActionFactory_action_factory
 
const MaterialData_blk_material_data
 
const ExecFlagEnum_execute_enum
 
const ExecFlagType_current_execute_flag
 
FEProblemBase_sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real_real_zero
 
const VariableValue_scalar_zero
 
const Point & _point_zero
 
const InputParameters_ti_params
 
FEProblemBase_ti_feproblem
 
bool _is_implicit
 
Real_t
 
const Real_t_old
 
int_t_step
 
Real_dt_old
 
bool _is_transient
 
MooseApp_restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
FEProblemBase_mci_feproblem
 
GeometricSearchData_geometric_search_data
 
bool _requires_geometric_search
 
const InputParameters_c_parameters
 
const std::string & _c_name
 
const std::string & _c_type
 
FEProblemBase_c_fe_problem
 
const SystemBase *const _c_sys
 
std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> > _coupled_vars
 
std::vector< MooseVariableFieldBase *> _coupled_moose_vars
 
std::vector< MooseVariable *> _coupled_standard_moose_vars
 
std::vector< VectorMooseVariable *> _coupled_vector_moose_vars
 
std::vector< ArrayMooseVariable *> _coupled_array_moose_vars
 
std::vector< MooseVariableFV< Real > *> _coupled_standard_fv_moose_vars
 
std::vector< MooseLinearVariableFV< Real > *> _coupled_standard_linear_fv_moose_vars
 
const std::unordered_map< std::string, std::string > & _new_to_deprecated_coupled_vars
 
bool _c_nodal
 
bool _c_is_implicit
 
const bool _c_allow_element_to_nodal_coupling
 
THREAD_ID _c_tid
 
std::unordered_map< std::string, std::vector< std::unique_ptr< VariableValue > > > _default_value
 
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADReal > > > _ad_default_value
 
std::unordered_map< std::string, std::unique_ptr< VectorVariableValue > > _default_vector_value
 
std::unordered_map< std::string, std::unique_ptr< ArrayVariableValue > > _default_array_value
 
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADRealVectorValue > > > _ad_default_vector_value
 
VariableValue _default_value_zero
 
VariableGradient _default_gradient
 
MooseArray< ADRealVectorValue_ad_default_gradient
 
MooseArray< ADRealTensorValue_ad_default_vector_gradient
 
VariableSecond _default_second
 
MooseArray< ADRealTensorValue_ad_default_second
 
MooseArray< ADRealVectorValue_ad_default_curl
 
const VariableValue_zero
 
const VariablePhiValue_phi_zero
 
const MooseArray< ADReal > & _ad_zero
 
const VariableGradient_grad_zero
 
const MooseArray< ADRealVectorValue > & _ad_grad_zero
 
const VariablePhiGradient_grad_phi_zero
 
const VariableSecond_second_zero
 
const MooseArray< ADRealTensorValue > & _ad_second_zero
 
const VariablePhiSecond_second_phi_zero
 
const VectorVariableValue_vector_zero
 
const VectorVariableCurl_vector_curl_zero
 
VectorVariableValue _default_vector_value_zero
 
VectorVariableGradient _default_vector_gradient
 
VectorVariableCurl _default_vector_curl
 
VectorVariableDivergence _default_div
 
ArrayVariableValue _default_array_value_zero
 
ArrayVariableGradient _default_array_gradient
 
bool _coupleable_neighbor
 
const InputParameters_mi_params
 
const std::string _mi_name
 
const MooseObjectName _mi_moose_object_name
 
FEProblemBase_mi_feproblem
 
SubProblem_mi_subproblem
 
const THREAD_ID _mi_tid
 
const Moose::MaterialDataType _material_data_type
 
MaterialData_material_data
 
bool _stateful_allowed
 
bool _get_material_property_called
 
std::vector< std::unique_ptr< PropertyValue > > _default_properties
 
std::unordered_set< unsigned int_material_property_dependencies
 
const MaterialPropertyName _get_suffix
 
const bool _use_interpolated_state
 
const Parallel::Communicator & _communicator
 
bool _check_range
 Whether to check to see whether iterative solution is within admissible range, and set within that range if outside. More...
 
bool _line_search
 Whether to use line searches to improve convergence. More...
 
bool _bracket_solution
 Whether to save upper and lower bounds of root for scalar, and set solution to the midpoint between those bounds if outside them. More...
 

Static Protected Attributes

static RankFourTensor _identityTensor
 
static const std::string _interpolated_old
 
static const std::string _interpolated_older
 

Detailed Description

template<bool is_ad>
class IsotropicPlasticityStressUpdateTempl< is_ad >

This class uses the Discrete material in a radial return isotropic plasticity model.

This class is one of the basic radial return constitutive models; more complex constitutive models combine creep and plasticity.

This class inherits from RadialReturnStressUpdate and must be used in conjunction with ComputeReturnMappingStress. This class calculates an effective trial stress, an effective scalar plastic strain increment, and the derivative of the scalar effective plastic strain increment; these values are passed to the RadialReturnStressUpdate to compute the radial return stress increment. This isotropic plasticity class also computes the plastic strain as a stateful material property.

This class is based on the implicit integration algorithm in F. Dunne and N. Petrinic's Introduction to Computational Plasticity (2004) Oxford University Press, pg. 146 - 149.

Definition at line 33 of file IsotropicPlasticityStressUpdate.h.

Member Typedef Documentation

◆ GR2

Definition at line 57 of file StressUpdateBase.h.

◆ GR4

Definition at line 59 of file StressUpdateBase.h.

◆ GSR2

Definition at line 58 of file StressUpdateBase.h.

◆ GSR4

Definition at line 60 of file StressUpdateBase.h.

Member Enumeration Documentation

◆ SubsteppingType

template<bool is_ad>
enum RadialReturnStressUpdateTempl::SubsteppingType
stronginherited
Enumerator
NONE 
ERROR_BASED 
INCREMENT_BASED 

Definition at line 43 of file RadialReturnStressUpdate.h.

44  {
45  NONE,
46  ERROR_BASED,
47  INCREMENT_BASED
48  };
NONE

Constructor & Destructor Documentation

◆ IsotropicPlasticityStressUpdateTempl()

template<bool is_ad>
IsotropicPlasticityStressUpdateTempl< is_ad >::IsotropicPlasticityStressUpdateTempl ( const InputParameters parameters)

Definition at line 46 of file IsotropicPlasticityStressUpdate.C.

49  _plastic_prepend(this->template getParam<std::string>("plastic_prepend")),
50  _yield_stress_function(this->isParamValid("yield_stress_function")
51  ? &this->getFunction("yield_stress_function")
52  : nullptr),
53  _yield_stress(this->isParamValid("yield_stress") ? this->template getParam<Real>("yield_stress")
54  : 0),
55  _hardening_constant(this->isParamValid("hardening_constant")
56  ? this->template getParam<Real>("hardening_constant")
57  : 0),
58  _hardening_function(this->isParamValid("hardening_function")
59  ? &this->getFunction("hardening_function")
60  : nullptr),
61  _yield_condition(-1.0), // set to a non-physical value to catch uninitalized yield condition
62  _hardening_slope(0.0),
64  _base_name + _plastic_prepend + "plastic_strain")),
66  _base_name + _plastic_prepend + "plastic_strain")),
68  this->template declareGenericProperty<Real, is_ad>(_base_name + "hardening_variable")),
70  this->template getMaterialPropertyOld<Real>(_base_name + "hardening_variable")),
71  _temperature(this->template coupledGenericValue<is_ad>("temperature"))
72 {
73  if (parameters.isParamSetByUser("yield_stress") && _yield_stress <= 0.0)
74  mooseError("Yield stress must be greater than zero");
75 
76  // Both of these parameters are given default values by derived classes, which makes them valid
77  if (_yield_stress_function == nullptr && !this->isParamValid("yield_stress"))
78  mooseError("Either yield_stress or yield_stress_function must be given");
79  if (!parameters.isParamValid("hardening_constant") && !this->isParamValid("hardening_function"))
80  mooseError("Either hardening_constant or hardening_function must be defined");
81 
82  if (parameters.isParamSetByUser("hardening_constant") && this->isParamValid("hardening_function"))
83  mooseError(
84  "Only the hardening_constant or only the hardening_function can be defined but not both");
85 }
const std::string _base_name
Name used as a prefix for all material properties related to the stress update model.
const MaterialProperty< RankTwoTensor > & _plastic_strain_old
old value of plastic strain
const Function & getFunction(const std::string &name) const
const MaterialProperty< T > & getMaterialPropertyOld(const std::string &name, MaterialData &material_data)
RadialReturnStressUpdate computes the radial return stress increment for an isotropic elastic-viscopl...
auto & declareGenericProperty(const std::string &prop_name)
const GenericVariableValue< is_ad > & _temperature
const MaterialProperty< Real > & _hardening_variable_old
bool isParamValid(const std::string &name) const
GenericMaterialProperty< RankTwoTensor, is_ad > & _plastic_strain
plastic strain in this model
const GenericVariableValue< is_ad > & coupledGenericValue(const std::string &var_name, unsigned int comp=0) const
const std::string _plastic_prepend
a string to prepend to the plastic strain Material Property name
const T & getParam(const std::string &name) const
bool isParamSetByUser(const std::string &name) const
GenericMaterialProperty< Real, is_ad > & _hardening_variable
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
void mooseError(Args &&... args) const
const InputParameters & parameters() const
bool isParamValid(const std::string &name) const

Member Function Documentation

◆ calculateNumberSubsteps() [1/2]

template<bool is_ad>
int RadialReturnStressUpdateTempl< is_ad >::calculateNumberSubsteps ( const GenericRankTwoTensor< is_ad > &  strain_increment)
overridevirtualinherited

If substepping is enabled, calculate the number of substeps as a function of the elastic strain increment guess and the maximum inelastic strain increment ratio based on a user-specified tolerance.

Parameters
strain_incrementWhen called, this is the elastic strain guess
Returns
The number of substeps required

Definition at line 150 of file RadialReturnStressUpdate.C.

152 {
153  // compute an effective elastic strain measure
154  const GenericReal<is_ad> contracted_elastic_strain =
155  strain_increment.doubleContraction(strain_increment);
156  const Real effective_elastic_strain =
157  std::sqrt(3.0 / 2.0 * MetaPhysicL::raw_value(contracted_elastic_strain));
158 
159  if (MooseUtils::absoluteFuzzyEqual(effective_elastic_strain, 0.0))
160  return 1;
161 
163  {
164  const Real ratio = effective_elastic_strain / _max_inelastic_increment;
165 
166  if (ratio > _substep_tolerance)
167  return std::ceil(ratio / _substep_tolerance);
168  return 1;
169  }
170 
172  {
173  const Real accurate_time_step_ratio = _substep_tolerance / effective_elastic_strain;
174 
175  if (accurate_time_step_ratio < 1.0)
176  return std::ceil(1.0 / accurate_time_step_ratio);
177  return 1;
178  }
179 
180  mooseError("calculateNumberSubsteps should not have been called. Notify a developer.");
181 }
SubsteppingType _use_substepping
Whether user has requested the use of substepping technique to improve convergence [make const later]...
Moose::GenericType< Real, is_ad > GenericReal
bool absoluteFuzzyEqual(const T &var1, const T2 &var2, const T3 &tol=libMesh::TOLERANCE *libMesh::TOLERANCE)
auto raw_value(const Eigen::Map< T > &in)
Real _max_inelastic_increment
Maximum allowable scalar inelastic strain increment, used to control the timestep size in conjunction...
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
void mooseError(Args &&... args) const
const Real _substep_tolerance
Used to calculate the number of substeps taken in the radial return algorithm, when substepping is en...

◆ calculateNumberSubsteps() [2/2]

virtual int StressUpdateBaseTempl< is_ad, RankTwoTensor , RankFourTensor >::calculateNumberSubsteps ( const GR2 )
inlinevirtualinherited

Given the elastic strain increment compute the number of substeps required to bring a substepped trial stress guess distance from the yield surface into the tolerance specified in the individual child class.

Definition at line 160 of file StressUpdateBase.h.

160 { return 1; }

◆ computeDerivative()

template<bool is_ad>
GenericReal< is_ad > IsotropicPlasticityStressUpdateTempl< is_ad >::computeDerivative ( const GenericReal< is_ad > &  ,
const GenericReal< is_ad > &   
)
overridevirtual

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

Implements SingleVariableReturnMappingSolutionTempl< is_ad >.

Definition at line 144 of file IsotropicPlasticityStressUpdate.C.

Referenced by ComputeCreepPlasticityStress::updateQpState().

146 {
147  if (_yield_condition > 0.0)
148  return -1.0 - _hardening_slope / _three_shear_modulus;
149 
150  return 1.0;
151 }
GenericReal< is_ad > _three_shear_modulus
3 * shear modulus

◆ computeHardeningDerivative()

template<bool is_ad>
GenericReal< is_ad > IsotropicPlasticityStressUpdateTempl< is_ad >::computeHardeningDerivative ( const GenericReal< is_ad > &  scalar)
protectedvirtual

Reimplemented in IsotropicPowerLawHardeningStressUpdateTempl< is_ad >, and TemperatureDependentHardeningStressUpdateTempl< is_ad >.

Definition at line 185 of file IsotropicPlasticityStressUpdate.C.

187 {
189  {
190  const Real strain_old = this->_effective_inelastic_strain_old[_qp];
191  return _hardening_function->timeDerivative(strain_old);
192  }
193 
194  return _hardening_constant;
195 }
virtual Real timeDerivative(Real t, const Point &p) const
const MaterialProperty< Real > & _effective_inelastic_strain_old
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ computeHardeningValue()

template<bool is_ad>
GenericReal< is_ad > IsotropicPlasticityStressUpdateTempl< is_ad >::computeHardeningValue ( const GenericReal< is_ad > &  scalar)
protectedvirtual

Reimplemented in TemperatureDependentHardeningStressUpdateTempl< is_ad >.

Definition at line 171 of file IsotropicPlasticityStressUpdate.C.

173 {
175  {
176  const Real strain_old = this->_effective_inelastic_strain_old[_qp];
177  return _hardening_function->value(strain_old + scalar) - _yield_stress;
178  }
179 
180  return _hardening_variable_old[_qp] + _hardening_slope * scalar;
181 }
const MaterialProperty< Real > & _hardening_variable_old
const MaterialProperty< Real > & _effective_inelastic_strain_old
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
virtual Real value(Real t, const Point &p) const

◆ computeReferenceResidual()

template<bool is_ad>
Real RadialReturnStressUpdateTempl< is_ad >::computeReferenceResidual ( const GenericReal< is_ad > &  effective_trial_stress,
const GenericReal< is_ad > &  scalar 
)
overridevirtualinherited

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 SingleVariableReturnMappingSolutionTempl< is_ad >.

Definition at line 468 of file RadialReturnStressUpdate.C.

471 {
472  return MetaPhysicL::raw_value(effective_trial_stress / _three_shear_modulus) -
473  MetaPhysicL::raw_value(scalar_effective_inelastic_strain);
474 }
auto raw_value(const Eigen::Map< T > &in)
GenericReal< is_ad > _three_shear_modulus
3 * shear modulus

◆ computeResidual()

template<bool is_ad>
GenericReal< is_ad > IsotropicPlasticityStressUpdateTempl< is_ad >::computeResidual ( const GenericReal< is_ad > &  ,
const GenericReal< is_ad > &   
)
overridevirtual

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

Implements SingleVariableReturnMappingSolutionTempl< is_ad >.

Definition at line 123 of file IsotropicPlasticityStressUpdate.C.

Referenced by ComputeCreepPlasticityStress::updateQpState().

125 {
126  mooseAssert(_yield_condition != -1.0,
127  "the yield stress was not updated by computeStressInitialize");
128 
129  if (_yield_condition > 0.0)
130  {
133 
134  return (effective_trial_stress - _hardening_variable[_qp] - _yield_stress) /
136  scalar;
137  }
138 
139  return 0.0;
140 }
GenericReal< is_ad > _three_shear_modulus
3 * shear modulus
GenericMaterialProperty< Real, is_ad > & _hardening_variable
virtual GenericReal< is_ad > computeHardeningValue(const GenericReal< is_ad > &scalar)
virtual GenericReal< is_ad > computeHardeningDerivative(const GenericReal< is_ad > &scalar)

◆ computeResidualAndDerivative()

template<bool is_ad>
virtual GenericChainedReal<is_ad> SingleVariableReturnMappingSolutionTempl< is_ad >::computeResidualAndDerivative ( const GenericReal< is_ad > &  ,
const GenericChainedReal< is_ad > &   
)
inlineprotectedvirtualinherited

Compute the residual and the derivative 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

Reimplemented in CompositePowerLawCreepStressUpdateTempl< is_ad >, and PowerLawCreepStressUpdateTempl< is_ad >.

Definition at line 97 of file SingleVariableReturnMappingSolution.h.

99  {
100  mooseError("computeResidualAndDerivative has to be implemented if "
101  "automatic_differentiation_return_mapping = true.");
102  return 0;
103  };
void mooseError(Args &&... args)

◆ computeStrainEnergyRateDensity()

virtual Real StressUpdateBaseTempl< is_ad, RankTwoTensor , RankFourTensor >::computeStrainEnergyRateDensity ( const GenericMaterialProperty< RankTwoTensor, is_ad > &  ,
const GenericMaterialProperty< RankTwoTensor, is_ad > &   
)
inlinevirtualinherited

Compute the strain energy rate density for this inelastic model for the current step.

Parameters
stressThe stress tensor at the end of the step
strain_rateThe strain rate at the end of the step
Returns
The computed strain energy rate density

Reimplemented in CompositePowerLawCreepStressUpdateTempl< is_ad >, and PowerLawCreepStressUpdateTempl< is_ad >.

Definition at line 180 of file StressUpdateBase.h.

183  {
184  mooseError(
185  "The computation of strain energy rate density needs to be implemented by a child class");
186  return 0.0;
187  }
void mooseError(Args &&... args) const

◆ computeStressDerivative()

template<bool is_ad>
virtual Real RadialReturnStressUpdateTempl< is_ad >::computeStressDerivative ( const Real  ,
const Real   
)
inlineprotectedvirtualinherited

Calculate the derivative of the strain increment with respect to the updated stress.

Parameters
effective_trial_stressEffective trial stress
scalarInelastic strain increment magnitude being solved for

Reimplemented in RadialReturnCreepStressUpdateBaseTempl< is_ad >, and RadialReturnCreepStressUpdateBaseTempl< is_ad >.

Definition at line 199 of file RadialReturnStressUpdate.h.

200  {
201  return 0.0;
202  }

◆ computeStressFinalize()

template<bool is_ad>
void IsotropicPlasticityStressUpdateTempl< is_ad >::computeStressFinalize ( const GenericRankTwoTensor< is_ad > &  )
overridevirtual

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

Parameters
inelasticStrainIncrementInelastic strain increment

Reimplemented from RadialReturnStressUpdateTempl< is_ad >.

Definition at line 163 of file IsotropicPlasticityStressUpdate.C.

Referenced by ComputeCreepPlasticityStress::finalizeConstitutiveModels().

165 {
166  _plastic_strain[_qp] += plastic_strain_increment;
167 }
GenericMaterialProperty< RankTwoTensor, is_ad > & _plastic_strain
plastic strain in this model

◆ computeStressInitialize()

template<bool is_ad>
void IsotropicPlasticityStressUpdateTempl< is_ad >::computeStressInitialize ( const GenericReal< is_ad > &  effective_trial_stress,
const GenericRankFourTensor< is_ad > &  elasticity_tensor 
)
overridevirtual

Perform any necessary initialization before return mapping iterations.

Parameters
effective_trial_stressEffective trial stress
elasticityTensorElasticity tensor

Reimplemented from RadialReturnStressUpdateTempl< is_ad >.

Reimplemented in IsotropicPowerLawHardeningStressUpdateTempl< is_ad >, and TemperatureDependentHardeningStressUpdateTempl< is_ad >.

Definition at line 107 of file IsotropicPlasticityStressUpdate.C.

Referenced by ComputeCreepPlasticityStress::updateQpState().

110 {
112  elasticity_tensor);
113 
114  computeYieldStress(elasticity_tensor);
115 
116  _yield_condition = effective_trial_stress - _hardening_variable_old[_qp] - _yield_stress;
119 }
virtual void computeYieldStress(const GenericRankFourTensor< is_ad > &elasticity_tensor)
const MaterialProperty< RankTwoTensor > & _plastic_strain_old
old value of plastic strain
virtual void computeStressInitialize(const GenericReal< is_ad > &effective_trial_stress, const GenericRankFourTensor< is_ad > &elasticity_tensor)
Perform any necessary initialization before return mapping iterations.
const MaterialProperty< Real > & _hardening_variable_old
GenericMaterialProperty< RankTwoTensor, is_ad > & _plastic_strain
plastic strain in this model
GenericMaterialProperty< Real, is_ad > & _hardening_variable

◆ computeTangentOperator() [1/3]

template<bool is_ad>
void RadialReturnStressUpdateTempl< is_ad >::computeTangentOperator ( Real  effective_trial_stress,
const RankTwoTensor stress_new,
RankFourTensor tangent_operator 
)
inherited

Calculate the tangent_operator.

Definition at line 185 of file RadialReturnStressUpdate.C.

Referenced by ComputeCreepPlasticityStress::computeTangentOperators().

188 {
189  mooseError("computeTangentOperator called: no tangent computation is needed for AD");
190 }
void mooseError(Args &&... args) const

◆ computeTangentOperator() [2/3]

template<>
void RadialReturnStressUpdateTempl< false >::computeTangentOperator ( Real  effective_trial_stress,
const RankTwoTensor stress_new,
RankFourTensor tangent_operator 
)
inherited

Definition at line 194 of file RadialReturnStressUpdate.C.

197 {
199  {
201  tangent_operator.zero();
202  else
203  {
204  // mu = _three_shear_modulus / 3.0;
205  // norm_dev_stress = ||s_n+1||
206  // effective_trial_stress = von mises trial stress = std::sqrt(3.0 / 2.0) * ||s_n+1^trial||
207  // scalar_effective_inelastic_strain = Delta epsilon^cr_n+1
208  // deriv = derivative of scalar_effective_inelastic_strain w.r.t. von mises stress
209  // deriv = std::sqrt(3.0 / 2.0) partial Delta epsilon^cr_n+1n over partial ||s_n+1^trial||
210 
211  mooseAssert(_three_shear_modulus != 0.0, "Shear modulus is zero");
212 
213  const RankTwoTensor deviatoric_stress = stress_new.deviatoric();
214  const Real norm_dev_stress_squared = deviatoric_stress.doubleContraction(deviatoric_stress);
215  if (MooseUtils::absoluteFuzzyEqual(norm_dev_stress_squared, 0.0))
216  {
217  tangent_operator.zero();
218  return;
219  }
220  const Real norm_dev_stress = std::sqrt(norm_dev_stress_squared);
221 
222  const RankTwoTensor flow_direction = deviatoric_stress / norm_dev_stress;
223  const RankFourTensor flow_direction_dyad = flow_direction.outerProduct(flow_direction);
224  const Real deriv =
227  std::sqrt(1.5) / norm_dev_stress;
228 
229  tangent_operator = scalar_one * _deviatoric_projection_four +
230  (_three_shear_modulus * deriv - scalar_one) * flow_direction_dyad;
231  }
232  }
233 }
RankFourTensorTempl< Real > outerProduct(const RankTwoTensorTempl< Real > &b) const
bool absoluteFuzzyEqual(const T &var1, const T2 &var2, const T3 &tol=libMesh::TOLERANCE *libMesh::TOLERANCE)
const RankFourTensor _deviatoric_projection_four
Rank four deviatoric projection tensor.
virtual Real computeStressDerivative(const Real, const Real)
Calculate the derivative of the strain increment with respect to the updated stress.
GenericReal< is_ad > _three_shear_modulus
3 * shear modulus
RankTwoTensorTempl< Real > deviatoric() const
virtual TangentCalculationMethod getTangentCalculationMethod()
Real deriv(unsigned n, unsigned alpha, unsigned beta, Real x)
Real doubleContraction(const RankTwoTensorTempl< Real > &a) const
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
GenericReal< is_ad > _effective_inelastic_strain_increment
Stores the scalar effective inelastic strain increment from Newton iteration.

◆ computeTangentOperator() [3/3]

template<>
void RadialReturnStressUpdateTempl< false >::computeTangentOperator ( Real  effective_trial_stress,
const RankTwoTensor stress_new,
RankFourTensor tangent_operator 
)
inherited

◆ computeTimeStepLimit()

template<bool is_ad>
Real RadialReturnStressUpdateTempl< is_ad >::computeTimeStepLimit ( )
overridevirtualinherited

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

Returns
Limiting time step

Reimplemented from StressUpdateBaseTempl< is_ad >.

Reimplemented in LAROMANCEStressUpdateBaseTempl< is_ad >.

Definition at line 486 of file RadialReturnStressUpdate.C.

Referenced by LAROMANCEStressUpdateBaseTempl< is_ad >::computeTimeStepLimit().

487 {
488  const Real scalar_inelastic_strain_incr =
491  if (!scalar_inelastic_strain_incr)
492  return std::numeric_limits<Real>::max();
493 
494  return _dt * _max_inelastic_increment / scalar_inelastic_strain_incr;
495 }
GenericMaterialProperty< Real, is_ad > & _effective_inelastic_strain
auto raw_value(const Eigen::Map< T > &in)
const MaterialProperty< Real > & _effective_inelastic_strain_old
Real _max_inelastic_increment
Maximum allowable scalar inelastic strain increment, used to control the timestep size in conjunction...
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ computeYieldStress()

template<bool is_ad>
void IsotropicPlasticityStressUpdateTempl< is_ad >::computeYieldStress ( const GenericRankFourTensor< is_ad > &  elasticity_tensor)
virtual

Reimplemented in IsotropicPowerLawHardeningStressUpdateTempl< is_ad >, and TemperatureDependentHardeningStressUpdateTempl< is_ad >.

Definition at line 199 of file IsotropicPlasticityStressUpdate.C.

201 {
203  {
204  static const Moose::GenericType<Point, is_ad> p;
206 
207  if (_yield_stress <= 0.0)
208  mooseError("In ",
209  this->_name,
210  ": The calculated yield stress (",
212  ") is less than zero");
213  }
214 }
const GenericVariableValue< is_ad > & _temperature
typename std::conditional< is_ad, typename ADType< T >::type, T >::type GenericType
const std::string _name
void mooseError(Args &&... args) const
virtual Real value(Real t, const Point &p) const

◆ converged()

template<bool is_ad>
bool SingleVariableReturnMappingSolutionTempl< is_ad >::converged ( const GenericReal< is_ad > &  residual,
const Real  reference 
)
protectedinherited

Check to see whether the residual is within the convergence limits.

Parameters
residualCurrent value of the residual
referenceCurrent value of the reference quantity
Returns
Whether the model converged

Definition at line 326 of file SingleVariableReturnMappingSolution.C.

328 {
329  const Real residual = MetaPhysicL::raw_value(ad_residual);
330  return (std::abs(residual) <= _absolute_tolerance ||
331  std::abs(residual / reference) <= _relative_tolerance);
332 }
auto raw_value(const Eigen::Map< T > &in)
Real _relative_tolerance
Relative convergence tolerance.
Real _absolute_tolerance
Absolute convergence tolerance.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ effectiveInelasticStrainIncrement()

template<bool is_ad>
const GenericReal<is_ad>& RadialReturnStressUpdateTempl< is_ad >::effectiveInelasticStrainIncrement ( ) const
inlineinherited

Current value of scalar inelastic strain.

Definition at line 151 of file RadialReturnStressUpdate.h.

Referenced by ComputeCreepPlasticityStress::updateQpState().

152  {
154  }
GenericReal< is_ad > _effective_inelastic_strain_increment
Stores the scalar effective inelastic strain increment from Newton iteration.

◆ getTangentCalculationMethod() [1/2]

TangentCalculationMethod StressUpdateBaseTempl< true >::getTangentCalculationMethod ( )
inherited

Definition at line 108 of file StressUpdateBase.C.

109 {
110  mooseError(
111  "getTangentCalculationMethod called: no tangent moduli calculation is needed while using AD");
113 }
void mooseError(Args &&... args) const

◆ getTangentCalculationMethod() [2/2]

TangentCalculationMethod StressUpdateBaseTempl< is_ad, RankTwoTensor , RankFourTensor >::getTangentCalculationMethod ( )
virtualinherited

◆ initialGuess()

template<bool is_ad>
virtual GenericReal<is_ad> SingleVariableReturnMappingSolutionTempl< is_ad >::initialGuess ( const GenericReal< is_ad > &  )
inlineprotectedvirtualinherited

Compute an initial guess for the value of the scalar.

For some cases, an intellegent starting point can provide enhanced robustness in the Newton iterations. This is also an opportunity for classes that derive from this to perform initialization tasks.

Parameters
effective_trial_stressEffective trial stress

Reimplemented in PowerLawCreepTestTempl< is_ad >.

Definition at line 66 of file SingleVariableReturnMappingSolution.h.

67  {
68  return 0.0;
69  }

◆ initQpStatefulProperties()

template<bool is_ad>
void IsotropicPlasticityStressUpdateTempl< is_ad >::initQpStatefulProperties ( )
overrideprotectedvirtual

Reimplemented from RadialReturnStressUpdateTempl< is_ad >.

Definition at line 89 of file IsotropicPlasticityStressUpdate.C.

90 {
91  _hardening_variable[_qp] = 0.0;
92  _plastic_strain[_qp].zero();
93 }
GenericMaterialProperty< RankTwoTensor, is_ad > & _plastic_strain
plastic strain in this model
GenericMaterialProperty< Real, is_ad > & _hardening_variable

◆ isIsotropic()

template<bool is_ad>
bool RadialReturnStressUpdateTempl< is_ad >::isIsotropic ( )
inlineoverridevirtualinherited

Radial return mapped models should be isotropic by default!

Reimplemented from StressUpdateBaseTempl< is_ad >.

Definition at line 128 of file RadialReturnStressUpdate.h.

128 { return true; };

◆ iterationFinalize()

template<bool is_ad>
void IsotropicPlasticityStressUpdateTempl< is_ad >::iterationFinalize ( const GenericReal< is_ad > &  )
overrideprotectedvirtual

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

Parameters
scalarInelastic strain increment magnitude being solved for

Reimplemented from SingleVariableReturnMappingSolutionTempl< is_ad >.

Definition at line 155 of file IsotropicPlasticityStressUpdate.C.

156 {
157  if (_yield_condition > 0.0)
159 }
GenericMaterialProperty< Real, is_ad > & _hardening_variable
virtual GenericReal< is_ad > computeHardeningValue(const GenericReal< is_ad > &scalar)

◆ maximumPermissibleValue()

template<bool is_ad>
GenericReal< is_ad > RadialReturnStressUpdateTempl< is_ad >::maximumPermissibleValue ( const GenericReal< is_ad > &  effective_trial_stress) const
overridevirtualinherited

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 SingleVariableReturnMappingSolutionTempl< is_ad >.

Reimplemented in LAROMANCEStressUpdateBaseTempl< is_ad >, and PowerLawCreepTestTempl< is_ad >.

Definition at line 478 of file RadialReturnStressUpdate.C.

480 {
481  return effective_trial_stress / _three_shear_modulus;
482 }
GenericReal< is_ad > _three_shear_modulus
3 * shear modulus

◆ minimumPermissibleValue()

template<bool is_ad>
virtual GenericReal<is_ad> RadialReturnStressUpdateTempl< is_ad >::minimumPermissibleValue ( const GenericReal< is_ad > &  effective_trial_stress) const
inlineoverridevirtualinherited

Compute the minimum permissible value of the scalar.

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

Parameters
effective_trial_stressEffective trial stress

Reimplemented from SingleVariableReturnMappingSolutionTempl< is_ad >.

Reimplemented in PowerLawCreepTestTempl< is_ad >.

Definition at line 106 of file RadialReturnStressUpdate.h.

107  {
108  return 0.0;
109  }

◆ outputIterationStep()

template<bool is_ad>
void SingleVariableReturnMappingSolutionTempl< is_ad >::outputIterationStep ( std::stringstream *  iter_output,
const GenericReal< is_ad > &  effective_trial_stress,
const GenericReal< is_ad > &  scalar,
const Real  reference_residual 
)
protectedvirtualinherited

Output information for a single iteration step to build the convergence history of the model.

Parameters
iter_outputOutput stream
effective_trial_stressEffective trial stress
residualCurrent value of the residual
referenceCurrent value of the reference quantity

Reimplemented in LAROMANCEStressUpdateBaseTempl< is_ad >.

Definition at line 419 of file SingleVariableReturnMappingSolution.C.

Referenced by LAROMANCEStressUpdateBaseTempl< is_ad >::outputIterationStep().

424 {
425  if (iter_output)
426  {
427  const unsigned int it = _iteration;
428  const Real residual = MetaPhysicL::raw_value(_residual);
429 
430  *iter_output << " iteration=" << it
431  << " trial_stress=" << MetaPhysicL::raw_value(effective_trial_stress)
432  << " scalar=" << MetaPhysicL::raw_value(scalar) << " residual=" << residual
433  << " ref_res=" << reference_residual
434  << " rel_res=" << std::abs(residual) / reference_residual
435  << " rel_tol=" << _relative_tolerance << " abs_res=" << std::abs(residual)
436  << " abs_tol=" << _absolute_tolerance << '\n';
437  }
438 }
auto raw_value(const Eigen::Map< T > &in)
Real _relative_tolerance
Relative convergence tolerance.
Real _absolute_tolerance
Absolute convergence tolerance.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ outputIterationSummary()

template<bool is_ad>
void RadialReturnStressUpdateTempl< is_ad >::outputIterationSummary ( std::stringstream *  iter_output,
const unsigned int  total_it 
)
overrideprotectedvirtualinherited

Output summary information for the convergence history of the model.

Parameters
iter_outputOutput stream
total_itTotal iteration count

Reimplemented from SingleVariableReturnMappingSolutionTempl< is_ad >.

Definition at line 499 of file RadialReturnStressUpdate.C.

501 {
502  if (iter_output)
503  {
504  *iter_output << "At element " << _current_elem->id() << " _qp=" << _qp << " Coordinates "
505  << _q_point[_qp] << " block=" << _current_elem->subdomain_id() << '\n';
506  }
508 }
virtual void outputIterationSummary(std::stringstream *iter_output, const unsigned int total_it)
Output summary information for the convergence history of the model.
const Elem *const & _current_elem
const MooseArray< Point > & _q_point

◆ preStep()

template<bool is_ad>
virtual void SingleVariableReturnMappingSolutionTempl< is_ad >::preStep ( const GenericReal< is_ad > &  ,
const GenericReal< is_ad > &  ,
const GenericReal< is_ad > &   
)
inlineprotectedvirtualinherited

This method is called before taking a step in the return mapping algorithm.

A typical use case is to accumulate the exact algorithmic tangent during return mapping.

Definition at line 118 of file SingleVariableReturnMappingSolution.h.

121  {
122  }

◆ propagateQpStatefulProperties()

template<bool is_ad>
void IsotropicPlasticityStressUpdateTempl< is_ad >::propagateQpStatefulProperties ( )
overrideprotectedvirtual

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 from StressUpdateBaseTempl< is_ad >.

Definition at line 97 of file IsotropicPlasticityStressUpdate.C.

98 {
101 
103 }
const MaterialProperty< RankTwoTensor > & _plastic_strain_old
old value of plastic strain
const MaterialProperty< Real > & _hardening_variable_old
GenericMaterialProperty< RankTwoTensor, is_ad > & _plastic_strain
plastic strain in this model
GenericMaterialProperty< Real, is_ad > & _hardening_variable
void propagateQpStatefulPropertiesRadialReturn()
Propagate the properties pertaining to this intermediate class.

◆ propagateQpStatefulPropertiesRadialReturn()

template<bool is_ad>
void RadialReturnStressUpdateTempl< is_ad >::propagateQpStatefulPropertiesRadialReturn ( )
protectedinherited

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 143 of file RadialReturnStressUpdate.C.

Referenced by CombinedNonlinearHardeningPlasticityTempl< is_ad >::propagateQpStatefulProperties(), and IsotropicPlasticityStressUpdateTempl< is_ad >::propagateQpStatefulProperties().

144 {
146 }
GenericMaterialProperty< Real, is_ad > & _effective_inelastic_strain
const MaterialProperty< Real > & _effective_inelastic_strain_old

◆ requiresIsotropicTensor()

template<bool is_ad>
bool RadialReturnStressUpdateTempl< is_ad >::requiresIsotropicTensor ( )
inlineoverridevirtualinherited

Does the model require the elasticity tensor to be isotropic?

Implements StressUpdateBaseTempl< is_ad >.

Definition at line 123 of file RadialReturnStressUpdate.h.

123 { return true; }

◆ resetIncrementalMaterialProperties()

virtual void StressUpdateBaseTempl< is_ad, RankTwoTensor , RankFourTensor >::resetIncrementalMaterialProperties ( )
inlinevirtualinherited

Reset material properties.

Useful for substepping with inelastic models.

Reimplemented in CompositePowerLawCreepStressUpdateTempl< is_ad >, PowerLawCreepStressUpdateTempl< is_ad >, and LAROMANCEStressUpdateBaseTempl< is_ad >.

Definition at line 172 of file StressUpdateBase.h.

172 {};

◆ resetProperties()

void StressUpdateBaseTempl< is_ad, RankTwoTensor , RankFourTensor >::resetProperties ( )
inlinefinalvirtualinherited

Reimplemented from Material.

Definition at line 138 of file StressUpdateBase.h.

138 {}

◆ resetQpProperties()

void StressUpdateBaseTempl< is_ad, RankTwoTensor , RankFourTensor >::resetQpProperties ( )
inlinefinalvirtualinherited

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.

Reimplemented from Material.

Definition at line 137 of file StressUpdateBase.h.

137 {}

◆ returnMappingSolve()

template<bool is_ad>
void SingleVariableReturnMappingSolutionTempl< is_ad >::returnMappingSolve ( const GenericReal< is_ad > &  effective_trial_stress,
GenericReal< is_ad > &  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 100 of file SingleVariableReturnMappingSolution.C.

Referenced by ADViscoplasticityStressUpdate::computeInelasticStrainIncrement(), and ComputeSimoHughesJ2PlasticityStress::computeQpPK1Stress().

104 {
105  // construct the stringstream here only if the debug level is set to ALL
106  std::unique_ptr<std::stringstream> iter_output =
108  ? std::make_unique<std::stringstream>()
109  : nullptr;
110 
111  // do the internal solve and capture iteration info during the first round
112  // iff full history output is requested regardless of whether the solve failed or succeeded
113  auto solve_state =
114  internalSolve(effective_trial_stress,
115  scalar,
116  _internal_solve_full_iteration_history ? iter_output.get() : nullptr);
117  if (solve_state != SolveState::SUCCESS &&
119  {
120  // output suppressed by user, throw immediately
122  mooseException("");
123 
124  // user expects some kind of output, if necessary setup output stream now
125  if (!iter_output)
126  iter_output = std::make_unique<std::stringstream>();
127 
128  // add the appropriate error message to the output
129  switch (solve_state)
130  {
131  case SolveState::NAN_INF:
132  *iter_output << "Encountered inf or nan in material return mapping iterations.\n";
133  break;
134 
136  *iter_output << "Exceeded maximum iterations in material return mapping iterations.\n";
137  break;
138 
139  default:
140  mooseError("Unhandled solver state");
141  }
142 
143  // if full history output is only requested for failed solves we have to repeat
144  // the solve a second time
146  internalSolve(effective_trial_stress, scalar, iter_output.get());
147 
148  // Append summary and throw exception
149  outputIterationSummary(iter_output.get(), _iteration);
150  mooseException(iter_output->str());
151  }
152 
154  {
155  // the solve did not fail but the user requested debug output anyways
156  outputIterationSummary(iter_output.get(), _iteration);
157  console << iter_output->str() << std::flush;
158  }
159 }
void mooseError(Args &&... args)
SolveState internalSolve(const GenericReal< is_ad > effective_trial_stress, GenericReal< is_ad > &scalar, std::stringstream *iter_output=nullptr)
Method called from within this class to perform the actual return mappping iterations.
const bool _internal_solve_full_iteration_history
Whether to output iteration information all the time (regardless of whether iterations converge) ...
virtual void outputIterationSummary(std::stringstream *iter_output, const unsigned int total_it)
Output summary information for the convergence history of the model.
enum SingleVariableReturnMappingSolutionTempl::InternalSolveOutput _internal_solve_output_on

◆ setQp()

void StressUpdateBaseTempl< is_ad, RankTwoTensor , RankFourTensor >::setQp ( unsigned int  qp)
inherited

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

Definition at line 46 of file StressUpdateBase.C.

47 {
48  _qp = qp;
49 }

◆ storeIncrementalMaterialProperties()

virtual void StressUpdateBaseTempl< is_ad, RankTwoTensor , RankFourTensor >::storeIncrementalMaterialProperties ( const unsigned int  )
inlinevirtualinherited

Properly set up the incremental calculation storage of the stateful material properties in the inheriting classes.

Reimplemented in LAROMANCEStressUpdateBaseTempl< is_ad >.

Definition at line 167 of file StressUpdateBase.h.

167 {};

◆ substeppingCapabilityEnabled()

virtual bool StressUpdateBaseTempl< is_ad, RankTwoTensor , RankFourTensor >::substeppingCapabilityEnabled ( )
inlinevirtualinherited

Does the model include the infrastructure for substep decomposition of the elastic strain initially used to calculate the trial stress guess Inheriting classes which wish to use the substepping capability should overwrite this method and set it to return true.

Reimplemented in CompositePowerLawCreepStressUpdateTempl< is_ad >, ADMultiplePowerLawCreepStressUpdate, PowerLawCreepStressUpdateTempl< is_ad >, and LAROMANCEStressUpdateBaseTempl< is_ad >.

Definition at line 147 of file StressUpdateBase.h.

147 { return false; }

◆ substeppingCapabilityRequested()

template<bool is_ad>
virtual bool RadialReturnStressUpdateTempl< is_ad >::substeppingCapabilityRequested ( )
inlineoverridevirtualinherited

Has the user requested usage of (possibly) implemented substepping capability for inelastic models.

Parent classes set this to false, but RadialReturn inelastic models have the ability to implement substepping.

Reimplemented from StressUpdateBaseTempl< is_ad >.

Definition at line 145 of file RadialReturnStressUpdate.h.

146  {
148  }
SubsteppingType _use_substepping
Whether user has requested the use of substepping technique to improve convergence [make const later]...

◆ updateEffectiveInelasticStrain()

template<bool is_ad>
void RadialReturnStressUpdateTempl< is_ad >::updateEffectiveInelasticStrain ( const GenericReal< is_ad > &  increment)
inlineinherited

Definition at line 161 of file RadialReturnStressUpdate.h.

Referenced by ComputeCreepPlasticityStress::finalizeConstitutiveModels().

162  {
164  }
constexpr auto increment(std::index_sequence< first, tail... >)
GenericMaterialProperty< Real, is_ad > & _effective_inelastic_strain
const MaterialProperty< Real > & _effective_inelastic_strain_old

◆ updateEffectiveInelasticStrainIncrement()

template<bool is_ad>
void RadialReturnStressUpdateTempl< is_ad >::updateEffectiveInelasticStrainIncrement ( const GenericReal< is_ad > &  eisi)
inlineinherited

Definition at line 156 of file RadialReturnStressUpdate.h.

Referenced by ComputeCreepPlasticityStress::finalizeConstitutiveModels().

157  {
159  }
GenericReal< is_ad > _effective_inelastic_strain_increment
Stores the scalar effective inelastic strain increment from Newton iteration.

◆ updateState() [1/2]

template<bool is_ad>
void RadialReturnStressUpdateTempl< is_ad >::updateState ( GenericRankTwoTensor< is_ad > &  strain_increment,
GenericRankTwoTensor< is_ad > &  inelastic_strain_increment,
const GenericRankTwoTensor< is_ad > &  rotation_increment,
GenericRankTwoTensor< is_ad > &  stress_new,
const RankTwoTensor stress_old,
const GenericRankFourTensor< is_ad > &  elasticity_tensor,
const RankTwoTensor elastic_strain_old,
bool  compute_full_tangent_operator = false,
RankFourTensor tangent_operator = StressUpdateBaseTempl<is_ad>::_identityTensor 
)
overridevirtualinherited

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

Reimplemented in RadialReturnBackstressStressUpdateBaseTempl< is_ad >.

Definition at line 237 of file RadialReturnStressUpdate.C.

Referenced by RadialReturnBackstressStressUpdateBaseTempl< is_ad >::updateState().

247 {
248 
249  // compute the deviatoric trial stress and trial strain from the current intermediate
250  // configuration
251  GenericRankTwoTensor<is_ad> deviatoric_trial_stress = stress_new.deviatoric();
252 
253  // compute the effective trial stress
254  GenericReal<is_ad> dev_trial_stress_squared =
255  deviatoric_trial_stress.doubleContraction(deviatoric_trial_stress);
256  GenericReal<is_ad> effective_trial_stress = MetaPhysicL::raw_value(dev_trial_stress_squared)
257  ? std::sqrt(3.0 / 2.0 * dev_trial_stress_squared)
258  : 0.0;
259 
260  computeStressInitialize(effective_trial_stress, elasticity_tensor);
261 
262  mooseAssert(
263  _three_shear_modulus != 0.0,
264  "Shear modulus is zero. Ensure that the base class computeStressInitialize() is called.");
265 
266  // Use Newton iteration to determine the scalar effective inelastic strain increment
268  if (!MooseUtils::absoluteFuzzyEqual(effective_trial_stress, 0.0))
269  {
270  this->returnMappingSolve(
271  effective_trial_stress, _effective_inelastic_strain_increment, this->_console);
273  inelastic_strain_increment =
274  deviatoric_trial_stress *
275  (1.5 * _effective_inelastic_strain_increment / effective_trial_stress);
276  else
277  inelastic_strain_increment.zero();
278  }
279  else
280  inelastic_strain_increment.zero();
281 
282  if (_apply_strain)
283  {
284  strain_increment -= inelastic_strain_increment;
286 
287  // Use the old elastic strain here because we require tensors used by this class
288  // to be isotropic and this method natively allows for changing in time
289  // elasticity tensors
290  stress_new = elasticity_tensor * (strain_increment + elastic_strain_old);
291  }
292 
293  computeStressFinalize(inelastic_strain_increment);
294 
295  if constexpr (!is_ad)
296  {
297  if (compute_full_tangent_operator)
298  computeTangentOperator(effective_trial_stress, stress_new, tangent_operator);
299  }
300  else
301  {
302  libmesh_ignore(compute_full_tangent_operator);
303  libmesh_ignore(tangent_operator);
304  }
305 }
Moose::GenericType< Real, is_ad > GenericReal
virtual void computeStressFinalize(const GenericRankTwoTensor< is_ad > &)
Perform any necessary steps to finalize state after return mapping iterations.
bool absoluteFuzzyEqual(const T &var1, const T2 &var2, const T3 &tol=libMesh::TOLERANCE *libMesh::TOLERANCE)
virtual void computeStressInitialize(const GenericReal< is_ad > &effective_trial_stress, const GenericRankFourTensor< is_ad > &elasticity_tensor)
Perform any necessary initialization before return mapping iterations.
auto raw_value(const Eigen::Map< T > &in)
GenericReal< is_ad > _three_shear_modulus
3 * shear modulus
void updateEffectiveInelasticStrain(const GenericReal< is_ad > &increment)
Real elasticity_tensor(unsigned int i, unsigned int j, unsigned int k, unsigned int l)
void libmesh_ignore(const Args &...)
void returnMappingSolve(const GenericReal< is_ad > &effective_trial_stress, GenericReal< is_ad > &scalar, const ConsoleStream &console)
Perform the return mapping iterations.
const bool _apply_strain
Debugging option to enable specifying instead of calculating strain.
void computeTangentOperator(Real effective_trial_stress, const RankTwoTensor &stress_new, RankFourTensor &tangent_operator)
Calculate the tangent_operator.
GenericReal< is_ad > _effective_inelastic_strain_increment
Stores the scalar effective inelastic strain increment from Newton iteration.
const ConsoleStream _console
Moose::GenericType< RankTwoTensor, is_ad > GenericRankTwoTensor

◆ updateState() [2/2]

void StressUpdateBaseTempl< is_ad, RankTwoTensor , RankFourTensor >::updateState ( GR2 strain_increment,
GR2 inelastic_strain_increment,
const GR2 rotation_increment,
GR2 stress_new,
const RankTwoTensor stress_old,
const GR4 elasticity_tensor,
const RankTwoTensor elastic_strain_old,
bool  compute_full_tangent_operator = false,
RankFourTensor tangent_operator = StressUpdateBaseTempl<is_ad>::_identityTensor 
)
virtualinherited

Given a strain increment that results in a trial stress, perform some procedure (such as an iterative return-mapping process) to produce an admissible stress, an elastic strain increment and an inelastic strain increment.

If _fe_problem.currentlyComputingJacobian() = true, then updateState also computes d(stress)/d(strain) (or some approximation to it).

This method is called by ComputeMultipleInelasticStress. This method is pure virutal: all inheriting classes must overwrite this method.

Parameters
strain_incrementUpon input: the strain increment. Upon output: the elastic strain increment
inelastic_strain_incrementThe inelastic_strain resulting from the interative procedure
rotation_incrementThe finite-strain rotation increment
stress_newUpon input: the trial stress that results from applying strain_increment as an elastic strain. Upon output: the admissible stress
stress_oldThe old value of stress
elasticity_tensorThe elasticity tensor
compute_full_tangent_operatorThe calling routine would like the full consistent tangent operator to be placed in tangent_operator, if possible. This is irrelevant if _fe_problem.currentlyComputingJacobian() = false
tangent_operatord(stress)/d(strain), or some approximation to it If compute_full_tangent_operator=false, then tangent_operator=elasticity_tensor is an appropriate choice. tangent_operator is only computed if _fe_problem.currentlyComputingJacobian() = true

Definition at line 68 of file StressUpdateBase.C.

78 {
79  mooseError("updateState called: it needs to be implemented by your inelastic model");
80 }
void mooseError(Args &&... args) const

◆ updateStateSubstep() [1/2]

template<bool is_ad>
void RadialReturnStressUpdateTempl< is_ad >::updateStateSubstep ( GenericRankTwoTensor< is_ad > &  strain_increment,
GenericRankTwoTensor< is_ad > &  inelastic_strain_increment,
const GenericRankTwoTensor< is_ad > &  rotation_increment,
GenericRankTwoTensor< is_ad > &  stress_new,
const RankTwoTensor stress_old,
const GenericRankFourTensor< is_ad > &  elasticity_tensor,
const RankTwoTensor elastic_strain_old,
bool  compute_full_tangent_operator = false,
RankFourTensor tangent_operator = StressUpdateBaseTempl<is_ad>::_identityTensor 
)
overridevirtualinherited

Similar to the updateState function, this method updates the strain and stress for one substep.

Definition at line 412 of file RadialReturnStressUpdate.C.

422 {
423  unsigned int num_substeps = calculateNumberSubsteps(strain_increment);
424  _dt_original = _dt;
425  while (true)
426  {
427  try
428  {
429  updateStateSubstepInternal(strain_increment,
430  inelastic_strain_increment,
431  rotation_increment,
432  stress_new,
433  stress_old,
434  elasticity_tensor,
435  elastic_strain_old,
436  num_substeps,
437  compute_full_tangent_operator,
438  tangent_operator);
439  }
440  catch (MooseException & e)
441  {
442  // if we are not using adaptive substepping we just rethrow the exception
444  throw e;
445 
446  // otherwise we double the number of substeps and try again
447  num_substeps *= 2;
448  if (num_substeps <= _maximum_number_substeps)
449  continue;
450 
451  // too meany substeps, break out of the loop
452  break;
453  }
454 
455  // updateStateSubstepInternal was successful (didn't throw)
456  _dt = _dt_original;
457  return;
458  }
459 
460  // recover the original timestep
461  _dt = _dt_original;
462 
463  mooseException("Adaptive substepping failed. Maximum number of substeps exceeded.");
464 }
Real _dt_original
original timestep (to be restored after substepping is completed)
virtual int calculateNumberSubsteps(const GenericRankTwoTensor< is_ad > &strain_increment) override
If substepping is enabled, calculate the number of substeps as a function of the elastic strain incre...
virtual void updateStateSubstepInternal(GenericRankTwoTensor< is_ad > &, GenericRankTwoTensor< is_ad > &, const GenericRankTwoTensor< is_ad > &, GenericRankTwoTensor< is_ad > &, const RankTwoTensor &, const GenericRankFourTensor< is_ad > &, const RankTwoTensor &, unsigned int total_number_substeps, bool compute_full_tangent_operator=false, RankFourTensor &tangent_operator=StressUpdateBaseTempl< is_ad >::_identityTensor)
const unsigned int _maximum_number_substeps
Maximum number of substeps. If the calculation results in a larger number, cut overall time step...
const bool _adaptive_substepping
Use adaptive substepping, cutting substep sizes until convergence is achieved.

◆ updateStateSubstep() [2/2]

void StressUpdateBaseTempl< is_ad, RankTwoTensor , RankFourTensor >::updateStateSubstep ( GR2 ,
GR2 ,
const GR2 ,
GR2 ,
const RankTwoTensor ,
const GR4 ,
const RankTwoTensor ,
bool  compute_full_tangent_operator = false,
RankFourTensor tangent_operator = StressUpdateBaseTempl<is_ad>::_identityTensor 
)
virtualinherited

Similar to the updateState function, this method updates the strain and stress for one substep.

Definition at line 84 of file StressUpdateBase.C.

94 {
95  this->paramError("use_substep",
96  "updateStateSubstep called: it needs to be implemented by your inelastic model");
97 }
void paramError(const std::string &param, Args... args) const

◆ updateStateSubstepInternal()

template<bool is_ad>
void RadialReturnStressUpdateTempl< is_ad >::updateStateSubstepInternal ( GenericRankTwoTensor< is_ad > &  strain_increment,
GenericRankTwoTensor< is_ad > &  inelastic_strain_increment,
const GenericRankTwoTensor< is_ad > &  rotation_increment,
GenericRankTwoTensor< is_ad > &  stress_new,
const RankTwoTensor stress_old,
const GenericRankFourTensor< is_ad > &  elasticity_tensor,
const RankTwoTensor elastic_strain_old,
unsigned int  total_number_substeps,
bool  compute_full_tangent_operator = false,
RankFourTensor tangent_operator = StressUpdateBaseTempl<is_ad>::_identityTensor 
)
virtualinherited

Definition at line 309 of file RadialReturnStressUpdate.C.

320 {
321  // if only one substep is needed, then call the original update state method
322  if (total_number_substeps == 1)
323  {
324  updateState(strain_increment,
325  inelastic_strain_increment,
326  rotation_increment,
327  stress_new,
328  stress_old,
329  elasticity_tensor,
330  elastic_strain_old,
331  compute_full_tangent_operator,
332  tangent_operator);
333 
334  this->storeIncrementalMaterialProperties(total_number_substeps);
335  return;
336  }
337 
338  if (total_number_substeps > _maximum_number_substeps)
339  mooseException("The number of substeps computed exceeds 'maximum_number_substeps'.");
340 
341  // cut the original timestep
342  _dt = _dt_original / total_number_substeps;
343 
344  // initialize the inputs
345  const GenericRankTwoTensor<is_ad> strain_increment_per_step =
346  strain_increment / total_number_substeps;
347  GenericRankTwoTensor<is_ad> sub_stress_new = elasticity_tensor * elastic_strain_old;
348  GenericRankTwoTensor<is_ad> sub_elastic_strain_old = elastic_strain_old;
349 
350  // clear the original inputs
351  MathUtils::mooseSetToZero(strain_increment);
352  MathUtils::mooseSetToZero(inelastic_strain_increment);
353  MathUtils::mooseSetToZero(stress_new);
354 
355  GenericReal<is_ad> sub_effective_inelastic_strain_increment = 0.0;
356  GenericRankTwoTensor<is_ad> sub_inelastic_strain_increment = inelastic_strain_increment;
357 
358  for (unsigned int step = 0; step < total_number_substeps; ++step)
359  {
360  // set up input for this substep
361  GenericRankTwoTensor<is_ad> sub_strain_increment = strain_increment_per_step;
362  sub_stress_new += elasticity_tensor * sub_strain_increment;
363 
364  Real effective_sub_stress_new;
365  if constexpr (!is_ad)
366  {
367  // compute effective_sub_stress_new
368  const RankTwoTensor deviatoric_sub_stress_new = sub_stress_new.deviatoric();
369  const Real dev_sub_stress_new_squared =
370  deviatoric_sub_stress_new.doubleContraction(deviatoric_sub_stress_new);
371  effective_sub_stress_new = std::sqrt(3.0 / 2.0 * dev_sub_stress_new_squared);
372  }
373  else
374  libmesh_ignore(effective_sub_stress_new);
375 
376  // update stress and strain based on the strain increment
377  updateState(sub_strain_increment,
378  sub_inelastic_strain_increment,
379  rotation_increment, // not used in updateState
380  sub_stress_new,
381  stress_old, // not used in updateState
382  elasticity_tensor,
383  elastic_strain_old,
384  false);
385  // do not compute tangent until the end of this substep (or not at all for is_ad == true)
386 
387  // update strain and stress
388  strain_increment += sub_strain_increment;
389  inelastic_strain_increment += sub_inelastic_strain_increment;
390  sub_elastic_strain_old += sub_strain_increment;
391  sub_stress_new = elasticity_tensor * sub_elastic_strain_old;
392 
393  // accumulate scalar_effective_inelastic_strain
394  sub_effective_inelastic_strain_increment += _effective_inelastic_strain_increment;
395 
396  if constexpr (!is_ad)
397  computeTangentOperator(effective_sub_stress_new, sub_stress_new, tangent_operator);
398 
399  // store incremental material properties for this step
400  this->storeIncrementalMaterialProperties(total_number_substeps);
401  }
402 
403  // update stress
404  stress_new = sub_stress_new;
405 
406  // update effective inelastic strain
407  updateEffectiveInelasticStrain(sub_effective_inelastic_strain_increment);
408 }
Moose::GenericType< Real, is_ad > GenericReal
void mooseSetToZero(T &v)
virtual void updateState(GenericRankTwoTensor< is_ad > &strain_increment, GenericRankTwoTensor< is_ad > &inelastic_strain_increment, const GenericRankTwoTensor< is_ad > &rotation_increment, GenericRankTwoTensor< is_ad > &stress_new, const RankTwoTensor &stress_old, const GenericRankFourTensor< is_ad > &elasticity_tensor, const RankTwoTensor &elastic_strain_old, bool compute_full_tangent_operator=false, RankFourTensor &tangent_operator=StressUpdateBaseTempl< is_ad >::_identityTensor) override
A radial return (J2) mapping method is performed with return mapping iterations.
Real _dt_original
original timestep (to be restored after substepping is completed)
void updateEffectiveInelasticStrain(const GenericReal< is_ad > &increment)
Real elasticity_tensor(unsigned int i, unsigned int j, unsigned int k, unsigned int l)
RankTwoTensorTempl< Real > deviatoric() const
void libmesh_ignore(const Args &...)
Real doubleContraction(const RankTwoTensorTempl< Real > &a) const
void computeTangentOperator(Real effective_trial_stress, const RankTwoTensor &stress_new, RankFourTensor &tangent_operator)
Calculate the tangent_operator.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
GenericReal< is_ad > _effective_inelastic_strain_increment
Stores the scalar effective inelastic strain increment from Newton iteration.
virtual void storeIncrementalMaterialProperties(const unsigned int)
Properly set up the incremental calculation storage of the stateful material properties in the inheri...
const unsigned int _maximum_number_substeps
Maximum number of substeps. If the calculation results in a larger number, cut overall time step...
Moose::GenericType< RankTwoTensor, is_ad > GenericRankTwoTensor

◆ validParams()

template<bool is_ad>
InputParameters IsotropicPlasticityStressUpdateTempl< is_ad >::validParams ( )
static

Definition at line 20 of file IsotropicPlasticityStressUpdate.C.

Referenced by TemperatureDependentHardeningStressUpdateTempl< is_ad >::validParams(), and IsotropicPowerLawHardeningStressUpdateTempl< is_ad >::validParams().

21 {
23  params.addClassDescription("This class uses the discrete material in a radial return isotropic "
24  "plasticity model. This class is one of the basic radial return "
25  "constitutive models, yet it can be used in conjunction with other "
26  "creep and plasticity materials for more complex simulations.");
27  // Linear strain hardening parameters
28  params.addParam<FunctionName>("yield_stress_function",
29  "Yield stress as a function of temperature");
30  params.addParam<Real>("yield_stress", "The point at which plastic strain begins accumulating");
31  params.addParam<FunctionName>("hardening_function",
32  "True stress as a function of plastic strain");
33  params.addParam<Real>("hardening_constant", "Hardening slope");
34  params.addCoupledVar("temperature", 0.0, "Coupled Temperature");
35  params.addDeprecatedParam<std::string>(
36  "plastic_prepend",
37  "",
38  "String that is prepended to the plastic_strain Material Property",
39  "This has been replaced by the 'base_name' parameter");
40  params.set<std::string>("effective_inelastic_strain_name") = "effective_plastic_strain";
41 
42  return params;
43 }
void addDeprecatedParam(const std::string &name, const T &value, const std::string &doc_string, const std::string &deprecation_message)
static InputParameters validParams()
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
T & set(const std::string &name, bool quiet_mode=false)
void addCoupledVar(const std::string &name, const std::string &doc_string)
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
void addClassDescription(const std::string &doc_string)

◆ yieldCondition()

template<bool is_ad>
GenericReal<is_ad> IsotropicPlasticityStressUpdateTempl< is_ad >::yieldCondition ( ) const
inline

Member Data Documentation

◆ _adaptive_substepping

template<bool is_ad>
const bool RadialReturnStressUpdateTempl< is_ad >::_adaptive_substepping
protectedinherited

Use adaptive substepping, cutting substep sizes until convergence is achieved.

Definition at line 260 of file RadialReturnStressUpdate.h.

Referenced by RadialReturnStressUpdateTempl< is_ad >::RadialReturnStressUpdateTempl().

◆ _apply_strain

template<bool is_ad>
const bool RadialReturnStressUpdateTempl< is_ad >::_apply_strain
protectedinherited

Debugging option to enable specifying instead of calculating strain.

Definition at line 254 of file RadialReturnStressUpdate.h.

◆ _base_name

const std::string StressUpdateBaseTempl< is_ad, RankTwoTensor , RankFourTensor >::_base_name
protectedinherited

Name used as a prefix for all material properties related to the stress update model.

Definition at line 191 of file StressUpdateBase.h.

◆ _bracket_solution

template<bool is_ad>
bool SingleVariableReturnMappingSolutionTempl< is_ad >::_bracket_solution
protectedinherited

Whether to save upper and lower bounds of root for scalar, and set solution to the midpoint between those bounds if outside them.

Definition at line 145 of file SingleVariableReturnMappingSolution.h.

◆ _check_range

template<bool is_ad>
bool SingleVariableReturnMappingSolutionTempl< is_ad >::_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 138 of file SingleVariableReturnMappingSolution.h.

Referenced by ADViscoplasticityStressUpdate::ADViscoplasticityStressUpdate(), LAROMANCEStressUpdateBaseTempl< is_ad >::LAROMANCEStressUpdateBaseTempl(), and PowerLawCreepTestTempl< is_ad >::PowerLawCreepTestTempl().

◆ _current_elem

template<bool is_ad>
const Elem *const & Material::_current_elem
inherited

◆ _deviatoric_projection_four

template<bool is_ad>
const RankFourTensor RadialReturnStressUpdateTempl< is_ad >::_deviatoric_projection_four
protectedinherited

Rank four deviatoric projection tensor.

Definition at line 251 of file RadialReturnStressUpdate.h.

◆ _dt

template<bool is_ad>
Real & Material::_dt
inherited

◆ _dt_original

template<bool is_ad>
Real RadialReturnStressUpdateTempl< is_ad >::_dt_original
protectedinherited

original timestep (to be restored after substepping is completed)

Definition at line 266 of file RadialReturnStressUpdate.h.

◆ _effective_inelastic_strain

template<bool is_ad>
GenericMaterialProperty<Real, is_ad>& RadialReturnStressUpdateTempl< is_ad >::_effective_inelastic_strain
protectedinherited

◆ _effective_inelastic_strain_increment

template<bool is_ad>
GenericReal<is_ad> RadialReturnStressUpdateTempl< is_ad >::_effective_inelastic_strain_increment
protectedinherited

Stores the scalar effective inelastic strain increment from Newton iteration.

Definition at line 223 of file RadialReturnStressUpdate.h.

Referenced by RadialReturnStressUpdateTempl< is_ad >::effectiveInelasticStrainIncrement(), and RadialReturnStressUpdateTempl< is_ad >::updateEffectiveInelasticStrainIncrement().

◆ _effective_inelastic_strain_old

template<bool is_ad>
const MaterialProperty<Real>& RadialReturnStressUpdateTempl< is_ad >::_effective_inelastic_strain_old
protectedinherited

◆ _hardening_constant

template<bool is_ad>
const Real IsotropicPlasticityStressUpdateTempl< is_ad >::_hardening_constant
protected

Definition at line 73 of file IsotropicPlasticityStressUpdate.h.

◆ _hardening_function

template<bool is_ad>
const Function* const IsotropicPlasticityStressUpdateTempl< is_ad >::_hardening_function
protected

Definition at line 74 of file IsotropicPlasticityStressUpdate.h.

◆ _hardening_slope

template<bool is_ad>
GenericReal<is_ad> IsotropicPlasticityStressUpdateTempl< is_ad >::_hardening_slope
protected

Definition at line 77 of file IsotropicPlasticityStressUpdate.h.

◆ _hardening_variable

template<bool is_ad>
GenericMaterialProperty<Real, is_ad>& IsotropicPlasticityStressUpdateTempl< is_ad >::_hardening_variable
protected

Definition at line 85 of file IsotropicPlasticityStressUpdate.h.

◆ _hardening_variable_old

template<bool is_ad>
const MaterialProperty<Real>& IsotropicPlasticityStressUpdateTempl< is_ad >::_hardening_variable_old
protected

Definition at line 86 of file IsotropicPlasticityStressUpdate.h.

◆ _identity_symmetric_four

template<bool is_ad>
const RankFourTensor RadialReturnStressUpdateTempl< is_ad >::_identity_symmetric_four
protectedinherited

Rank four symmetric identity tensor.

Definition at line 246 of file RadialReturnStressUpdate.h.

◆ _identity_two

template<bool is_ad>
const RankTwoTensor RadialReturnStressUpdateTempl< is_ad >::_identity_two
protectedinherited

Rank two identity tensor.

Definition at line 241 of file RadialReturnStressUpdate.h.

◆ _identityTensor

RankFourTensor StressUpdateBaseTempl< is_ad, RankTwoTensor , RankFourTensor >::_identityTensor
staticprotectedinherited

Definition at line 193 of file StressUpdateBase.h.

◆ _line_search

template<bool is_ad>
bool SingleVariableReturnMappingSolutionTempl< is_ad >::_line_search
protectedinherited

Whether to use line searches to improve convergence.

Definition at line 141 of file SingleVariableReturnMappingSolution.h.

◆ _max_inelastic_increment

template<bool is_ad>
Real RadialReturnStressUpdateTempl< is_ad >::_max_inelastic_increment
protectedinherited

Maximum allowable scalar inelastic strain increment, used to control the timestep size in conjunction with a user object.

Definition at line 229 of file RadialReturnStressUpdate.h.

◆ _maximum_number_substeps

template<bool is_ad>
const unsigned int RadialReturnStressUpdateTempl< is_ad >::_maximum_number_substeps
protectedinherited

Maximum number of substeps. If the calculation results in a larger number, cut overall time step.

Definition at line 263 of file RadialReturnStressUpdate.h.

◆ _plastic_prepend

template<bool is_ad>
const std::string IsotropicPlasticityStressUpdateTempl< is_ad >::_plastic_prepend
protected

a string to prepend to the plastic strain Material Property name

Definition at line 69 of file IsotropicPlasticityStressUpdate.h.

◆ _plastic_strain

template<bool is_ad>
GenericMaterialProperty<RankTwoTensor, is_ad>& IsotropicPlasticityStressUpdateTempl< is_ad >::_plastic_strain
protected

plastic strain in this model

Definition at line 80 of file IsotropicPlasticityStressUpdate.h.

◆ _plastic_strain_old

template<bool is_ad>
const MaterialProperty<RankTwoTensor>& IsotropicPlasticityStressUpdateTempl< is_ad >::_plastic_strain_old
protected

old value of plastic strain

Definition at line 83 of file IsotropicPlasticityStressUpdate.h.

◆ _q_point

template<bool is_ad>
const MooseArray< Point > & Material::_q_point
inherited

◆ _qp

template<bool is_ad>
unsigned int Material::_qp

◆ _substep_tolerance

template<bool is_ad>
const Real RadialReturnStressUpdateTempl< is_ad >::_substep_tolerance
protectedinherited

Used to calculate the number of substeps taken in the radial return algorithm, when substepping is enabled, based on the elastic strain increment ratio to the maximum inelastic increment.

Definition at line 236 of file RadialReturnStressUpdate.h.

◆ _temperature

template<bool is_ad>
const GenericVariableValue<is_ad>& IsotropicPlasticityStressUpdateTempl< is_ad >::_temperature
protected

Definition at line 87 of file IsotropicPlasticityStressUpdate.h.

◆ _three_shear_modulus

template<bool is_ad>
GenericReal<is_ad> RadialReturnStressUpdateTempl< is_ad >::_three_shear_modulus
protectedinherited

◆ _use_substepping

template<bool is_ad>
SubsteppingType RadialReturnStressUpdateTempl< is_ad >::_use_substepping
protectedinherited

◆ _yield_condition

template<bool is_ad>
GenericReal<is_ad> IsotropicPlasticityStressUpdateTempl< is_ad >::_yield_condition
protected

◆ _yield_stress

template<bool is_ad>
GenericReal<is_ad> IsotropicPlasticityStressUpdateTempl< is_ad >::_yield_stress
protected

◆ _yield_stress_function

template<bool is_ad>
const Function* IsotropicPlasticityStressUpdateTempl< is_ad >::_yield_stress_function
protected

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