RadialReturnBackstressStressUpdateBaseTempl< is_ad > Class Template Reference

#include <RadialReturnBackstressStressUpdateBase.h>

Inheritance diagram for RadialReturnBackstressStressUpdateBaseTempl< is_ad >:

Public Types
enum class	SubsteppingType { NONE , ERROR_BASED , INCREMENT_BASED }
using	GR2 = GenericRankTwoTensor< is_ad >
using	GSR2 = Moose::GenericType< R2, is_ad >
using	GR4 = GenericRankFourTensor< is_ad >
using	GSR4 = Moose::GenericType< R4, is_ad >
enum	TEST_TYPE
typedef DataFileName	DataFileParameterType

Public Member Functions
	RadialReturnBackstressStressUpdateBaseTempl (const InputParameters &parameters)
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.
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.
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.
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.
virtual GenericReal< is_ad >	minimumPermissibleValue (const GenericReal< is_ad > &) const override
	Compute the minimum permissible value of the scalar.
virtual GenericReal< is_ad >	maximumPermissibleValue (const GenericReal< is_ad > &effective_trial_stress) const override
	Compute the maximum permissible value of the scalar.
virtual Real	computeTimeStepLimit () override
	Compute the limiting value of the time step for this material.
bool	requiresIsotropicTensor () override
	Does the model require the elasticity tensor to be isotropic?
bool	isIsotropic () override
	Radial return mapped models should be isotropic by default!
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.
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.
virtual bool	substeppingCapabilityRequested () override
	Has the user requested usage of (possibly) implemented substepping capability for inelastic models.
const GenericReal< is_ad > &	effectiveInelasticStrainIncrement () const
	Current value of scalar inelastic strain.
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.
void	computeTangentOperator (Real effective_trial_stress, const RankTwoTensor &stress_new, RankFourTensor &tangent_operator)
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.
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.
virtual void	storeIncrementalMaterialProperties (const unsigned int)
	Properly set up the incremental calculation storage of the stateful material properties in the inheriting classes.
virtual void	resetIncrementalMaterialProperties ()
	Reset material properties.
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.
virtual const dof_id_type &	getElementID (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_type &	getElementIDNeighbor (const std::string &id_parameter_name, unsigned int comp=0) const override
virtual const dof_id_type &	getElementIDByName (const std::string &id_parameter_name) const override
virtual const dof_id_type &	getElementIDNeighborByName (const std::string &id_parameter_name) const override
virtual void	computeProperties () override
MaterialBase &	getMaterial (const std::string &name)
MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false, bool no_dep=false)
MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)
MaterialBase &	getMaterialByName (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
	CreateMooseEnumClass (ConstantTypeEnum, NONE, ELEMENT, SUBDOMAIN)
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 > &	getGenericZeroMaterialPropertyByName (const std::string &prop_name)
const MaterialProperty< T > &	getZeroMaterialProperty (Ts... args)
virtual void	initStatefulProperties (const 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 () const
void	checkStatefulSanity () const
std::set< OutputName >	getOutputs ()
bool	hasStatefulProperties () const
bool	hasRestoredProperties () const
void	setFaceInfo (const FaceInfo &fi)
void	setActiveProperties (const std::unordered_set< unsigned int > &needed_props)
bool	hasActiveProperties ()
bool	forceStatefulInit () const
virtual bool	enabled () const
std::shared_ptr< MooseObject >	getSharedPtr ()
std::shared_ptr< const MooseObject >	getSharedPtr () const
bool	isKokkosObject () const
MooseApp &	getMooseApp () const
const std::string &	type () const
const std::string &	name () const
std::string	typeAndName () const
MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const
MooseObjectName	uniqueName () const
const InputParameters &	parameters () const
const hit::Node *	getHitNode () const
bool	hasBase () const
const std::string &	getBase () 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
T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
bool	isParamValid (const std::string &name) const
bool	isParamSetByUser (const std::string &name) const
void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
void	paramError (const std::string &param, Args... args) const
void	paramWarning (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
std::string	messagePrefix (const bool hit_prefix=true) const
std::string	errorPrefix (const std::string &) const
void	mooseError (Args &&... args) const
void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
void	mooseErrorNonPrefixed (Args &&... args) const
void	mooseWarning (Args &&... args) const
void	mooseWarning (Args &&... args) const
void	mooseWarningNonPrefixed (Args &&... args) const
void	mooseWarningNonPrefixed (Args &&... args) const
void	mooseDeprecated (Args &&... args) const
void	mooseDeprecated (Args &&... args) const
void	mooseDeprecatedNoTrace (Args &&... args) const
void	mooseInfo (Args &&... args) const
void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) 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	hasBoundary (const std::vector< BoundaryID > &ids, TEST_TYPE type=ALL) const
bool	hasBoundary (const std::set< BoundaryID > &ids, TEST_TYPE type=ALL) 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 ExecFlagEnum &	getExecuteOnEnum () const
const std::set< MooseVariableFieldBase * > &	getMooseVariableDependencies () const
std::set< MooseVariableFieldBase * >	checkAllVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_omit={})
virtual std::set< MooseVariableFieldBase * >	checkVariables (const libMesh::Node &node, const std::set< MooseVariableFieldBase * > &vars_to_check)
std::set< MooseVariableFieldBase * >	checkVariables (const libMesh::Elem &element, 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 Function &	getFunction (const std::string &name) const
const Function &	getFunctionByName (const FunctionName &name) const
bool	hasFunction (const std::string &param_name) const
bool	hasFunctionByName (const FunctionName &name) const
Moose::Kokkos::Function	getKokkosFunction (const std::string &name) const
const T &	getKokkosFunction (const std::string &name) const
Moose::Kokkos::Function	getKokkosFunctionByName (const FunctionName &name) const
const T &	getKokkosFunctionByName (const FunctionName &name) const
bool	hasKokkosFunction (const std::string &param_name) const
bool	hasKokkosFunctionByName (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 UserObjectBase &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
const UserObjectBase &	getUserObjectBaseByName (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 VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOldByName (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_type >	getAllElemIDs (unsigned int elem_id_index) const
std::set< dof_id_type >	getElemIDsOnBlocks (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 ADVariableValue *	getADDefaultValue (const std::string &var_name) const
const ADVectorVariableValue *	getADDefaultVectorValue (const std::string &var_name) const
const ADVariableGradient &	getADDefaultGradient () const
const ADVectorVariableGradient &	getADDefaultVectorGradient () const
const ADVariableSecond &	getADDefaultSecond () const
const ADVectorVariableCurl &	getADDefaultCurl () const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::VariableGradient	kokkosCoupledVectorTagGradientByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::VariableGradient	kokkosCoupledVectorTagGradientsByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagNodalValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagNodalValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagDofValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagDofValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::VariableGradient	kokkosCoupledVectorTagGradient (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::VariableGradient	kokkosCoupledVectorTagGradients (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagNodalValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagNodalValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagDofValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagDofValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorTagVectorGradientByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorTagVectorGradientsByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorNodalValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorNodalValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorDofValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorDofValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorTagVectorGradient (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorTagVectorGradients (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorNodalValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorNodalValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorDofValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorDofValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::VariableValue	kokkosCoupledValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledValues (const std::string &var_name) const
Moose::Kokkos::VariableGradient	kokkosCoupledGradient (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableGradient	kokkosCoupledGradients (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledNodalValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledNodalValues (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledDofValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledDofValues (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledValuesOld (const std::string &var_name) const
Moose::Kokkos::VariableGradient	kokkosCoupledGradientOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableGradient	kokkosCoupledGradientsOld (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledNodalValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledNodalValuesOld (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledDofValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledDofValuesOld (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledValuesOlder (const std::string &var_name) const
Moose::Kokkos::VariableGradient	kokkosCoupledGradientOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableGradient	kokkosCoupledGradientsOlder (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledNodalValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledNodalValuesOlder (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledDofValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledDofValuesOlder (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledDot (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledDots (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledNodalDot (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledNodalDots (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorNodalValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorDofValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorValues (const std::string &var_name) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorGradients (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorNodalValues (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorDofValues (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorGradientOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorNodalValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorDofValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorValuesOld (const std::string &var_name) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorGradientsOld (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorNodalValuesOld (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorDofValuesOld (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorGradientOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorNodalValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorDofValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorValuesOlder (const std::string &var_name) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorGradientsOlder (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorNodalValuesOlder (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorDofValuesOlder (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorDot (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorNodalDot (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorDots (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorNodalDots (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledVectorTagGradientByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledVectorTagGradientsByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagNodalValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagNodalValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagDofValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagDofValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledVectorTagGradient (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledVectorTagGradients (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagNodalValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagNodalValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagDofValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagDofValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledValues (const std::string &var_name) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledGradient (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledGradients (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledNodalValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledNodalValues (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledDofValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledDofValues (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledValuesOld (const std::string &var_name) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledGradientOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledGradientsOld (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledNodalValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledNodalValuesOld (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledDofValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledDofValuesOld (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledValuesOlder (const std::string &var_name) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledGradientOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledGradientsOlder (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledNodalValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledNodalValuesOlder (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledDofValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledDofValuesOlder (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledDot (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledDots (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledNodalDot (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledNodalDots (const std::string &var_name) const
Moose::Kokkos::Scalar< const Real >	kokkosCoupledDotDu (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosZeroValue () const
Moose::Kokkos::VariableGradient	kokkosZeroGradient () const
Moose::Kokkos::VariableValue	kokkosZeroNodalValue () 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)
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyByName (const std::string &prop_name_in)
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOldByName (const std::string &prop_name)
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlderByName (const std::string &prop_name)
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialProperty (const std::string &name)
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOld (const std::string &name)
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlder (const std::string &name)
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > >	getBlockMaterialProperty (const MaterialPropertyName &name)
std::pair< Moose::Kokkos::MaterialProperty< T, dimension >, std::set< SubdomainID > >	getKokkosBlockMaterialProperty (const MaterialPropertyName &name)
std::set< SubdomainID >	getMaterialPropertyBlocks (const std::string &name)
std::vector< SubdomainName >	getMaterialPropertyBlockNames (const std::string &name)
std::set< BoundaryID >	getMaterialPropertyBoundaryIDs (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)
virtual 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 Distribution &	getDistribution (const std::string &name) const
const T &	getDistribution (const std::string &name) const
const Distribution &	getDistribution (const std::string &name) const
const T &	getDistribution (const std::string &name) const
const Distribution &	getDistributionByName (const DistributionName &name) const
const T &	getDistributionByName (const std::string &name) const
const Distribution &	getDistributionByName (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 PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const
virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const
const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const
const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const
const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const
const PostprocessorValue &	getPostprocessorValueOlderByName (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	hasKokkosMaterialProperty (const std::string &name)
bool	hasKokkosMaterialProperty (const std::string &name)
bool	hasKokkosMaterialPropertyByName (const std::string &name)
bool	hasKokkosMaterialPropertyByName (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)
PenetrationLocator &	getPenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
PenetrationLocator &	getQuadraturePenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
NearestNodeLocator &	getNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
NearestNodeLocator &	getQuadratureNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
bool	requiresGeometricSearch () const
const Moose::Functor< Real > *	defaultFunctor (const std::string &name)
const Moose::Functor< ADReal > *	defaultFunctor (const std::string &name)
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.
void	resetProperties () final

Static Public Member Functions
static InputParameters	validParams ()
static void	callMooseError (MooseApp *const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node *node, const bool show_trace=true)
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, NameFunc &&name_func)
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
	usingCombinedWarningSolutionWarnings
const ConsoleStream	_console

Static Public Attributes
static const std::string	type_param
static const std::string	name_param
static const std::string	unique_name_param
static const std::string	app_param
static const std::string	moose_base_param
static const std::string	kokkos_object_param
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.
virtual void	updateState (GenericRankTwoTensor< is_ad > &strain_increment, GenericRankTwoTensor< is_ad > &inelastic_strain_increment, const GenericRankTwoTensor< is_ad > &, GenericRankTwoTensor< is_ad > &stress_new, const RankTwoTensor &, const GenericRankFourTensor< is_ad > &elasticity_tensor, const RankTwoTensor &elastic_strain_old, bool compute_full_tangent_operator, RankFourTensor &tangent_operator) override
	A radial return (J2) mapping method is performed with return mapping iterations.
void	propagateQpStatefulPropertiesRadialReturn ()
	Propagate the properties pertaining to this intermediate class.
virtual void	computeStressInitialize (const GenericReal< is_ad > &effective_trial_stress, const GenericRankFourTensor< is_ad > &elasticity_tensor)
	Perform any necessary initialization before return mapping iterations.
virtual Real	computeStressDerivative (const Real, const Real)
	Calculate the derivative of the strain increment with respect to the updated stress.
virtual void	computeStressFinalize (const GenericRankTwoTensor< is_ad > &)
	Perform any necessary steps to finalize state after return mapping iterations.
void	outputIterationSummary (std::stringstream *iter_output, const unsigned int total_it) override
	Output summary information for the convergence history of the model.
virtual void	checkMaterialProperty (const std::string &name, const unsigned int state) override
virtual const MaterialData &	materialData () const override
virtual MaterialData &	materialData () override
virtual Moose::MaterialDataType	materialDataType () override
virtual const QBase &	qRule () const override
virtual void	computeQpProperties ()
virtual const FEProblemBase &	miProblem () const
virtual FEProblemBase &	miProblem ()
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 ()
void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const
virtual bool	hasBlockMaterialPropertyHelper (const std::string &prop_name)
void	initializeBlockRestrictable (const MooseObject *moose_object)
void	initializeKokkosBlockRestrictable ()
Moose::CoordinateSystemType	getBlockCoordSystem ()
KOKKOS_FUNCTION dof_id_type	numKokkosBlockElements () const
KOKKOS_FUNCTION dof_id_type	numKokkosBlockNodes () const
KOKKOS_FUNCTION dof_id_type	numKokkosBlockSides () const
KOKKOS_FUNCTION ContiguousElementID	kokkosBlockElementID (Moose::Kokkos::ThreadID tid) const
KOKKOS_FUNCTION ContiguousElementID	kokkosBlockNodeID (Moose::Kokkos::ThreadID tid) const
KOKKOS_FUNCTION auto	kokkosBlockElementSideID (Moose::Kokkos::ThreadID tid) const
bool	hasBoundaryMaterialPropertyHelper (const std::string &prop_name) const
KOKKOS_FUNCTION dof_id_type	numKokkosBoundaryNodes () const
KOKKOS_FUNCTION dof_id_type	numKokkosBoundarySides () const
KOKKOS_FUNCTION ContiguousNodeID	kokkosBoundaryNodeID (Moose::Kokkos::ThreadID tid) const
KOKKOS_FUNCTION auto	kokkosBoundaryElementSideID (Moose::Kokkos::ThreadID tid) 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 VariableValue &	coupledScalarValue (const std::string &var_name, unsigned int comp=0) const
const ADVariableValue &	adCoupledScalarValue (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 VariableValue &	coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
const VariableValue &	coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
const VariableValue &	coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
const VariableValue &	coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
const VariableValue &	coupledScalarDot (const std::string &var_name, unsigned int comp=0) const
const ADVariableValue &	adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
const VariableValue &	coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
const VariableValue &	coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
const VariableValue &	coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
const VariableValue &	coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
const VariableValue &	coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const
const MooseVariableScalar *	getScalarVar (const std::string &var_name, unsigned int comp) const
virtual void	addUserObjectDependencyHelper (const UserObjectBase &) 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)
const Moose::Functor< T > &	getFunctorByName (const std::string &name)
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 int >	coupledIndices (const std::string &var_name) const
virtual const VariableValue &	coupledValue (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 VariableValue &	coupledValueLower (const std::string &var_name, unsigned int comp=0) const
const ADVariableValue &	adCoupledValue (const std::string &var_name, unsigned int comp=0) const
std::vector< const ADVariableValue * >	adCoupledValues (const std::string &var_name) const
const ADVariableValue &	adCoupledLowerValue (const std::string &var_name, unsigned int comp=0) const
const ADVectorVariableValue &	adCoupledVectorValue (const std::string &var_name, unsigned int comp=0) const
std::vector< const ADVectorVariableValue * >	adCoupledVectorValues (const std::string &var_name) const
virtual const VariableValue &	coupledVectorTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
virtual const VariableValue &	coupledVectorTagValue (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 ArrayVariableValue &	coupledVectorTagArrayValue (const std::string &var_names, TagID tag, unsigned int index=0) const
virtual const ArrayVariableValue &	coupledVectorTagArrayValue (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 VariableGradient &	coupledVectorTagGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
virtual const VariableGradient &	coupledVectorTagGradient (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 ArrayVariableGradient &	coupledVectorTagArrayGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
virtual const ArrayVariableGradient &	coupledVectorTagArrayGradient (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 VariableValue &	coupledVectorTagDofValue (const std::string &var_name, TagID tag, unsigned int index=0) const
virtual const VariableValue &	coupledVectorTagDofValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
const ArrayVariableValue &	coupledVectorTagArrayDofValue (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 VariableValue &	coupledMatrixTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
virtual const VariableValue &	coupledMatrixTagValue (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 VectorVariableValue &	coupledVectorValue (const std::string &var_name, unsigned int comp=0) const
virtual const ArrayVariableValue &	coupledArrayValue (const std::string &var_name, unsigned int comp=0) const
std::vector< const ArrayVariableValue * >	coupledArrayValues (const std::string &var_name) const
MooseWritableVariable &	writableVariable (const std::string &var_name, unsigned int comp=0)
virtual VariableValue &	writableCoupledValue (const std::string &var_name, unsigned int comp=0)
void	checkWritableVar (MooseWritableVariable *var)
virtual const VariableValue &	coupledValueOld (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 VariableValue &	coupledValueOlder (const std::string &var_name, unsigned int comp=0) const
std::vector< const VariableValue * >	coupledValuesOlder (const std::string &var_name) const
virtual const VariableValue &	coupledValuePreviousNL (const std::string &var_name, unsigned int comp=0) const
virtual const VectorVariableValue &	coupledVectorValueOld (const std::string &var_name, unsigned int comp=0) const
virtual const VectorVariableValue &	coupledVectorValueOlder (const std::string &var_name, unsigned int comp=0) const
virtual const ArrayVariableValue &	coupledArrayValueOld (const std::string &var_name, unsigned int comp=0) const
virtual const ArrayVariableValue &	coupledArrayValueOlder (const std::string &var_name, unsigned int comp=0) const
virtual const VariableGradient &	coupledGradient (const std::string &var_name, unsigned int comp=0) const
std::vector< const VariableGradient * >	coupledGradients (const std::string &var_name) const
const ADVariableGradient &	adCoupledGradient (const std::string &var_name, unsigned int comp=0) const
const ADVariableGradient &	adCoupledGradientDot (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 ADVectorVariableGradient &	adCoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
const ADVariableSecond &	adCoupledSecond (const std::string &var_name, unsigned int comp=0) const
const ADVectorVariableSecond &	adCoupledVectorSecond (const std::string &var_name, unsigned int comp=0) const
virtual const VariableGradient &	coupledGradientOld (const std::string &var_name, unsigned int comp=0) const
std::vector< const VariableGradient * >	coupledGradientsOld (const std::string &var_name) const
virtual const VariableGradient &	coupledGradientOlder (const std::string &var_name, unsigned int comp=0) const
virtual const VariableGradient &	coupledGradientPreviousNL (const std::string &var_name, unsigned int comp=0) const
virtual const VariableGradient &	coupledGradientDot (const std::string &var_name, unsigned int comp=0) const
virtual const VariableGradient &	coupledGradientDotDot (const std::string &var_name, unsigned int comp=0) const
virtual const VectorVariableGradient &	coupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
virtual const VectorVariableGradient &	coupledVectorGradientOld (const std::string &var_name, unsigned int comp=0) const
virtual const VectorVariableGradient &	coupledVectorGradientOlder (const std::string &var_name, unsigned int comp=0) const
virtual const ArrayVariableGradient &	coupledArrayGradient (const std::string &var_name, unsigned int comp=0) const
virtual const ArrayVariableGradient &	coupledArrayGradientOld (const std::string &var_name, unsigned int comp=0) const
virtual const ArrayVariableGradient &	coupledArrayGradientOlder (const std::string &var_name, unsigned int comp=0) const
virtual const ArrayVariableGradient &	coupledArrayGradientDot (const std::string &var_name, unsigned int comp=0) const
virtual const VectorVariableCurl &	coupledCurl (const std::string &var_name, unsigned int comp=0) const
virtual const VectorVariableCurl &	coupledCurlOld (const std::string &var_name, unsigned int comp=0) const
virtual const VectorVariableCurl &	coupledCurlOlder (const std::string &var_name, unsigned int comp=0) const
const ADVectorVariableCurl &	adCoupledCurl (const std::string &var_name, unsigned int comp=0) const
virtual const VectorVariableDivergence &	coupledDiv (const std::string &var_name, unsigned int comp=0) const
virtual const VectorVariableDivergence &	coupledDivOld (const std::string &var_name, unsigned int comp=0) const
virtual const VectorVariableDivergence &	coupledDivOlder (const std::string &var_name, unsigned int comp=0) const
virtual const VariableSecond &	coupledSecond (const std::string &var_name, unsigned int comp=0) const
virtual const VariableSecond &	coupledSecondOld (const std::string &var_name, unsigned int comp=0) const
virtual const VariableSecond &	coupledSecondOlder (const std::string &var_name, unsigned int comp=0) const
virtual const VariableSecond &	coupledSecondPreviousNL (const std::string &var_name, unsigned int comp=0) const
virtual const VariableValue &	coupledDot (const std::string &var_name, unsigned int comp=0) const
std::vector< const VariableValue * >	coupledDots (const std::string &var_name) const
virtual const VariableValue &	coupledDotDot (const std::string &var_name, unsigned int comp=0) const
virtual const VariableValue &	coupledDotOld (const std::string &var_name, unsigned int comp=0) const
virtual const VariableValue &	coupledDotDotOld (const std::string &var_name, unsigned int comp=0) const
const ADVariableValue &	adCoupledDot (const std::string &var_name, unsigned int comp=0) const
std::vector< const ADVariableValue * >	adCoupledDots (const std::string &var_name) const
const ADVariableValue &	adCoupledDotDot (const std::string &var_name, unsigned int comp=0) const
const ADVectorVariableValue &	adCoupledVectorDot (const std::string &var_name, unsigned int comp=0) const
virtual const VectorVariableValue &	coupledVectorDot (const std::string &var_name, unsigned int comp=0) const
virtual const VectorVariableValue &	coupledVectorDotDot (const std::string &var_name, unsigned int comp=0) const
virtual const VectorVariableValue &	coupledVectorDotOld (const std::string &var_name, unsigned int comp=0) const
virtual const VectorVariableValue &	coupledVectorDotDotOld (const std::string &var_name, unsigned int comp=0) const
virtual const VariableValue &	coupledVectorDotDu (const std::string &var_name, unsigned int comp=0) const
virtual const VariableValue &	coupledVectorDotDotDu (const std::string &var_name, unsigned int comp=0) const
virtual const ArrayVariableValue &	coupledArrayDot (const std::string &var_name, unsigned int comp=0) const
virtual const ArrayVariableValue &	coupledArrayDotDot (const std::string &var_name, unsigned int comp=0) const
virtual const ArrayVariableValue &	coupledArrayDotOld (const std::string &var_name, unsigned int comp=0) const
virtual const ArrayVariableValue &	coupledArrayDotDotOld (const std::string &var_name, unsigned int comp=0) const
virtual const VariableValue &	coupledDotDu (const std::string &var_name, unsigned int comp=0) const
virtual const VariableValue &	coupledDotDotDu (const std::string &var_name, unsigned int comp=0) const
const VariableValue &	coupledArrayDotDu (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 >::type &	adCoupledNodalValue (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 VariableValue &	coupledNodalDotDot (const std::string &var_name, unsigned int comp=0) const
virtual const VariableValue &	coupledNodalDotOld (const std::string &var_name, unsigned int comp=0) const
virtual const VariableValue &	coupledNodalDotDotOld (const std::string &var_name, unsigned int comp=0) const
virtual const VariableValue &	coupledDofValues (const std::string &var_name, unsigned int comp=0) const
std::vector< const VariableValue * >	coupledAllDofValues (const std::string &var_name) const
virtual const VariableValue &	coupledDofValuesOld (const std::string &var_name, unsigned int comp=0) const
std::vector< const VariableValue * >	coupledAllDofValuesOld (const std::string &var_name) const
virtual const VariableValue &	coupledDofValuesOlder (const std::string &var_name, unsigned int comp=0) const
std::vector< const VariableValue * >	coupledAllDofValuesOlder (const std::string &var_name) const
virtual const ArrayVariableValue &	coupledArrayDofValues (const std::string &var_name, unsigned int comp=0) const
virtual const ADVariableValue &	adCoupledDofValues (const std::string &var_name, unsigned int comp=0) const
const ADVariableValue &	adZeroValue () const
const ADVariableGradient &	adZeroGradient () const
const ADVariableSecond &	adZeroSecond () 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 MooseVariableFieldBase *	getFEVar (const std::string &var_name, unsigned int comp) const
const MooseVariableFieldBase *	getFieldVar (const std::string &var_name, unsigned int comp) const
MooseVariableFieldBase *	getFieldVar (const std::string &var_name, unsigned int comp)
std::vector< const MooseVariableFieldBase * >	getFieldVars (const std::string &var_name) const
const T *	getVarHelper (const std::string &var_name, unsigned int comp) const
T *	getVarHelper (const std::string &var_name, unsigned int comp)
std::vector< const T * >	getVarsHelper (const std::string &var_name) const
MooseVariable *	getVar (const std::string &var_name, unsigned int comp)
const MooseVariable *	getVar (const std::string &var_name, unsigned int comp) const
VectorMooseVariable *	getVectorVar (const std::string &var_name, unsigned int comp)
const VectorMooseVariable *	getVectorVar (const std::string &var_name, unsigned int comp) const
ArrayMooseVariable *	getArrayVar (const std::string &var_name, unsigned int comp)
const ArrayMooseVariable *	getArrayVar (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
virtual void	getKokkosMaterialPropertyHook (const std::string &, const unsigned int)
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.
virtual GenericReal< is_ad >	initialGuess (const GenericReal< is_ad > &)
	Compute an initial guess for the value of the scalar.
virtual GenericReal< is_ad >	computeResidual (const GenericReal< is_ad > &, const GenericReal< is_ad > &)=0
	Compute the residual for a predicted value of the scalar.
virtual GenericReal< is_ad >	computeDerivative (const GenericReal< is_ad > &, const GenericReal< is_ad > &)=0
	Compute the derivative of the residual as a function of the scalar variable.
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.
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.
virtual void	iterationFinalize (const GenericReal< is_ad > &)
	Finalize internal state variables for a model for a given iteration.
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.
bool	converged (const GenericReal< is_ad > &residual, const Real reference)
	Check to see whether the residual is within the convergence limits.

Protected Attributes
GenericMaterialProperty< RankTwoTensor, is_ad > &	_backstress
const MaterialProperty< RankTwoTensor > &	_backstress_old
GenericReal< is_ad >	_three_shear_modulus
	3 * shear modulus
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.
Real	_max_inelastic_increment
	Maximum allowable scalar inelastic strain increment, used to control the timestep size in conjunction with a user object.
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.
const RankTwoTensor	_identity_two
	Rank two identity tensor.
const RankFourTensor	_identity_symmetric_four
	Rank four symmetric identity tensor.
const RankFourTensor	_deviatoric_projection_four
	Rank four deviatoric projection tensor.
const bool	_apply_strain
	Debugging option to enable specifying instead of calculating strain.
SubsteppingType	_use_substepping
	Whether user has requested the use of substepping technique to improve convergence [make const later].
const bool	_adaptive_substepping
	Use adaptive substepping, cutting substep sizes until convergence is achieved.
const unsigned int	_maximum_number_substeps
	Maximum number of substeps. If the calculation results in a larger number, cut overall time step.
Real	_dt_original
	original timestep (to be restored after substepping is completed)
const std::string	_base_name
	Name used as a prefix for all material properties related to the stress update model.
	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 MaterialPropertyName	_declare_suffix
const bool &	_enabled
MooseApp &	_app
Factory &	_factory
ActionFactory &	_action_factory
const std::string &	_type
const std::string &	_name
const InputParameters &	_pars
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< MooseVariableField< Real > * >	_coupled_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 bool	_is_kokkos_object
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.
bool	_line_search
	Whether to use line searches to improve convergence.
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.

Static Protected Attributes
static RankFourTensor	_identityTensor
static const std::string	_interpolated_old
static const std::string	_interpolated_older

Private Types
enum	FuncAge
enum	VarType
enum class	InternalSolveOutput { NEVER , ON_ERROR , ALWAYS }
enum class	SolveState { SUCCESS , NAN_INF , EXCEEDED_ITERATIONS }

Private Member Functions
const ADVariableValue *	getADDefaultValue (const std::string &var_name) const
const Moose::Functor< T > &	getFunctorByName (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
const Moose::Functor< T > *	defaultFunctor (const std::string &name)
const Moose::Functor< Real > *	defaultFunctor (const std::string &name)
const Moose::Functor< ADReal > *	defaultFunctor (const std::string &name)
void	checkVar (const std::string &var_name) const
void	validateExecutionerType (const std::string &name, const std::string &fn_name) const
void	markMatPropRequested (const std::string &name)
ConstantTypeEnum	computeConstantOption ()
void	storeSubdomainZeroMatProp (SubdomainID block_id, const MaterialPropertyName &name)
void	storeBoundaryZeroMatProp (BoundaryID boundary_id, const MaterialPropertyName &name)
unsigned int	getMaxQps () const
void	initializeBoundaryRestrictable ()
void	initializeKokkosBoundaryRestrictable ()
std::set< MooseVariableFieldBase * >	checkVariablesHelper (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_check)
const VariableValue *	getDefaultValue (const std::string &var_name) const
const Moose::FunctionBase *	getKokkosFunctionByNameHelper (const FunctionName &name) const
const UserObjectBase &	getUserObjectFromFEProblem (const UserObjectName &object_name, const THREAD_ID tid=0) const
const T &	castUserObject (const UserObjectBase &uo_base, const std::string &param_name="") const
void	mooseObjectError (const std::string &param_name, std::stringstream &oss) const
const std::string &	userObjectType (const UserObjectBase &uo) const
const std::string &	userObjectName (const UserObjectBase &uo) const
const PostprocessorName &	getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const
bool	isDefaultPostprocessorValueByName (const PostprocessorName &name) const
PostprocessorValue	getDefaultPostprocessorValueByName (const PostprocessorName &name) const
void	checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const
bool	postprocessorsAdded () const
const VectorPostprocessorValue &	getVectorPostprocessorByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name, bool broadcast, std::size_t t_index) const
const VectorPostprocessorContext< VectorPostprocessorValue > &	getVectorPostprocessorContextByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name) const
bool	vectorPostprocessorsAdded () const
RestartableDataValue &	registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const
void	registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)
RestartableData< T > &	declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const
virtual bool	isADObject () const override
const OutputTools< T >::VariableValue &	vectorTagValueHelper (const std::string &var_names, TagID tag, unsigned int index=0) const
const OutputTools< T >::VariableValue &	vectorTagValueHelper (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
const OutputTools< T >::VariableValue &	vectorTagDofValueHelper (const std::string &var_name, TagID tag, unsigned int comp=0) const
const OutputTools< T >::VariableValue &	vectorTagDofValueHelper (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
void	requestStates (const std::string &var_name, const TagName &tag_name, const unsigned int comp)
void	checkFuncType (const std::string var_name, VarType t, FuncAge age) const
const VectorVariableValue *	getDefaultVectorValue (const std::string &var_name) const
const ArrayVariableValue *	getDefaultArrayValue (const std::string &var_name) const
const T &	getDefaultNodalValue (const std::string &var_name, unsigned int comp=0) const
const RealVectorValue &	getDefaultNodalValue (const std::string &var_name, unsigned int) const
const RealEigenVector &	getDefaultNodalValue (const std::string &var_name, unsigned int) const
const Moose::Functor< T > &	getDefaultFunctor (const std::string &var_name) const
Moose::Kokkos::Variable	kokkosCoupledVectorTagVariable (const std::string &var_name, const std::string &tag_name, unsigned int comp) const
Moose::Kokkos::Variable	kokkosCoupledVectorTagVariables (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::Variable	kokkosCoupledVectorTagVectorVariable (const std::string &var_name, const std::string &tag_name, unsigned int comp) const
Moose::Kokkos::Variable	kokkosCoupledVectorTagVectorVariables (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::Variable	kokkosZeroVariable () const
Moose::MaterialDataType	getMaterialDataType (const std::set< BoundaryID > &boundary_ids) const
void	addConsumedPropertyName (const MooseObjectName &obj_name, const std::string &prop_name)
const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
void	possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
void	possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
void	possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
void	possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
void	computeResidualAndDerivativeHelper (const GenericReal< is_ad > &effective_trial_stress, const GenericReal< is_ad > &scalar)
	Helper function to compute and set the _residual and _derivative.
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.
bool	convergedAcceptable (const unsigned int it, const Real reference)
	Check to see whether the residual is within acceptable convergence limits.
void	checkPermissibleRange (GenericReal< is_ad > &scalar, GenericReal< is_ad > &scalar_increment, const GenericReal< is_ad > &scalar_old, const GenericReal< is_ad > min_permissible_scalar, const GenericReal< is_ad > max_permissible_scalar, std::stringstream *iter_output)
	Check to see whether solution is within admissible range, and set it within that range if it is not.
void	updateBounds (const GenericReal< is_ad > &scalar, const GenericReal< is_ad > &residual, const Real init_resid_sign, GenericReal< is_ad > &scalar_upper_bound, GenericReal< is_ad > &scalar_lower_bound, std::stringstream *iter_output)
	Update the upper and lower bounds of the root for the effective inelastic strain.

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)
static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
std::unordered_map< std::string, std::unique_ptr< VariableValue > >	_default_value
bool	_ghostable
std::vector< std::unique_ptr< OptionalMaterialPropertyProxyBase< Material > > >	_optional_property_proxies
const bool	_force_stateful_init
const ParallelParamObject &	_parent
const MooseBase &	_si_moose_base
const FEProblemBase *	_si_problem
std::set< SubdomainID >	_blk_ids
std::vector< SubdomainID >	_vec_ids
std::vector< SubdomainName >	_blocks
const bool	_blk_dual_restrictable
FEProblemBase *	_blk_feproblem
const MooseMesh *	_blk_mesh
const std::set< BoundaryID >	_empty_boundary_ids
const std::set< BoundaryID > &	_boundary_ids
THREAD_ID	_blk_tid
const std::string &	_blk_name
unsigned int	_blk_dim
const MooseObject *	_moose_object
Moose::Kokkos::Array< ContiguousElementID >	_kokkos_element_ids
Moose::Kokkos::Array< ContiguousNodeID >	_kokkos_node_ids
Moose::Kokkos::Array< Moose::Kokkos::Pair< ContiguousElementID, unsigned int > >	_kokkos_element_side_ids
FEProblemBase *	_bnd_feproblem
MooseMesh *	_bnd_mesh
std::set< BoundaryID >	_bnd_ids
std::vector< BoundaryName >	_boundary_names
const bool	_bnd_dual_restrictable
const std::set< SubdomainID >	_empty_block_ids
const std::set< SubdomainID > &	_block_ids
THREAD_ID	_bnd_tid
const MaterialData &	_bnd_material_data
bool	_bnd_nodal
ExecFlagEnum	_empty_execute_enum
std::set< MooseVariableFieldBase * >	_moose_variable_dependencies
std::vector< libMesh::dof_id_type >	_dof_indices
const InputParameters &	_sc_parameters
const std::string &	_sc_name
const bool	_sc_is_implicit
std::unordered_map< std::string, std::vector< MooseVariableScalar * > >	_coupled_scalar_vars
std::unordered_map< std::string, std::unique_ptr< ADVariableValue > >	_dual_default_value
std::vector< MooseVariableScalar * >	_coupled_moose_scalar_vars
std::unordered_map< std::string, std::vector< MooseVariableFieldBase * > >	_sc_coupled_vars
std::set< TagID >	_sc_coupleable_vector_tags
std::set< TagID >	_sc_coupleable_matrix_tags
const MooseObject &	_fni_object
const InputParameters &	_fni_params
FEProblemBase &	_fni_feproblem
const THREAD_ID	_fni_tid
const InputParameters &	_dni_params
FEProblemBase &	_dni_feproblem
const MooseObject *const	_dni_moose_object_ptr
const MooseObject &	_uoi_moose_object
const FEProblemBase &	_uoi_feproblem
const THREAD_ID	_uoi_tid
const std::string	_ti_name
const MooseObject &	_ppi_moose_object
const InputParameters &	_ppi_params
const FEProblemBase &	_ppi_feproblem
std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > >	_default_values
const bool	_broadcast_by_default
const MooseObject &	_vpi_moose_object
const FEProblemBase &	_vpi_feproblem
const THREAD_ID	_vpi_tid
const RestartableDataMapName	_metaname
std::string	_restartable_name
MooseApp &	_oi_moose_app
OutputWarehouse &	_oi_output_warehouse
std::set< OutputName >	_oi_outputs
RandomData *	_random_data
MooseRandom *	_generator
FEProblemBase &	_ri_problem
const std::string	_ri_name
unsigned int	_master_seed
bool	_is_nodal
ExecFlagType	_reset_on
const Node *const &	_curr_node
const Elem *const &	_curr_element
const InputParameters &	_obj_parameters
std::shared_ptr< MooseMesh > &	_id_mesh
const std::string &	_ei_name
const InputParameters &	_fi_params
const std::string	_fi_name
SubProblem *const	_fi_subproblem
const THREAD_ID	_fi_tid
std::vector< std::unique_ptr< Moose::Functor< Real > > >	_default_real_functors
std::vector< std::unique_ptr< Moose::Functor< ADReal > > >	_default_ad_real_functors
unsigned int	_coupleable_max_qps
std::unordered_map< std::string, std::vector< unsigned int > >	_optional_var_index
std::unordered_map< std::string, std::vector< MooseVariableScalar * > >	_c_coupled_scalar_vars
std::set< TagID >	_fe_coupleable_vector_tags
std::set< TagID >	_fe_coupleable_matrix_tags
const bool	_is_fv
const MooseObject *const	_obj
const std::set< std::string >	_older_state_tags
std::vector< std::set< MooseWritableVariable * > >	_writable_coupled_variables
const Real	_kokkos_default_value_zero
const MooseObject &	_mi_moose_object
const bool	_mi_boundary_restricted
const std::set< SubdomainID > &	_mi_block_ids
const std::set< BoundaryID > &	_mi_boundary_ids
enum SingleVariableReturnMappingSolutionTempl::InternalSolveOutput	_internal_solve_output_on
const unsigned int	_max_its
	Maximum number of return mapping iterations.
const bool	_internal_solve_full_iteration_history
	Whether to output iteration information all the time (regardless of whether iterations converge)
Real	_relative_tolerance
	Relative convergence tolerance.
Real	_absolute_tolerance
	Absolute convergence tolerance.
Real	_acceptable_multiplier
	Multiplier applied to relative and absolute tolerances for acceptable convergence.
const bool	_ad_derivative
const std::size_t	_num_resids
	Number of residuals to be stored in history.
std::vector< Real >	_residual_history
	History of residuals used to check whether progress is still being made on decreasing the residual.
unsigned int	_iteration
	iteration number
GenericReal< is_ad >	_derivative
	Derivative of the residual.
const std::string	_svrms_name
	MOOSE input name of the object performing the solve.
GenericReal< is_ad >	_initial_residual
	Residual values, kept as members to retain solver state for summary outputting.
GenericReal< is_ad >	_residual

Detailed Description

template<bool is_ad>
class RadialReturnBackstressStressUpdateBaseTempl< is_ad >

Definition at line 6 of file RadialReturnBackstressStressUpdateBase.h.

Member Typedef Documentation

GR2

template<bool is_ad, typename R2 = RankTwoTensor, typename R4 = RankFourTensor>

using StressUpdateBaseTempl< is_ad, R2, R4 >::GR2 = GenericRankTwoTensor<is_ad>

inherited

Definition at line 57 of file StressUpdateBase.h.

GR4

template<bool is_ad, typename R2 = RankTwoTensor, typename R4 = RankFourTensor>

using StressUpdateBaseTempl< is_ad, R2, R4 >::GR4 = GenericRankFourTensor<is_ad>

inherited

Definition at line 59 of file StressUpdateBase.h.

GSR2

template<bool is_ad, typename R2 = RankTwoTensor, typename R4 = RankFourTensor>

using StressUpdateBaseTempl< is_ad, R2, R4 >::GSR2 = Moose::GenericType<R2, is_ad>

inherited

Definition at line 58 of file StressUpdateBase.h.

GSR4

template<bool is_ad, typename R2 = RankTwoTensor, typename R4 = RankFourTensor>

using StressUpdateBaseTempl< is_ad, R2, R4 >::GSR4 = Moose::GenericType<R4, is_ad>

inherited

Definition at line 60 of file StressUpdateBase.h.

Member Enumeration Documentation

InternalSolveOutput

template<bool is_ad>

enum class SingleVariableReturnMappingSolutionTempl::InternalSolveOutput

strongprivateinherited

Enumerator
NEVER
ON_ERROR
ALWAYS

Definition at line 172 of file SingleVariableReturnMappingSolution.h.

  {
    NEVER,
    ON_ERROR,
    ALWAYS
  } _internal_solve_output_on;

SolveState

template<bool is_ad>

enum class SingleVariableReturnMappingSolutionTempl::SolveState

strongprivateinherited

Enumerator
SUCCESS
NAN_INF
EXCEEDED_ITERATIONS

Definition at line 179 of file SingleVariableReturnMappingSolution.h.

  {
    SUCCESS,
    NAN_INF,
    EXCEEDED_ITERATIONS
  };

SubsteppingType

template<bool is_ad>

enum class RadialReturnStressUpdateTempl::SubsteppingType

stronginherited

Enumerator
NONE
ERROR_BASED
INCREMENT_BASED

Definition at line 43 of file RadialReturnStressUpdate.h.

  {
    NONE,
    ERROR_BASED,
    INCREMENT_BASED
  };

Constructor & Destructor Documentation

RadialReturnBackstressStressUpdateBaseTempl()

template<bool is_ad>

RadialReturnBackstressStressUpdateBaseTempl< is_ad >::RadialReturnBackstressStressUpdateBaseTempl

(

const InputParameters &

parameters

)

Definition at line 13 of file RadialReturnBackstressStressUpdateBase.C.

  : RadialReturnStressUpdateTempl<is_ad>(parameters),
    _backstress(this->template declareGenericProperty<RankTwoTensor, is_ad>(this->_base_name +
                                                                            "backstress")),
    _backstress_old(
        this->template getMaterialPropertyOld<RankTwoTensor>(this->_base_name + "backstress"))
{
}

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_increment

When called, this is the elastic strain guess

Returns

The number of substeps required

Definition at line 150 of file RadialReturnStressUpdate.C.

{
  // compute an effective elastic strain measure
  const GenericReal<is_ad> contracted_elastic_strain =
      strain_increment.doubleContraction(strain_increment);
  const Real effective_elastic_strain =
      std::sqrt(3.0 / 2.0 * MetaPhysicL::raw_value(contracted_elastic_strain));
 
  if (MooseUtils::absoluteFuzzyEqual(effective_elastic_strain, 0.0))
    return 1;
 
  if (_use_substepping == SubsteppingType::INCREMENT_BASED)
  {
    const Real ratio = effective_elastic_strain / _max_inelastic_increment;
 
    if (ratio > _substep_tolerance)
      return std::ceil(ratio / _substep_tolerance);
    return 1;
  }
 
  if (_use_substepping == SubsteppingType::ERROR_BASED)
  {
    const Real accurate_time_step_ratio = _substep_tolerance / effective_elastic_strain;
 
    if (accurate_time_step_ratio < 1.0)
      return std::ceil(1.0 / accurate_time_step_ratio);
    return 1;
  }
 
  mooseError("calculateNumberSubsteps should not have been called. Notify a developer.");
}

calculateNumberSubsteps() [2/2]

template<bool is_ad, typename R2 = RankTwoTensor, typename R4 = RankFourTensor>

virtual int StressUpdateBaseTempl< is_ad, R2, R4 >::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.

{ return 1; }

checkPermissibleRange()

template<bool is_ad>

void SingleVariableReturnMappingSolutionTempl< is_ad >::checkPermissibleRange ( GenericReal< is_ad > &  scalar, GenericReal< is_ad > &  scalar_increment, const GenericReal< is_ad > &  scalar_old, const GenericReal< is_ad >  min_permissible_scalar, const GenericReal< is_ad >  max_permissible_scalar, std::stringstream *  iter_output  )

privateinherited

Check to see whether solution is within admissible range, and set it within that range if it is not.

Parameters

scalar	Current value of the inelastic strain increment
scalar_increment	Incremental change in scalar from the previous iteration
scalar_old	Previous value of scalar
min_permissible_scalar	Minimum permissible value of scalar
max_permissible_scalar	Maximum permissible value of scalar
iter_output	Output stream

Definition at line 361 of file SingleVariableReturnMappingSolution.C.

{
  if (scalar > max_permissible_scalar)
  {
    scalar_increment = (max_permissible_scalar - scalar_old) / 2.0;
    scalar = scalar_old + scalar_increment;
    if (iter_output)
      *iter_output << "Scalar greater than maximum ("
                   << MetaPhysicL::raw_value(max_permissible_scalar)
                   << ") adjusted scalar=" << MetaPhysicL::raw_value(scalar)
                   << " scalar_increment=" << MetaPhysicL::raw_value(scalar_increment) << std::endl;
  }
  else if (scalar < min_permissible_scalar)
  {
    scalar_increment = (min_permissible_scalar - scalar_old) / 2.0;
    scalar = scalar_old + scalar_increment;
    if (iter_output)
      *iter_output << "Scalar less than minimum (" << MetaPhysicL::raw_value(min_permissible_scalar)
                   << ") adjusted scalar=" << MetaPhysicL::raw_value(scalar)
                   << " scalar_increment=" << MetaPhysicL::raw_value(scalar_increment) << std::endl;
  }
}

computeDerivative()

template<bool is_ad>

virtual GenericReal< is_ad > SingleVariableReturnMappingSolutionTempl< is_ad >::computeDerivative ( const GenericReal< is_ad > &  , const GenericReal< is_ad > &    )

protectedpure virtualinherited

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

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

Parameters

effective_trial_stress	Effective trial stress
scalar	Inelastic strain increment magnitude being solved for

Implemented in LAROMANCEStressUpdateBaseTempl< is_ad >, CombinedNonlinearHardeningPlasticityTempl< is_ad >, CompositePowerLawCreepStressUpdateTempl< is_ad >, IsotropicPlasticityStressUpdateTempl< is_ad >, PowerLawCreepStressUpdateTempl< is_ad >, and PowerLawCreepTestTempl< is_ad >.

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_stress	Effective trial stress
scalar	Inelastic strain increment magnitude being solved for

Implements SingleVariableReturnMappingSolutionTempl< is_ad >.

Definition at line 471 of file RadialReturnStressUpdate.C.

{
  return MetaPhysicL::raw_value(effective_trial_stress / _three_shear_modulus) -
         MetaPhysicL::raw_value(scalar_effective_inelastic_strain);
}

computeResidual()

template<bool is_ad>

virtual GenericReal< is_ad > SingleVariableReturnMappingSolutionTempl< is_ad >::computeResidual ( const GenericReal< is_ad > &  , const GenericReal< is_ad > &    )

protectedpure virtualinherited

Compute the residual for a predicted value of the scalar.

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

Parameters

effective_trial_stress	Effective trial stress
scalar	Inelastic strain increment magnitude being solved for

Implemented in CombinedNonlinearHardeningPlasticityTempl< is_ad >, CompositePowerLawCreepStressUpdateTempl< is_ad >, IsotropicPlasticityStressUpdateTempl< is_ad >, LAROMANCEStressUpdateBaseTempl< is_ad >, PowerLawCreepStressUpdateTempl< is_ad >, and PowerLawCreepTestTempl< is_ad >.

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_stress	Effective trial stress
scalar	Inelastic strain increment magnitude being solved for

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

Definition at line 97 of file SingleVariableReturnMappingSolution.h.

  {
    mooseError("computeResidualAndDerivative has to be implemented if "
               "automatic_differentiation_return_mapping = true.");
    return 0;
  };

computeResidualAndDerivativeHelper()

template<bool is_ad>

void SingleVariableReturnMappingSolutionTempl< is_ad >::computeResidualAndDerivativeHelper ( const GenericReal< is_ad > &  effective_trial_stress, const GenericReal< is_ad > &  scalar  )

privateinherited

Helper function to compute and set the _residual and _derivative.

Definition at line 308 of file SingleVariableReturnMappingSolution.C.

{
  if (_ad_derivative)
  {
    GenericChainedReal<is_ad> residual_and_derivative =
        computeResidualAndDerivative(effective_trial_stress, GenericChainedReal<is_ad>(scalar, 1));
    _residual = residual_and_derivative.value();
    _derivative = residual_and_derivative.derivatives();
  }
  else
  {
    _residual = computeResidual(effective_trial_stress, scalar);
    _derivative = computeDerivative(effective_trial_stress, scalar);
  }
}

computeStrainEnergyRateDensity()

template<bool is_ad, typename R2 = RankTwoTensor, typename R4 = RankFourTensor>

virtual Real StressUpdateBaseTempl< is_ad, R2, R4 >::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

stress	The stress tensor at the end of the step
strain_rate	The 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.

  {
    mooseError(
        "The computation of strain energy rate density needs to be implemented by a child class");
    return 0.0;
  }

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_stress	Effective trial stress
scalar	Inelastic strain increment magnitude being solved for

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

Definition at line 199 of file RadialReturnStressUpdate.h.

  {
    return 0.0;
  }

computeStressFinalize()

template<bool is_ad>

virtual void RadialReturnStressUpdateTempl< is_ad >::computeStressFinalize ( const GenericRankTwoTensor< is_ad > &  )

inlineprotectedvirtualinherited

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

Parameters

inelasticStrainIncrement

Inelastic strain increment

Reimplemented in CombinedNonlinearHardeningPlasticityTempl< is_ad >, CompositePowerLawCreepStressUpdateTempl< is_ad >, IsotropicPlasticityStressUpdateTempl< is_ad >, LAROMANCEStressUpdateBaseTempl< is_ad >, PowerLawCreepStressUpdateTempl< is_ad >, and RadialReturnCreepStressUpdateBaseTempl< is_ad >.

Definition at line 209 of file RadialReturnStressUpdate.h.

  {
  }

computeStressInitialize()

template<bool is_ad>

void RadialReturnStressUpdateTempl< is_ad >::computeStressInitialize ( const GenericReal< is_ad > &  effective_trial_stress, const GenericRankFourTensor< is_ad > &  elasticity_tensor  )

protectedvirtualinherited

Perform any necessary initialization before return mapping iterations.

Parameters

effective_trial_stress	Effective trial stress
elasticityTensor	Elasticity tensor

Reimplemented in CombinedNonlinearHardeningPlasticityTempl< is_ad >, CompositePowerLawCreepStressUpdateTempl< is_ad >, IsotropicPlasticityStressUpdateTempl< is_ad >, IsotropicPowerLawHardeningStressUpdateTempl< is_ad >, LAROMANCEStressUpdateBaseTempl< is_ad >, PowerLawCreepStressUpdateTempl< is_ad >, and TemperatureDependentHardeningStressUpdateTempl< is_ad >.

Definition at line 133 of file RadialReturnStressUpdate.C.

{
  // Set the value of 3 * shear modulus for use as a reference residual value
  _three_shear_modulus = 3.0 * ElasticityTensorTools::getIsotropicShearModulus(elasticity_tensor);
}

Referenced by ADMultiplePowerLawCreepStressUpdate::computeStressInitialize(), CombinedNonlinearHardeningPlasticityTempl< is_ad >::computeStressInitialize(), CompositePowerLawCreepStressUpdateTempl< is_ad >::computeStressInitialize(), IsotropicPlasticityStressUpdateTempl< is_ad >::computeStressInitialize(), IsotropicPowerLawHardeningStressUpdateTempl< is_ad >::computeStressInitialize(), LAROMANCEStressUpdateBaseTempl< is_ad >::computeStressInitialize(), PowerLawCreepStressUpdateTempl< is_ad >::computeStressInitialize(), and TemperatureDependentHardeningStressUpdateTempl< is_ad >::computeStressInitialize().

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.

{
  mooseError("computeTangentOperator called: no tangent computation is needed for AD");
}

Referenced by ComputeCreepPlasticityStress::computeTangentOperators().

computeTangentOperator() [2/3]

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

inherited

computeTangentOperator() [3/3]

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

inherited

Definition at line 194 of file RadialReturnStressUpdate.C.

{
  if (getTangentCalculationMethod() == TangentCalculationMethod::PARTIAL)
  {
    if (MooseUtils::absoluteFuzzyEqual(_effective_inelastic_strain_increment, 0.0))
      tangent_operator.zero();
    else
    {
      // mu = _three_shear_modulus / 3.0;
      // norm_dev_stress = ||s_n+1||
      // effective_trial_stress = von mises trial stress = std::sqrt(3.0 / 2.0) * ||s_n+1^trial||
      // scalar_effective_inelastic_strain = Delta epsilon^cr_n+1
      // deriv = derivative of scalar_effective_inelastic_strain w.r.t. von mises stress
      // deriv = std::sqrt(3.0 / 2.0) partial Delta epsilon^cr_n+1n over partial ||s_n+1^trial||
 
      mooseAssert(_three_shear_modulus != 0.0, "Shear modulus is zero");
 
      const RankTwoTensor deviatoric_stress = stress_new.deviatoric();
      const Real norm_dev_stress_squared = deviatoric_stress.doubleContraction(deviatoric_stress);
      if (MooseUtils::absoluteFuzzyEqual(norm_dev_stress_squared, 0.0))
      {
        tangent_operator.zero();
        return;
      }
      const Real norm_dev_stress = std::sqrt(norm_dev_stress_squared);
 
      const RankTwoTensor flow_direction = deviatoric_stress / norm_dev_stress;
      const RankFourTensor flow_direction_dyad = flow_direction.outerProduct(flow_direction);
      const Real deriv =
          computeStressDerivative(effective_trial_stress, _effective_inelastic_strain_increment);
      const Real scalar_one = _three_shear_modulus * _effective_inelastic_strain_increment /
                              std::sqrt(1.5) / norm_dev_stress;
 
      tangent_operator = scalar_one * _deviatoric_projection_four +
                         (_three_shear_modulus * deriv - scalar_one) * flow_direction_dyad;
    }
  }
}

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, R2, R4 >.

Reimplemented in LAROMANCEStressUpdateBaseTempl< is_ad >.

Definition at line 489 of file RadialReturnStressUpdate.C.

{
  const Real scalar_inelastic_strain_incr =
      std::abs(MetaPhysicL::raw_value(_effective_inelastic_strain[_qp]) -
               _effective_inelastic_strain_old[_qp]);
  if (!scalar_inelastic_strain_incr)
    return std::numeric_limits<Real>::max();
 
  return _dt * _max_inelastic_increment / scalar_inelastic_strain_incr;
}

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

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

residual	Current value of the residual
reference	Current value of the reference quantity

Returns

Whether the model converged

Definition at line 327 of file SingleVariableReturnMappingSolution.C.

{
  const Real residual = MetaPhysicL::raw_value(ad_residual);
  return (std::abs(residual) <= _absolute_tolerance ||
          std::abs(residual / reference) <= _relative_tolerance);
}

convergedAcceptable()

template<bool is_ad>

bool SingleVariableReturnMappingSolutionTempl< is_ad >::convergedAcceptable ( const unsigned int  it, const Real  reference  )

privateinherited

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

This will only return true if it has been determined that progress is no longer being made and that the residual is within the acceptable limits.

Parameters

residual	Current iteration count
residual	Current value of the residual
reference	Current value of the reference quantity

Returns

Whether the model converged

Definition at line 337 of file SingleVariableReturnMappingSolution.C.

{
  using std::abs;
 
  // Require that we have at least done _num_resids evaluations before we allow for
  // acceptable convergence
  if (it < _num_resids)
    return false;
 
  // Check to see whether the residual has dropped by convergence_history_factor over
  // the last _num_resids iterations. If it has (which means it's still making progress),
  // don't consider it to be converged within the acceptable limits.
  const Real convergence_history_factor = 10.0;
  if (abs(_residual * convergence_history_factor) < abs(_residual_history[(it + 1) % _num_resids]))
    return false;
 
  // Now that it's determined that progress is not being made, treat it as converged if
  // we're within the acceptable convergence limits
  return converged(_residual / _acceptable_multiplier, reference);
}

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.

  {
    return _effective_inelastic_strain_increment;
  }

Referenced by ComputeCreepPlasticityStress::updateQpState().

getTangentCalculationMethod() [1/2]

template<bool is_ad, typename R2 , typename R4 >

TangentCalculationMethod StressUpdateBaseTempl< is_ad, R2, R4 >::getTangentCalculationMethod ( )

virtualinherited

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

Definition at line 101 of file StressUpdateBase.C.

{
  return TangentCalculationMethod::ELASTIC;
}

getTangentCalculationMethod() [2/2]

TangentCalculationMethod StressUpdateBaseTempl< true >::getTangentCalculationMethod ( )

inherited

Definition at line 108 of file StressUpdateBase.C.

{
  mooseError(
      "getTangentCalculationMethod called: no tangent moduli calculation is needed while using AD");
  return TangentCalculationMethod::ELASTIC;
}

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_stress

Effective trial stress

Reimplemented in PowerLawCreepTestTempl< is_ad >.

Definition at line 66 of file SingleVariableReturnMappingSolution.h.

  {
    return 0.0;
  }

initQpStatefulProperties()

template<bool is_ad>

void RadialReturnBackstressStressUpdateBaseTempl< is_ad >::initQpStatefulProperties ( )

overrideprotectedvirtual

Reimplemented from RadialReturnStressUpdateTempl< is_ad >.

Reimplemented in CombinedNonlinearHardeningPlasticityTempl< is_ad >.

Definition at line 25 of file RadialReturnBackstressStressUpdateBase.C.

{
  _backstress[_qp].zero();
  RadialReturnStressUpdateTempl<is_ad>::initQpStatefulProperties();
}

Referenced by CombinedNonlinearHardeningPlasticityTempl< is_ad >::initQpStatefulProperties().

internalSolve()

template<bool is_ad>

SingleVariableReturnMappingSolutionTempl< is_ad >::SolveState SingleVariableReturnMappingSolutionTempl< is_ad >::internalSolve ( const GenericReal< is_ad >  effective_trial_stress, GenericReal< is_ad > &  scalar, std::stringstream *  iter_output = nullptr  )

privateinherited

Method called from within this class to perform the actual return mappping iterations.

Parameters

effective_trial_stress	Effective trial stress
scalar	Inelastic strain increment magnitude being solved for
iter_output	Output stream – if null, no output is produced

Returns

Whether the solution was successful

Definition at line 163 of file SingleVariableReturnMappingSolution.C.

{
  scalar = initialGuess(effective_trial_stress);
  GenericReal<is_ad> scalar_old = scalar;
  GenericReal<is_ad> scalar_increment = 0.0;
  const GenericReal<is_ad> min_permissible_scalar = minimumPermissibleValue(effective_trial_stress);
  const GenericReal<is_ad> max_permissible_scalar = maximumPermissibleValue(effective_trial_stress);
  GenericReal<is_ad> scalar_upper_bound = max_permissible_scalar;
  GenericReal<is_ad> scalar_lower_bound = min_permissible_scalar;
  _iteration = 0;
 
  computeResidualAndDerivativeHelper(effective_trial_stress, scalar);
  _initial_residual = _residual;
 
  GenericReal<is_ad> residual_old = _residual;
  Real init_resid_sign = MathUtils::sign(MetaPhysicL::raw_value(_residual));
  Real reference_residual = computeReferenceResidual(effective_trial_stress, scalar);
 
  if (converged(_residual, reference_residual))
  {
    iterationFinalize(scalar);
    outputIterationStep(iter_output, effective_trial_stress, scalar, reference_residual);
    return SolveState::SUCCESS;
  }
 
  _residual_history.assign(_num_resids, std::numeric_limits<Real>::max());
  _residual_history[0] = MetaPhysicL::raw_value(_residual);
 
  while (_iteration < _max_its && !converged(_residual, reference_residual) &&
         !convergedAcceptable(_iteration, reference_residual))
  {
    preStep(scalar_old, _residual, _derivative);
 
    scalar_increment = -_residual / _derivative;
    scalar = scalar_old + scalar_increment;
 
    if (_check_range)
      checkPermissibleRange(scalar,
                            scalar_increment,
                            scalar_old,
                            min_permissible_scalar,
                            max_permissible_scalar,
                            iter_output);
 
    computeResidualAndDerivativeHelper(effective_trial_stress, scalar);
    reference_residual = computeReferenceResidual(effective_trial_stress, scalar);
    iterationFinalize(scalar);
 
    if (_bracket_solution)
      updateBounds(
          scalar, _residual, init_resid_sign, scalar_upper_bound, scalar_lower_bound, iter_output);
 
    if (converged(_residual, reference_residual))
    {
      outputIterationStep(iter_output, effective_trial_stress, scalar, reference_residual);
      break;
    }
    else
    {
      bool modified_increment = false;
 
      // Line Search
      if (_line_search)
      {
        if (residual_old - _residual != 0.0)
        {
          GenericReal<is_ad> alpha = residual_old / (residual_old - _residual);
          alpha = MathUtils::clamp(alpha, 1.0e-2, 1.0);
 
          if (alpha != 1.0)
          {
            modified_increment = true;
            scalar_increment *= alpha;
            if (iter_output)
              *iter_output << "  Line search alpha = " << MetaPhysicL::raw_value(alpha)
                           << " increment = " << MetaPhysicL::raw_value(scalar_increment)
                           << std::endl;
          }
        }
      }
 
      if (_bracket_solution)
      {
        // Check to see whether trial scalar_increment is outside the bounds, and set it to a point
        // within the bounds if it is
        if (scalar_old + scalar_increment >= scalar_upper_bound ||
            scalar_old + scalar_increment <= scalar_lower_bound)
        {
          if (scalar_upper_bound != max_permissible_scalar &&
              scalar_lower_bound != min_permissible_scalar)
          {
            const Real frac = 0.5;
            scalar_increment =
                (1.0 - frac) * scalar_lower_bound + frac * scalar_upper_bound - scalar_old;
            modified_increment = true;
            if (iter_output)
              *iter_output << "  Trial scalar_increment exceeded bounds.  Setting between "
                              "lower/upper bounds. frac: "
                           << frac << std::endl;
          }
        }
      }
 
      // Update the trial scalar and recompute residual if the line search or bounds checking
      // modified the increment
      if (modified_increment)
      {
        scalar = scalar_old + scalar_increment;
        computeResidualAndDerivativeHelper(effective_trial_stress, scalar);
        reference_residual = computeReferenceResidual(effective_trial_stress, scalar);
        iterationFinalize(scalar);
 
        if (_bracket_solution)
          updateBounds(scalar,
                       _residual,
                       init_resid_sign,
                       scalar_upper_bound,
                       scalar_lower_bound,
                       iter_output);
      }
    }
 
    outputIterationStep(iter_output, effective_trial_stress, scalar, reference_residual);
 
    ++_iteration;
    residual_old = _residual;
    scalar_old = scalar;
    _residual_history[_iteration % _num_resids] = MetaPhysicL::raw_value(_residual);
  }
 
  using std::isnan, std::isinf;
  if (isnan(_residual) || isinf(MetaPhysicL::raw_value(_residual)))
    return SolveState::NAN_INF;
 
  if (_iteration == _max_its)
    return SolveState::EXCEEDED_ITERATIONS;
 
  return SolveState::SUCCESS;
}

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, R2, R4 >.

Definition at line 128 of file RadialReturnStressUpdate.h.

{ return true; };

iterationFinalize()

template<bool is_ad>

virtual void SingleVariableReturnMappingSolutionTempl< is_ad >::iterationFinalize ( const GenericReal< is_ad > &  )

inlineprotectedvirtualinherited

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

Parameters

scalar

Inelastic strain increment magnitude being solved for

Reimplemented in CombinedNonlinearHardeningPlasticityTempl< is_ad >, and IsotropicPlasticityStressUpdateTempl< is_ad >.

Definition at line 128 of file SingleVariableReturnMappingSolution.h.

{}

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_stress

Effective trial stress

Reimplemented from SingleVariableReturnMappingSolutionTempl< is_ad >.

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

Definition at line 481 of file RadialReturnStressUpdate.C.

{
  return effective_trial_stress / _three_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_stress

Effective trial stress

Reimplemented from SingleVariableReturnMappingSolutionTempl< is_ad >.

Reimplemented in PowerLawCreepTestTempl< is_ad >.

Definition at line 106 of file RadialReturnStressUpdate.h.

  {
    return 0.0;
  }

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_output	Output stream
effective_trial_stress	Effective trial stress
residual	Current value of the residual
reference	Current value of the reference quantity

Reimplemented in LAROMANCEStressUpdateBaseTempl< is_ad >.

Definition at line 421 of file SingleVariableReturnMappingSolution.C.

{
  if (iter_output)
  {
    const unsigned int it = _iteration;
    const Real residual = MetaPhysicL::raw_value(_residual);
 
    *iter_output << " iteration=" << it
                 << " trial_stress=" << MetaPhysicL::raw_value(effective_trial_stress)
                 << " scalar=" << MetaPhysicL::raw_value(scalar) << " residual=" << residual
                 << " ref_res=" << reference_residual
                 << " rel_res=" << std::abs(residual) / reference_residual
                 << " rel_tol=" << _relative_tolerance << " abs_res=" << std::abs(residual)
                 << " abs_tol=" << _absolute_tolerance << '\n';
  }
}

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

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_output	Output stream
total_it	Total iteration count

Reimplemented from SingleVariableReturnMappingSolutionTempl< is_ad >.

Definition at line 502 of file RadialReturnStressUpdate.C.

{
  if (iter_output)
  {
    *iter_output << "At element " << _current_elem->id() << " _qp=" << _qp << " Coordinates "
                 << _q_point[_qp] << " block=" << _current_elem->subdomain_id() << '\n';
  }
  SingleVariableReturnMappingSolutionTempl<is_ad>::outputIterationSummary(iter_output, total_it);
}

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.

  {
  }

propagateQpStatefulProperties()

template<bool is_ad>

void RadialReturnBackstressStressUpdateBaseTempl< 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, R2, R4 >.

Reimplemented in CombinedNonlinearHardeningPlasticityTempl< is_ad >.

Definition at line 33 of file RadialReturnBackstressStressUpdateBase.C.

{
  _backstress[_qp] = _backstress_old[_qp];
  propagateQpStatefulPropertiesRadialReturn();
}

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.

{
  _effective_inelastic_strain[_qp] = _effective_inelastic_strain_old[_qp];
}

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

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, R2, R4 >.

Definition at line 123 of file RadialReturnStressUpdate.h.

{ return true; }

resetIncrementalMaterialProperties()

template<bool is_ad, typename R2 = RankTwoTensor, typename R4 = RankFourTensor>

virtual void StressUpdateBaseTempl< is_ad, R2, R4 >::resetIncrementalMaterialProperties ( )

inlinevirtualinherited

Reset material properties.

Useful for substepping with inelastic models.

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

Definition at line 172 of file StressUpdateBase.h.

{}

resetProperties()

template<bool is_ad, typename R2 = RankTwoTensor, typename R4 = RankFourTensor>

void StressUpdateBaseTempl< is_ad, R2, R4 >::resetProperties ( )

inlinefinalvirtualinherited

Reimplemented from Material.

Definition at line 138 of file StressUpdateBase.h.

{}

resetQpProperties()

template<bool is_ad, typename R2 = RankTwoTensor, typename R4 = RankFourTensor>

void StressUpdateBaseTempl< is_ad, R2, R4 >::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.

{}

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_stress	Effective trial stress
scalar	Inelastic strain increment magnitude being solved for
console	Console output

Definition at line 100 of file SingleVariableReturnMappingSolution.C.

{
  // construct the stringstream here only if the debug level is set to ALL
  std::unique_ptr<std::stringstream> iter_output =
      (_internal_solve_output_on == InternalSolveOutput::ALWAYS)
          ? std::make_unique<std::stringstream>()
          : nullptr;
 
  // do the internal solve and capture iteration info during the first round
  // iff full history output is requested regardless of whether the solve failed or succeeded
  auto solve_state =
      internalSolve(effective_trial_stress,
                    scalar,
                    _internal_solve_full_iteration_history ? iter_output.get() : nullptr);
  if (solve_state != SolveState::SUCCESS &&
      _internal_solve_output_on != InternalSolveOutput::ALWAYS)
  {
    // output suppressed by user, throw immediately
    if (_internal_solve_output_on == InternalSolveOutput::NEVER)
      mooseException("");
 
    // user expects some kind of output, if necessary setup output stream now
    if (!iter_output)
      iter_output = std::make_unique<std::stringstream>();
 
    // add the appropriate error message to the output
    switch (solve_state)
    {
      case SolveState::NAN_INF:
        *iter_output << "Encountered inf or nan in material return mapping iterations.\n";
        break;
 
      case SolveState::EXCEEDED_ITERATIONS:
        *iter_output << "Exceeded maximum iterations in material return mapping iterations.\n";
        break;
 
      default:
        mooseError("Unhandled solver state");
    }
 
    // if full history output is only requested for failed solves we have to repeat
    // the solve a second time
    if (_internal_solve_full_iteration_history)
      internalSolve(effective_trial_stress, scalar, iter_output.get());
 
    // Append summary and throw exception
    outputIterationSummary(iter_output.get(), _iteration);
    mooseException(iter_output->str());
  }
 
  if (_internal_solve_output_on == InternalSolveOutput::ALWAYS)
  {
    // the solve did not fail but the user requested debug output anyways
    outputIterationSummary(iter_output.get(), _iteration);
    console << iter_output->str() << std::flush;
  }
}

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

setQp()

template<bool is_ad, typename R2 , typename R4 >

void StressUpdateBaseTempl< is_ad, R2, R4 >::setQp ( unsigned int  qp )

inherited

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

Definition at line 46 of file StressUpdateBase.C.

{
  _qp = qp;
}

Referenced by ComputeCreepPlasticityStress::updateQpState().

storeIncrementalMaterialProperties()

template<bool is_ad, typename R2 = RankTwoTensor, typename R4 = RankFourTensor>

virtual void StressUpdateBaseTempl< is_ad, R2, R4 >::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 166 of file StressUpdateBase.h.

                                                                        {
  };

substeppingCapabilityEnabled()

template<bool is_ad, typename R2 = RankTwoTensor, typename R4 = RankFourTensor>

virtual bool StressUpdateBaseTempl< is_ad, R2, R4 >::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 ADMultiplePowerLawCreepStressUpdate, CompositePowerLawCreepStressUpdateTempl< is_ad >, LAROMANCEStressUpdateBaseTempl< is_ad >, and PowerLawCreepStressUpdateTempl< is_ad >.

Definition at line 147 of file StressUpdateBase.h.

{ 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, R2, R4 >.

Definition at line 145 of file RadialReturnStressUpdate.h.

  {
    return _use_substepping != SubsteppingType::NONE;
  }

updateBounds()

template<bool is_ad>

void SingleVariableReturnMappingSolutionTempl< is_ad >::updateBounds ( const GenericReal< is_ad > &  scalar, const GenericReal< is_ad > &  residual, const Real  init_resid_sign, GenericReal< is_ad > &  scalar_upper_bound, GenericReal< is_ad > &  scalar_lower_bound, std::stringstream *  iter_output  )

privateinherited

Update the upper and lower bounds of the root for the effective inelastic strain.

Parameters

scalar	Current value of the inelastic strain increment
residual	Current value of the residual
init_resid_sign	Sign of the initial value of the residual
scalar_upper_bound	Upper bound value of scalar
scalar_lower_bound	Lower bound value of scalar
iter_output	Output stream

Definition at line 392 of file SingleVariableReturnMappingSolution.C.

{
  // Update upper/lower bounds as applicable
  if (residual * init_resid_sign < 0.0 && scalar < scalar_upper_bound)
  {
    scalar_upper_bound = scalar;
    if (scalar_upper_bound < scalar_lower_bound)
    {
      scalar_upper_bound = scalar_lower_bound;
      scalar_lower_bound = 0.0;
      if (iter_output)
        *iter_output << "  Corrected for scalar_upper_bound < scalar_lower_bound" << std::endl;
    }
  }
  // Don't permit setting scalar_lower_bound > scalar_upper_bound (but do permit the reverse).
  // This ensures that if we encounter multiple roots, we pick the lowest one.
  else if (residual * init_resid_sign > 0.0 && scalar > scalar_lower_bound &&
           scalar < scalar_upper_bound)
    scalar_lower_bound = scalar;
}

updateEffectiveInelasticStrain()

template<bool is_ad>

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

inlineinherited

Definition at line 161 of file RadialReturnStressUpdate.h.

  {
    _effective_inelastic_strain[_qp] = _effective_inelastic_strain_old[_qp] + increment;
  }

Referenced by ComputeCreepPlasticityStress::finalizeConstitutiveModels().

updateEffectiveInelasticStrainIncrement()

template<bool is_ad>

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

inlineinherited

Definition at line 156 of file RadialReturnStressUpdate.h.

  {
    _effective_inelastic_strain_increment = eisi;
  }

Referenced by ComputeCreepPlasticityStress::finalizeConstitutiveModels().

updateState() [1/2]

template<bool is_ad>

void RadialReturnBackstressStressUpdateBaseTempl< 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, RankFourTensor &  tangent_operator  )

overrideprotectedvirtual

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

Parameters

strain_increment	Sum of elastic and inelastic strain increments
inelastic_strain_increment	Inelastic strain increment calculated by this class
rotation	increment Not used by this class
stress_new	New trial stress from pure elastic calculation
stress_old	Old state of stress
elasticity_tensor	Rank 4 C_{ijkl}, must be isotropic
elastic_strain_old	Old state of total elastic strain
compute_full_tangent_operator	Flag currently unused by this class
tangent_operator	Currently a copy of the elasticity tensor in this class

Reimplemented from RadialReturnStressUpdateTempl< is_ad >.

Definition at line 41 of file RadialReturnBackstressStressUpdateBase.C.

{
  GenericRankTwoTensor<is_ad> stress_corrected = stress_new - _backstress_old[_qp];
 
  RadialReturnStressUpdateTempl<is_ad>::updateState(strain_increment,
                                                    inelastic_strain_increment,
                                                    rotation_increment,
                                                    stress_corrected,
                                                    stress_old,
                                                    elasticity_tensor,
                                                    elastic_strain_old,
                                                    compute_full_tangent_operator,
                                                    tangent_operator);
  stress_new = stress_corrected;
}

updateState() [2/2]

template<bool is_ad, typename R2 , typename R4 >

void StressUpdateBaseTempl< is_ad, R2, R4 >::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_increment	Upon input: the strain increment. Upon output: the elastic strain increment
inelastic_strain_increment	The inelastic_strain resulting from the interative procedure
rotation_increment	The finite-strain rotation increment
stress_new	Upon input: the trial stress that results from applying strain_increment as an elastic strain. Upon output: the admissible stress
stress_old	The old value of stress
elasticity_tensor	The elasticity tensor
compute_full_tangent_operator	The 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_operator	d(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

Reimplemented in LinearViscoelasticStressUpdate, and MultiParameterPlasticityStressUpdate.

Definition at line 68 of file StressUpdateBase.C.

{
  mooseError("updateState called: it needs to be implemented by your inelastic model");
}

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

{
  unsigned int num_substeps = calculateNumberSubsteps(strain_increment);
  _dt_original = _dt;
  while (true)
  {
    try
    {
      updateStateSubstepInternal(strain_increment,
                                 inelastic_strain_increment,
                                 rotation_increment,
                                 stress_new,
                                 stress_old,
                                 elasticity_tensor,
                                 elastic_strain_old,
                                 num_substeps,
                                 compute_full_tangent_operator,
                                 tangent_operator);
    }
    catch (MooseException & e)
    {
      // if we are not using adaptive substepping we just rethrow the exception
      if (!_adaptive_substepping)
        throw;
 
      // otherwise we double the number of substeps and try again
      num_substeps *= 2;
      if (num_substeps <= _maximum_number_substeps)
        continue;
 
      // too meany substeps, break out of the loop
      break;
    }
 
    // updateStateSubstepInternal was successful (didn't throw)
    _dt = _dt_original;
    return;
  }
 
  // recover the original timestep
  _dt = _dt_original;
 
  mooseException("Adaptive substepping failed. Maximum number of substeps exceeded.");
}

updateStateSubstep() [2/2]

template<bool is_ad, typename R2 , typename R4 >

void StressUpdateBaseTempl< is_ad, R2, R4 >::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.

{
  this->paramError("use_substep",
                   "updateStateSubstep called: it needs to be implemented by your inelastic model");
}

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

{
  using std::sqrt;
 
  // if only one substep is needed, then call the original update state method
  if (total_number_substeps == 1)
  {
    updateState(strain_increment,
                inelastic_strain_increment,
                rotation_increment,
                stress_new,
                stress_old,
                elasticity_tensor,
                elastic_strain_old,
                compute_full_tangent_operator,
                tangent_operator);
 
    this->storeIncrementalMaterialProperties(total_number_substeps);
    return;
  }
 
  if (total_number_substeps > _maximum_number_substeps)
    mooseException("The number of substeps computed exceeds 'maximum_number_substeps'.");
 
  // cut the original timestep
  _dt = _dt_original / total_number_substeps;
 
  // initialize the inputs
  const GenericRankTwoTensor<is_ad> strain_increment_per_step =
      strain_increment / total_number_substeps;
  GenericRankTwoTensor<is_ad> sub_stress_new = elasticity_tensor * elastic_strain_old;
  GenericRankTwoTensor<is_ad> sub_elastic_strain_old = elastic_strain_old;
 
  // clear the original inputs
  MathUtils::mooseSetToZero(strain_increment);
  MathUtils::mooseSetToZero(inelastic_strain_increment);
  MathUtils::mooseSetToZero(stress_new);
 
  GenericReal<is_ad> sub_effective_inelastic_strain_increment = 0.0;
  GenericRankTwoTensor<is_ad> sub_inelastic_strain_increment = inelastic_strain_increment;
 
  for (unsigned int step = 0; step < total_number_substeps; ++step)
  {
    // set up input for this substep
    GenericRankTwoTensor<is_ad> sub_strain_increment = strain_increment_per_step;
    sub_stress_new += elasticity_tensor * sub_strain_increment;
 
    Real effective_sub_stress_new;
    if constexpr (!is_ad)
    {
      // compute effective_sub_stress_new
      const RankTwoTensor deviatoric_sub_stress_new = sub_stress_new.deviatoric();
      const Real dev_sub_stress_new_squared =
          deviatoric_sub_stress_new.doubleContraction(deviatoric_sub_stress_new);
      effective_sub_stress_new = sqrt(3.0 / 2.0 * dev_sub_stress_new_squared);
    }
    else
      libmesh_ignore(effective_sub_stress_new);
 
    // update stress and strain based on the strain increment
    updateState(sub_strain_increment,
                sub_inelastic_strain_increment,
                rotation_increment, // not used in updateState
                sub_stress_new,
                stress_old, // not used in updateState
                elasticity_tensor,
                elastic_strain_old,
                false);
    // do not compute tangent until the end of this substep (or not at all for is_ad == true)
 
    // update strain and stress
    strain_increment += sub_strain_increment;
    inelastic_strain_increment += sub_inelastic_strain_increment;
    sub_elastic_strain_old += sub_strain_increment;
    sub_stress_new = elasticity_tensor * sub_elastic_strain_old;
 
    // accumulate scalar_effective_inelastic_strain
    sub_effective_inelastic_strain_increment += _effective_inelastic_strain_increment;
 
    if constexpr (!is_ad)
      computeTangentOperator(effective_sub_stress_new, sub_stress_new, tangent_operator);
 
    // store incremental material properties for this step
    this->storeIncrementalMaterialProperties(total_number_substeps);
  }
 
  // update stress
  stress_new = sub_stress_new;
 
  // update effective inelastic strain
  updateEffectiveInelasticStrain(sub_effective_inelastic_strain_increment);
}

validParams()

template<bool is_ad>

InputParameters RadialReturnBackstressStressUpdateBaseTempl< is_ad >::validParams ( )

static

Definition at line 6 of file RadialReturnBackstressStressUpdateBase.C.

{
  InputParameters params = RadialReturnStressUpdateTempl<is_ad>::validParams();
  return params;
}

Referenced by CombinedNonlinearHardeningPlasticityTempl< is_ad >::validParams().

Member Data Documentation

_absolute_tolerance

template<bool is_ad>

Real SingleVariableReturnMappingSolutionTempl< is_ad >::_absolute_tolerance

privateinherited

Absolute convergence tolerance.

Definition at line 197 of file SingleVariableReturnMappingSolution.h.

_acceptable_multiplier

template<bool is_ad>

Real SingleVariableReturnMappingSolutionTempl< is_ad >::_acceptable_multiplier

privateinherited

Multiplier applied to relative and absolute tolerances for acceptable convergence.

Definition at line 200 of file SingleVariableReturnMappingSolution.h.

_ad_derivative

template<bool is_ad>

const bool SingleVariableReturnMappingSolutionTempl< is_ad >::_ad_derivative

privateinherited

Definition at line 205 of file SingleVariableReturnMappingSolution.h.

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

_backstress

template<bool is_ad>

GenericMaterialProperty<RankTwoTensor, is_ad>& RadialReturnBackstressStressUpdateBaseTempl< is_ad >::_backstress

protected

Definition at line 29 of file RadialReturnBackstressStressUpdateBase.h.

_backstress_old

template<bool is_ad>

const MaterialProperty<RankTwoTensor>& RadialReturnBackstressStressUpdateBaseTempl< is_ad >::_backstress_old

protected

Definition at line 30 of file RadialReturnBackstressStressUpdateBase.h.

_base_name

template<bool is_ad, typename R2 = RankTwoTensor, typename R4 = RankFourTensor>

const std::string StressUpdateBaseTempl< is_ad, R2, R4 >::_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

_derivative

template<bool is_ad>

GenericReal<is_ad> SingleVariableReturnMappingSolutionTempl< is_ad >::_derivative

privateinherited

Derivative of the residual.

Definition at line 222 of file SingleVariableReturnMappingSolution.h.

_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

Referenced by ADMultiplePowerLawCreepStressUpdate::computeDerivative(), and ADMultiplePowerLawCreepStressUpdate::computeResidual().

_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

Definition at line 219 of file RadialReturnStressUpdate.h.

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

_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

Definition at line 220 of file RadialReturnStressUpdate.h.

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

_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

template<bool is_ad, typename R2 , typename R4 >

RankFourTensor StressUpdateBaseTempl< is_ad, R2, R4 >::_identityTensor

staticprotectedinherited

Initial value:

=
    RankFourTensor(RankFourTensor::initIdentityFour)

Definition at line 193 of file StressUpdateBase.h.

_initial_residual

template<bool is_ad>

GenericReal<is_ad> SingleVariableReturnMappingSolutionTempl< is_ad >::_initial_residual

privateinherited

Residual values, kept as members to retain solver state for summary outputting.

Definition at line 217 of file SingleVariableReturnMappingSolution.h.

_internal_solve_full_iteration_history

template<bool is_ad>

const bool SingleVariableReturnMappingSolutionTempl< is_ad >::_internal_solve_full_iteration_history

privateinherited

Whether to output iteration information all the time (regardless of whether iterations converge)

Definition at line 191 of file SingleVariableReturnMappingSolution.h.

_internal_solve_output_on

template<bool is_ad>

enum SingleVariableReturnMappingSolutionTempl::InternalSolveOutput SingleVariableReturnMappingSolutionTempl< is_ad >::_internal_solve_output_on

privateinherited

_iteration

template<bool is_ad>

unsigned int SingleVariableReturnMappingSolutionTempl< is_ad >::_iteration

privateinherited

iteration number

Definition at line 214 of file SingleVariableReturnMappingSolution.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.

_max_its

template<bool is_ad>

const unsigned int SingleVariableReturnMappingSolutionTempl< is_ad >::_max_its

privateinherited

Maximum number of return mapping iterations.

This exists only to avoid an infinite loop, and is is intended to be a large number that is not settable by the user.

Definition at line 188 of file SingleVariableReturnMappingSolution.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.

_num_resids

template<bool is_ad>

const std::size_t SingleVariableReturnMappingSolutionTempl< is_ad >::_num_resids

privateinherited

Number of residuals to be stored in history.

Definition at line 208 of file SingleVariableReturnMappingSolution.h.

_q_point

template<bool is_ad>

const MooseArray< Point > & Material::_q_point

inherited

_qp

template<bool is_ad>

unsigned int Material::_qp

_relative_tolerance

template<bool is_ad>

Real SingleVariableReturnMappingSolutionTempl< is_ad >::_relative_tolerance

privateinherited

Relative convergence tolerance.

Definition at line 194 of file SingleVariableReturnMappingSolution.h.

_residual

template<bool is_ad>

GenericReal<is_ad> SingleVariableReturnMappingSolutionTempl< is_ad >::_residual

privateinherited

Definition at line 218 of file SingleVariableReturnMappingSolution.h.

_residual_history

template<bool is_ad>

std::vector<Real> SingleVariableReturnMappingSolutionTempl< is_ad >::_residual_history

privateinherited

History of residuals used to check whether progress is still being made on decreasing the residual.

Definition at line 211 of file SingleVariableReturnMappingSolution.h.

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

_svrms_name

template<bool is_ad>

const std::string SingleVariableReturnMappingSolutionTempl< is_ad >::_svrms_name

privateinherited

MOOSE input name of the object performing the solve.

Definition at line 225 of file SingleVariableReturnMappingSolution.h.

_three_shear_modulus

template<bool is_ad>

GenericReal<is_ad> RadialReturnStressUpdateTempl< is_ad >::_three_shear_modulus

protectedinherited

3 * shear modulus

Definition at line 217 of file RadialReturnStressUpdate.h.

Referenced by ADMultiplePowerLawCreepStressUpdate::computeDerivative(), and ADMultiplePowerLawCreepStressUpdate::computeResidual().

_use_substepping

template<bool is_ad>

SubsteppingType RadialReturnStressUpdateTempl< is_ad >::_use_substepping

protectedinherited

Whether user has requested the use of substepping technique to improve convergence [make const later].

Definition at line 257 of file RadialReturnStressUpdate.h.

Referenced by RadialReturnStressUpdateTempl< is_ad >::RadialReturnStressUpdateTempl(), ADMultiplePowerLawCreepStressUpdate::substeppingCapabilityEnabled(), and RadialReturnStressUpdateTempl< is_ad >::substeppingCapabilityRequested().

---

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

• solid_mechanics/include/materials/RadialReturnBackstressStressUpdateBase.h
• solid_mechanics/src/materials/RadialReturnBackstressStressUpdateBase.C