#include <ADViscoplasticityStressUpdate.h>

Inheritance diagram for ADViscoplasticityStressUpdate:

Public Types
using	GR2 = GenericRankTwoTensor< is_ad >

using	GSR2 = Moose::GenericType< RankTwoTensor, is_ad >

using	GR4 = GenericRankFourTensor< is_ad >

using	GSR4 = Moose::GenericType< RankFourTensor, is_ad >

enum	ConstantTypeEnum { ConstantTypeEnum::NONE, ConstantTypeEnum::ELEMENT, ConstantTypeEnum::SUBDOMAIN }

enum	TEST_TYPE

typedef DataFileName	DataFileParameterType

Public Member Functions
	ADViscoplasticityStressUpdate (const InputParameters &parameters)

virtual void	updateState (ADRankTwoTensor &strain_increment, ADRankTwoTensor &inelastic_strain_increment, const ADRankTwoTensor &rotation_increment, ADRankTwoTensor &stress_new, const RankTwoTensor &stress_old, const ADRankFourTensor &elasticity_tensor, const RankTwoTensor &elastic_strain_old, bool compute_full_tangent_operator=false, RankFourTensor &tangent_operator=_identityTensor) override

virtual ADReal	minimumPermissibleValue (const ADReal &effective_trial_stress) const override

virtual ADReal	maximumPermissibleValue (const ADReal &effective_trial_stress) const override

virtual Real	computeReferenceResidual (const ADReal &effective_trial_stress, const ADReal &scalar_effective_inelastic_strain) override

virtual Real	computeTimeStepLimit () override

bool	requiresIsotropicTensor () override
	Does the model require the elasticity tensor to be isotropic? More...

virtual void	updateState (GR2 &strain_increment, GR2 &inelastic_strain_increment, const GR2 &rotation_increment, GR2 &stress_new, const RankTwoTensor &stress_old, const GR4 &elasticity_tensor, const RankTwoTensor &elastic_strain_old, bool compute_full_tangent_operator=false, RankFourTensor &tangent_operator=StressUpdateBaseTempl< is_ad >::_identityTensor)
	Given a strain increment that results in a trial stress, perform some procedure (such as an iterative return-mapping process) to produce an admissible stress, an elastic strain increment and an inelastic strain increment. More...

virtual void	updateStateSubstep (GR2 &, GR2 &, const GR2 &, GR2 &, const RankTwoTensor &, const GR4 &, const RankTwoTensor &, bool compute_full_tangent_operator=false, RankFourTensor &tangent_operator=StressUpdateBaseTempl< is_ad >::_identityTensor)
	Similar to the updateState function, this method updates the strain and stress for one substep. More...

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

virtual bool	isIsotropic ()
	Is the implmented model isotropic? The safe default is 'false'. More...

virtual TangentCalculationMethod	getTangentCalculationMethod ()

TangentCalculationMethod	getTangentCalculationMethod ()

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

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

virtual int	calculateNumberSubsteps (const GR2 &)
	Given the elastic strain increment compute the number of substeps required to bring a substepped trial stress guess distance from the yield surface into the tolerance specified in the individual child class. More...

virtual void	storeIncrementalMaterialProperties (const unsigned int)
	Properly set up the incremental calculation storage of the stateful material properties in the inheriting classes. More...

virtual void	resetIncrementalMaterialProperties ()
	Reset material properties. More...

virtual Real	computeStrainEnergyRateDensity (const GenericMaterialProperty< RankTwoTensor, is_ad > &, const GenericMaterialProperty< RankTwoTensor, is_ad > &)
	Compute the strain energy rate density for this inelastic model for the current step. More...

virtual const dof_id_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

bool	ghostable () const override final

virtual void	resolveOptionalProperties () override

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty ()

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty ()

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty ()

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialPropertyByName (const std::string &prop_name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialPropertyByName (const std::string &prop_name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialPropertyByName (const std::string &prop_name)

const MaterialProperty< T > &	getZeroMaterialProperty (Ts... args)

const MaterialProperty< T > &	getZeroMaterialProperty (Ts... args)

const MaterialProperty< T > &	getZeroMaterialProperty (Ts... args)

virtual void	initStatefulProperties (unsigned int n_points)

virtual bool	isInterfaceMaterial ()

virtual void	computePropertiesAtQp (unsigned int qp)

const MaterialProperty< T > &	getZeroMaterialPropertyByName (Ts... args)

virtual const std::set< std::string > &	getRequestedItems () override

virtual const std::set< std::string > &	getSuppliedItems () override

const std::set< unsigned int > &	getSuppliedPropIDs ()

void	checkStatefulSanity () const

std::set< OutputName >	getOutputs ()

bool	hasStatefulProperties () const

void	setFaceInfo (const FaceInfo &fi)

void	setActiveProperties (const std::unordered_set< unsigned int > &needed_props)

bool	forceStatefulInit () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

std::string	errorPrefix (const std::string &error_type) const

void	callMooseError (std::string msg, const bool with_prefix) const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

const InputParameters &	parameters () const

MooseObjectName	uniqueName () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &nm) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	mooseError (Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseInfo (Args &&... args) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

const std::vector< SubdomainName > &	blocks () const

unsigned int	numBlocks () const

virtual const std::set< SubdomainID > &	blockIDs () const

unsigned int	blocksMaxDimension () const

bool	hasBlocks (const SubdomainName &name) const

bool	hasBlocks (const std::vector< SubdomainName > &names) const

bool	hasBlocks (const std::set< SubdomainName > &names) const

bool	hasBlocks (SubdomainID id) const

bool	hasBlocks (const std::vector< SubdomainID > &ids) const

bool	hasBlocks (const std::set< SubdomainID > &ids) const

bool	isBlockSubset (const std::set< SubdomainID > &ids) const

bool	isBlockSubset (const std::vector< SubdomainID > &ids) const

bool	hasBlockMaterialProperty (const std::string &prop_name)

const std::set< SubdomainID > &	meshBlockIDs () const

virtual bool	blockRestricted () const

virtual void	checkVariable (const MooseVariableFieldBase &variable) const

virtual const std::set< BoundaryID > &	boundaryIDs () const

const std::vector< BoundaryName > &	boundaryNames () const

unsigned int	numBoundaryIDs () const

bool	hasBoundary (const BoundaryName &name) const

bool	hasBoundary (const std::vector< BoundaryName > &names) const

bool	hasBoundary (const BoundaryID &id) const

bool	hasBoundary (const std::vector< BoundaryID > &ids, TEST_TYPE type=ALL) const

bool	hasBoundary (const std::set< BoundaryID > &ids, TEST_TYPE type=ALL) const

bool	isBoundarySubset (const std::set< BoundaryID > &ids) const

bool	isBoundarySubset (const std::vector< BoundaryID > &ids) const

bool	hasBoundaryMaterialProperty (const std::string &prop_name) const

virtual bool	boundaryRestricted () const

const std::set< BoundaryID > &	meshBoundaryIDs () const

virtual bool	checkVariableBoundaryIntegrity () const

virtual void	initialSetup ()

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

const std::set< MooseVariableFieldBase *> &	getMooseVariableDependencies () const

std::set< MooseVariableFieldBase *>	checkAllVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_omit={})

std::set< MooseVariableFieldBase *>	checkVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_check)

void	addMooseVariableDependency (MooseVariableFieldBase *var)

void	addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)

const std::vector< MooseVariableScalar *> &	getCoupledMooseScalarVars ()

const std::set< TagID > &	getScalarVariableCoupleableVectorTags () const

const std::set< TagID > &	getScalarVariableCoupleableMatrixTags () const

const 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

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 UserObject &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const

const UserObject &	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

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name, MaterialData &material_data)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const std::string &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const std::string &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const std::string &prop_name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const std::string &prop_name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const std::string &prop_name)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const std::string &prop_name)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const std::string &prop_name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const std::string &prop_name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const std::string &prop_name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const std::string &prop_name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)

std::pair< const MaterialProperty< T > *, std::set< SubdomainID > >	getBlockMaterialProperty (const MaterialPropertyName &name)

std::set< 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)

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	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 Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const


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

void	resetProperties () final

Static Public Member Functions
static InputParameters	validParams ()

static std::deque< MaterialBase *>	buildRequiredMaterials (const Consumers &mat_consumers, const std::vector< std::shared_ptr< MaterialBase >> &mats, const bool allow_stateful)

static bool	restricted (const std::set< BoundaryID > &ids)

static void	sort (typename std::vector< T > &vector)

static void	sortDFS (typename std::vector< T > &vector)

static void	cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)

static std::string	deduceFunctorName (const std::string &name, const InputParameters &params)

Public Attributes
const Elem *const &	_current_elem

Real &	_dt

const MooseArray< Point > &	_q_point

unsigned int	_qp

	ALL

	ANY

const ConsoleStream	_console

Static Public Attributes
static constexpr PropertyValue::id_type	default_property_id

static constexpr PropertyValue::id_type	zero_property_id

Protected Types
enum	ViscoplasticityModel { ViscoplasticityModel::LPS, ViscoplasticityModel::GTN }
	Enum to choose which viscoplastic model to use. More...

enum	PoreShapeModel { PoreShapeModel::SPHERICAL, PoreShapeModel::CYLINDRICAL }
	Enum to choose which pore shape model to use. More...

enum	NegativeBehavior { NegativeBehavior::ZERO, NegativeBehavior::INITIAL_CONDITION, NegativeBehavior::EXCEPTION }

enum	QP_Data_Type

Protected Member Functions
virtual ADReal	initialGuess (const ADReal &effective_trial_stress) override
	Compute an initial guess for the value of the scalar. More...

virtual ADReal	computeResidual (const ADReal &effective_trial_stress, const ADReal &scalar) override
	Perform any necessary steps to finalize state after return mapping iterations. More...

virtual ADReal	computeDerivative (const ADReal &, const ADReal &) override

void	outputIterationSummary (std::stringstream *iter_output, const unsigned int total_it) override
	Output summary information for the convergence history of the model. More...

ADReal	computeH (const Real n, const ADReal &gauge_stress, const bool derivative=false)

ADRankTwoTensor	computeDGaugeDSigma (const ADReal &gauge_stress, const ADReal &equiv_stress, const ADRankTwoTensor &dev_stress, const ADRankTwoTensor &stress)

void	computeInelasticStrainIncrement (ADReal &gauge_stress, ADReal &dpsi_dgauge, ADRankTwoTensor &creep_strain_increment, const ADReal &equiv_stress, const ADRankTwoTensor &dev_stress, const ADRankTwoTensor &stress)

virtual void	initQpStatefulProperties () override

virtual void	propagateQpStatefulProperties () override
	If updateState is not called during a timestep, this will be. More...

virtual void	computeStressInitialize (const GenericReal< is_ad > &, const GenericRankFourTensor< is_ad > &)
	Perform any necessary initialization before return mapping iterations. More...

virtual void	computeStressFinalize (const GenericRankTwoTensor< is_ad > &)
	Perform any necessary steps to finalize state after return mapping iterations. More...

void	updateIntermediatePorosity (const GenericRankTwoTensor< is_ad > &elastic_strain_increment)

virtual void	checkMaterialProperty (const std::string &name, const unsigned int state) override

virtual const MaterialData &	materialData () const override

virtual MaterialData &	materialData () 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 ()

virtual bool	hasBlockMaterialPropertyHelper (const std::string &prop_name)

void	initializeBlockRestrictable (const MooseObject *moose_object)

Moose::CoordinateSystemType	getBlockCoordSystem ()

bool	hasBoundaryMaterialPropertyHelper (const std::string &prop_name) const

bool	isCoupledScalar (const std::string &var_name, unsigned int i=0) const

unsigned int	coupledScalarComponents (const std::string &var_name) const

unsigned int	coupledScalar (const std::string &var_name, unsigned int comp=0) const

libMesh::Order	coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const

const 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 UserObject &) const

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &) const

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const

T &	declareRestartableData (const std::string &data_name, Args &&... args)

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

const T &	getRestartableData (const std::string &data_name) const

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (const std::string &data_name) const

std::string	deduceFunctorName (const std::string &name) const

const Moose::Functor< T > &	getFunctor (const std::string &name)

const Moose::Functor< T > &	getFunctor (const std::string &name, THREAD_ID tid)

const Moose::Functor< T > &	getFunctor (const std::string &name, SubProblem &subproblem)

const Moose::Functor< T > &	getFunctor (const std::string &name, SubProblem &subproblem, THREAD_ID tid)

bool	isFunctor (const std::string &name) const

bool	isFunctor (const std::string &name, const SubProblem &subproblem) const

Moose::ElemArg	makeElemArg (const Elem *elem, bool correct_skewnewss=false) const

void	checkFunctorSupportsSideIntegration (const std::string &name, bool qp_integration)

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

virtual void	coupledCallback (const std::string &, bool) const

virtual bool	isCoupled (const std::string &var_name, unsigned int i=0) const

virtual bool	isCoupledConstant (const std::string &var_name) const

unsigned int	coupledComponents (const std::string &var_name) const

VariableName	coupledName (const std::string &var_name, unsigned int comp=0) const

std::vector< VariableName >	coupledNames (const std::string &var_name) const

virtual unsigned int	coupled (const std::string &var_name, unsigned int comp=0) const

std::vector< unsigned 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)

const T *	getVarHelper (const std::string &var_name, unsigned int comp) const

T *	getVarHelper (const std::string &var_name, unsigned int comp)

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

void	markMatPropRequested (const std::string &)

MaterialPropertyName	getMaterialPropertyName (const std::string &name) const

const GenericMaterialProperty< T, is_ad > *	defaultGenericMaterialProperty (const std::string &name)

const GenericMaterialProperty< T, is_ad > *	defaultGenericMaterialProperty (const std::string &name)

const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)

const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)

const ADMaterialProperty< T > *	defaultADMaterialProperty (const std::string &name)

const ADMaterialProperty< T > *	defaultADMaterialProperty (const std::string &name)

void	returnMappingSolve (const GenericReal< is_ad > &effective_trial_stress, GenericReal< is_ad > &scalar, const ConsoleStream &console)
	Perform the return mapping iterations. More...

virtual GenericReal< is_ad >	minimumPermissibleValue (const GenericReal< is_ad > &effective_trial_stress) const
	Compute the minimum permissible value of the scalar. More...

virtual GenericReal< is_ad >	maximumPermissibleValue (const GenericReal< is_ad > &effective_trial_stress) const
	Compute the maximum permissible value of the scalar. More...

virtual GenericReal< is_ad >	initialGuess (const GenericReal< is_ad > &)
	Compute an initial guess for the value of the scalar. More...

virtual GenericReal< is_ad >	computeResidual (const GenericReal< is_ad > &, const GenericReal< is_ad > &)=0
	Compute the residual for a predicted value of the scalar. More...

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

virtual GenericChainedReal< is_ad >	computeResidualAndDerivative (const GenericReal< is_ad > &, const GenericChainedReal< is_ad > &)
	Compute the residual and the derivative for a predicted value of the scalar. More...

virtual Real	computeReferenceResidual (const GenericReal< is_ad > &effective_trial_stress, const GenericReal< is_ad > &scalar)=0
	Compute a reference quantity to be used for checking relative convergence. More...

virtual void	preStep (const GenericReal< is_ad > &, const GenericReal< is_ad > &, const GenericReal< is_ad > &)
	This method is called before taking a step in the return mapping algorithm. More...

virtual void	iterationFinalize (const GenericReal< is_ad > &)
	Finalize internal state variables for a model for a given iteration. More...

virtual void	outputIterationStep (std::stringstream *iter_output, const GenericReal< is_ad > &effective_trial_stress, const GenericReal< is_ad > &scalar, const Real reference_residual)
	Output information for a single iteration step to build the convergence history of the model. More...

bool	converged (const GenericReal< is_ad > &residual, const Real reference)
	Check to see whether the residual is within the convergence limits. More...

Protected Attributes
enum ADViscoplasticityStressUpdate::ViscoplasticityModel	_model

enum ADViscoplasticityStressUpdate::PoreShapeModel	_pore_shape

const Real	_pore_shape_factor
	Pore shape factor depending on pore shape model. More...

const Real	_power
	Exponent on the effective stress. More...

const Real	_power_factor
	Power factor used for LPS model. More...

const ADMaterialProperty< Real > &	_coefficient
	Leading coefficient. More...

ADMaterialProperty< Real > &	_gauge_stress
	Gauge stress. More...

const Real	_maximum_gauge_ratio
	Maximum ratio between the gauge stress and the equilvalent stress. More...

const Real	_minimum_equivalent_stress
	Minimum value of equivalent stress below which viscoplasticiy is not calculated. More...

const Real	_maximum_equivalent_stress
	Maximum value of equivalent stress above which an exception is thrown. More...

ADReal	_hydro_stress
	Container for hydrostatic stress. More...

const RankTwoTensor	_identity_two
	Rank two identity tensor. More...

const RankTwoTensor	_dhydro_stress_dsigma
	Derivative of hydrostatic stress with respect to the stress tensor. More...

ADReal	_derivative
	Container for _derivative. More...

const std::string	_total_strain_base_name
	String designating the base name of the total strain. More...

const GenericMaterialProperty< RankTwoTensor, is_ad > &	_strain_increment
	Material property for the total strain increment. More...

Real	_max_inelastic_increment
	Max increment for inelastic strain. More...

GenericReal< is_ad >	_intermediate_porosity
	Container for the porosity calculated from all other intelastic models except the current model. More...

const MaterialProperty< Real > &	_porosity_old
	Material property for the old porosity. More...

const bool	_verbose
	Flag to enable verbose output. More...

const Real	_initial_porosity
	Initial porosity. More...

const NegativeBehavior	_negative_behavior
	Enum for negative porosity handling. More...

const std::string	_base_name
	Name used as a prefix for all material properties related to the stress update model. More...

	CURR

	PREV

bool	_bnd

bool	_neighbor

const QBase *const &	_qrule

const MooseArray< Real > &	_JxW

const SubdomainID &	_current_subdomain_id

const unsigned int &	_current_side

const ConstantTypeEnum	_constant_option

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

THREAD_ID	_tid

Assembly &	_assembly

const MooseArray< Real > &	_coord

const MooseArray< Point > &	_normals

MooseMesh &	_mesh

const Moose::CoordinateSystemType &	_coord_sys

std::set< std::string >	_requested_props

std::set< std::string >	_supplied_props

std::set< unsigned int >	_supplied_prop_ids

std::unordered_set< unsigned int >	_active_prop_ids

const bool	_compute

std::unordered_map< unsigned int, unsigned int >	_props_to_min_states

std::vector< unsigned int >	_displacements

bool	_has_stateful_property

bool	_overrides_init_stateful_props

const FaceInfo *	_face_info

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

const MaterialData *	_blk_material_data

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

FEProblemBase &	_sc_fe_problem

const THREAD_ID	_sc_tid

const Real &	_real_zero

const VariableValue &	_scalar_zero

const Point &	_point_zero

const InputParameters &	_ti_params

FEProblemBase &	_ti_feproblem

bool	_is_implicit

Real &	_t

const Real &	_t_old

int &	_t_step

Real &	_dt_old

bool	_is_transient

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

FEProblemBase &	_mci_feproblem

GeometricSearchData &	_geometric_search_data

bool	_requires_geometric_search

const InputParameters &	_c_parameters

const std::string &	_c_name

const std::string &	_c_type

FEProblemBase &	_c_fe_problem

const SystemBase *const	_c_sys

std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> >	_coupled_vars

std::vector< MooseVariableFieldBase *>	_coupled_moose_vars

std::vector< MooseVariable *>	_coupled_standard_moose_vars

std::vector< VectorMooseVariable *>	_coupled_vector_moose_vars

std::vector< ArrayMooseVariable *>	_coupled_array_moose_vars

std::vector< MooseVariableFV< Real > *>	_coupled_standard_fv_moose_vars

std::vector< MooseLinearVariableFV< Real > *>	_coupled_standard_linear_fv_moose_vars

const std::unordered_map< std::string, std::string > &	_new_to_deprecated_coupled_vars

bool	_c_nodal

bool	_c_is_implicit

const bool	_c_allow_element_to_nodal_coupling

THREAD_ID	_c_tid

std::unordered_map< std::string, std::vector< std::unique_ptr< VariableValue > > >	_default_value

std::unordered_map< std::string, std::unique_ptr< MooseArray< ADReal > > >	_ad_default_value

std::unordered_map< std::string, std::unique_ptr< VectorVariableValue > >	_default_vector_value

std::unordered_map< std::string, std::unique_ptr< ArrayVariableValue > >	_default_array_value

std::unordered_map< std::string, std::unique_ptr< MooseArray< ADRealVectorValue > > >	_ad_default_vector_value

VariableValue	_default_value_zero

VariableGradient	_default_gradient

MooseArray< ADRealVectorValue >	_ad_default_gradient

MooseArray< ADRealTensorValue >	_ad_default_vector_gradient

VariableSecond	_default_second

MooseArray< ADRealTensorValue >	_ad_default_second

MooseArray< ADRealVectorValue >	_ad_default_curl

const VariableValue &	_zero

const VariablePhiValue &	_phi_zero

const MooseArray< ADReal > &	_ad_zero

const VariableGradient &	_grad_zero

const MooseArray< ADRealVectorValue > &	_ad_grad_zero

const VariablePhiGradient &	_grad_phi_zero

const VariableSecond &	_second_zero

const MooseArray< ADRealTensorValue > &	_ad_second_zero

const VariablePhiSecond &	_second_phi_zero

const VectorVariableValue &	_vector_zero

const VectorVariableCurl &	_vector_curl_zero

VectorVariableValue	_default_vector_value_zero

VectorVariableGradient	_default_vector_gradient

VectorVariableCurl	_default_vector_curl

VectorVariableDivergence	_default_div

ArrayVariableValue	_default_array_value_zero

ArrayVariableGradient	_default_array_gradient

bool	_coupleable_neighbor

const InputParameters &	_mi_params

const std::string	_mi_name

const MooseObjectName	_mi_moose_object_name

FEProblemBase &	_mi_feproblem

SubProblem &	_mi_subproblem

const THREAD_ID	_mi_tid

const Moose::MaterialDataType	_material_data_type

MaterialData &	_material_data

bool	_stateful_allowed

bool	_get_material_property_called

std::vector< std::unique_ptr< PropertyValue > >	_default_properties

std::unordered_set< unsigned int >	_material_property_dependencies

const MaterialPropertyName	_get_suffix

const bool	_use_interpolated_state

const Parallel::Communicator &	_communicator

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

bool	_line_search
	Whether to use line searches to improve convergence. More...

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


GenericMaterialProperty< Real, is_ad > &	_effective_inelastic_strain
	Effective inelastic strain material property. More...

const MaterialProperty< Real > &	_effective_inelastic_strain_old


GenericMaterialProperty< RankTwoTensor, is_ad > &	_inelastic_strain
	Creep strain material property. More...

const MaterialProperty< RankTwoTensor > &	_inelastic_strain_old

Static Protected Attributes
static RankFourTensor	_identityTensor

static const std::string	_interpolated_old

static const std::string	_interpolated_older

Detailed Description

Definition at line 15 of file ADViscoplasticityStressUpdate.h.

Member Typedef Documentation

◆ GR2

using StressUpdateBaseTempl< is_ad, RankTwoTensor , RankFourTensor >::GR2 = GenericRankTwoTensor<is_ad>

inherited

Definition at line 57 of file StressUpdateBase.h.

◆ GR4

using StressUpdateBaseTempl< is_ad, RankTwoTensor , RankFourTensor >::GR4 = GenericRankFourTensor<is_ad>

inherited

Definition at line 59 of file StressUpdateBase.h.

◆ GSR2

using StressUpdateBaseTempl< is_ad, RankTwoTensor , RankFourTensor >::GSR2 = Moose::GenericType<RankTwoTensor , is_ad>

inherited

Definition at line 58 of file StressUpdateBase.h.

◆ GSR4

using StressUpdateBaseTempl< is_ad, RankTwoTensor , RankFourTensor >::GSR4 = Moose::GenericType<RankFourTensor , is_ad>

inherited

Definition at line 60 of file StressUpdateBase.h.

Member Enumeration Documentation

◆ NegativeBehavior

template<bool is_ad>

enum ViscoplasticityStressUpdateBaseTempl::NegativeBehavior

strongprotectedinherited

Enumerator
ZERO
INITIAL_CONDITION
EXCEPTION

Definition at line 84 of file ViscoplasticityStressUpdateBase.h.

   {
     ZERO,
     INITIAL_CONDITION,
     EXCEPTION
   };

◆ PoreShapeModel

enum ADViscoplasticityStressUpdate::PoreShapeModel

strongprotected

Enum to choose which pore shape model to use.

Enumerator
SPHERICAL
CYLINDRICAL

Definition at line 86 of file ADViscoplasticityStressUpdate.h.

86 { SPHERICAL, CYLINDRICAL } _pore_shape;

SPHERICAL

ADViscoplasticityStressUpdate::_pore_shape

enum ADViscoplasticityStressUpdate::PoreShapeModel _pore_shape

◆ ViscoplasticityModel

enum ADViscoplasticityStressUpdate::ViscoplasticityModel

strongprotected

Enum to choose which viscoplastic model to use.

Enumerator
LPS
GTN

Definition at line 83 of file ADViscoplasticityStressUpdate.h.

83 { LPS, GTN } _model;

ADViscoplasticityStressUpdate::_model

enum ADViscoplasticityStressUpdate::ViscoplasticityModel _model

Constructor & Destructor Documentation

◆ ADViscoplasticityStressUpdate()

ADViscoplasticityStressUpdate::ADViscoplasticityStressUpdate ( const InputParameters & parameters )

Definition at line 53 of file ADViscoplasticityStressUpdate.C.

   : ADViscoplasticityStressUpdateBase(parameters),
     ADSingleVariableReturnMappingSolution(parameters),
     _model(parameters.get<MooseEnum>("viscoplasticity_model").getEnum<ViscoplasticityModel>()),
     _pore_shape(parameters.get<MooseEnum>("pore_shape_model").getEnum<PoreShapeModel>()),
     _pore_shape_factor(_pore_shape == PoreShapeModel::SPHERICAL ? 1.5 : std::sqrt(3.0)),
     _power(getParam<Real>("power")),
     _power_factor(_model == ViscoplasticityModel::LPS ? (_power - 1.0) / (_power + 1.0) : 1.0),
     _coefficient(getADMaterialProperty<Real>("coefficient")),
     _gauge_stress(declareADProperty<Real>(_base_name + "gauge_stress")),
     _maximum_gauge_ratio(getParam<Real>("maximum_gauge_ratio")),
     _minimum_equivalent_stress(getParam<Real>("minimum_equivalent_stress")),
     _maximum_equivalent_stress(getParam<Real>("maximum_equivalent_stress")),
     _hydro_stress(0.0),
     _identity_two(RankTwoTensor::initIdentity),
     _dhydro_stress_dsigma(_identity_two / 3.0),
     _derivative(0.0)
 {
   _check_range = true;
 }

Member Function Documentation

◆ calculateNumberSubsteps()

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

inlinevirtualinherited

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

Definition at line 160 of file StressUpdateBase.h.

160 { return 1; }

◆ computeDerivative() [1/2]

virtual ADReal ADViscoplasticityStressUpdate::computeDerivative	(	const ADReal &	,
		const ADReal &
	)

inlineoverrideprotectedvirtual

Definition at line 59 of file ADViscoplasticityStressUpdate.h.

   {
     return _derivative;
   }

◆ computeDerivative() [2/2]

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 >, CompositePowerLawCreepStressUpdateTempl< is_ad >, IsotropicPlasticityStressUpdateTempl< is_ad >, PowerLawCreepStressUpdateTempl< is_ad >, PowerLawCreepTestTempl< is_ad >, and CombinedNonlinearHardeningPlasticityTempl< is_ad >.

◆ computeDGaugeDSigma()

ADRankTwoTensor ADViscoplasticityStressUpdate::computeDGaugeDSigma	(	const ADReal &	gauge_stress,
		const ADReal &	equiv_stress,
		const ADRankTwoTensor &	dev_stress,
		const ADRankTwoTensor &	stress
	)

protected

Definition at line 240 of file ADViscoplasticityStressUpdate.C.

Referenced by computeInelasticStrainIncrement().

 {
   // Compute the derivative of the gauge stress with respect to the equivalent and hydrostatic
   // stress components
   const ADReal M = std::abs(_hydro_stress) / gauge_stress;
   const ADReal h = computeH(_power, M);
 
   // Compute the derviative of the residual with respect to the hydrostatic stress
   ADReal dresidual_dhydro_stress = 0.0;
   if (_hydro_stress != 0.0)
   {
     const ADReal dM_dhydro_stress = M / _hydro_stress;
     if (_model == ViscoplasticityModel::GTN)
     {
       dresidual_dhydro_stress = 2.0 * _intermediate_porosity * std::sinh(_pore_shape_factor * M) *
                                 _pore_shape_factor * dM_dhydro_stress;
     }
     else
     {
       const ADReal dresidual_dh =
           _intermediate_porosity * (1.0 - _power_factor / Utility::pow<2>(h));
       const ADReal dh_dM = computeH(_power, M, true);
       dresidual_dhydro_stress = dresidual_dh * dh_dM * dM_dhydro_stress;
     }
   }
 
   // Compute the derivative of the residual with respect to the equivalent stress
   ADReal dresidual_dequiv_stress = 2.0 * equiv_stress / Utility::pow<2>(gauge_stress);
   if (_pore_shape == PoreShapeModel::SPHERICAL)
     dresidual_dequiv_stress *= 1.0 + _intermediate_porosity / 1.5;
 
   // Compute the derivative of the equilvalent stress to the deviatoric stress
   const ADRankTwoTensor dequiv_stress_dsigma = 1.5 * dev_stress / equiv_stress;
 
   // Compute the derivative of the residual with the stress
   const ADRankTwoTensor dresidual_dsigma = dresidual_dhydro_stress * _dhydro_stress_dsigma +
                                            dresidual_dequiv_stress * dequiv_stress_dsigma;
 
   // Compute the deritative of the gauge stress with respect to the stress
   const ADRankTwoTensor dgauge_dsigma =
       dresidual_dsigma * (gauge_stress / dresidual_dsigma.doubleContraction(stress));
 
   return dgauge_dsigma;
 }

◆ computeH()

ADReal ADViscoplasticityStressUpdate::computeH	(	const Real	n,
		const ADReal &	gauge_stress,
		const bool	derivative = `false`
	)

protected

Definition at line 225 of file ADViscoplasticityStressUpdate.C.

Referenced by computeDGaugeDSigma(), and computeResidual().

 {
   const ADReal mod = std::pow(M * _pore_shape_factor, (n + 1.0) / n);
 
   // Calculate derivative with respect to M
   if (derivative)
   {
     const ADReal dmod_dM = (n + 1.0) / n * mod / M;
     return dmod_dM * std::pow(1.0 + mod / n, n - 1.0);
   }
 
   return std::pow(1.0 + mod / n, n);
 }

◆ computeInelasticStrainIncrement()

void ADViscoplasticityStressUpdate::computeInelasticStrainIncrement	(	ADReal &	gauge_stress,
		ADReal &	dpsi_dgauge,
		ADRankTwoTensor &	creep_strain_increment,
		const ADReal &	equiv_stress,
		const ADRankTwoTensor &	dev_stress,
		const ADRankTwoTensor &	stress
	)

protected

Definition at line 289 of file ADViscoplasticityStressUpdate.C.

Referenced by updateState().

 {
   // If hydrostatic stress and porosity present, compute non-linear gauge stress
   if (_intermediate_porosity == 0.0)
     gauge_stress = equiv_stress;
   else if (_hydro_stress == 0.0)
     gauge_stress =
         equiv_stress / std::sqrt(1.0 - (1.0 + _power_factor) * _intermediate_porosity +
                                  _power_factor * Utility::pow<2>(_intermediate_porosity));
   else
     returnMappingSolve(equiv_stress, gauge_stress, _console);
 
   mooseAssert(gauge_stress >= equiv_stress,
               "Gauge stress calculated in inner Newton solve is less than the equivalent stress.");
 
   // Compute stress potential
   dpsi_dgauge = _coefficient[_qp] * std::pow(gauge_stress, _power);
 
   // Compute strain increment from stress potential and the gauge stress derivative with respect
   // to the stress stress. The current form is explicit, and should eventually be changed
   inelastic_strain_increment =
       _dt * dpsi_dgauge * computeDGaugeDSigma(gauge_stress, equiv_stress, dev_stress, stress);
 }

◆ computeReferenceResidual() [1/2]

Real ADViscoplasticityStressUpdate::computeReferenceResidual	(	const ADReal &	effective_trial_stress,
		const ADReal &	scalar_effective_inelastic_strain
	)

overridevirtual

Definition at line 332 of file ADViscoplasticityStressUpdate.C.

 {
   // Use gauge stress for relative tolerance criteria, defined as:
   // std::abs(residual / gauge_stress) <= _relative_tolerance
   return MetaPhysicL::raw_value(gauge_stress);
 }

◆ computeReferenceResidual() [2/2]

template<bool is_ad>

virtual Real SingleVariableReturnMappingSolutionTempl< is_ad >::computeReferenceResidual	(	const GenericReal< is_ad > &	effective_trial_stress,
		const GenericReal< is_ad > &	scalar
	)

protectedpure virtualinherited

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

Implemented in RadialReturnStressUpdateTempl< is_ad >.

◆ computeResidual() [1/2]

ADReal ADViscoplasticityStressUpdate::computeResidual	(	const ADReal &	effective_trial_stress,
		const ADReal &	scalar
	)

overrideprotectedvirtual

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

Parameters

inelasticStrainIncrement Inelastic strain increment

Definition at line 176 of file ADViscoplasticityStressUpdate.C.

 {
   const ADReal M = std::abs(_hydro_stress) / trial_gauge;
   const ADReal dM_dtrial_gauge = -M / trial_gauge;
 
   const ADReal residual_left = Utility::pow<2>(equiv_stress / trial_gauge);
   const ADReal dresidual_left_dtrial_gauge = -2.0 * residual_left / trial_gauge;
 
   ADReal residual = residual_left;
   _derivative = dresidual_left_dtrial_gauge;
 
   if (_pore_shape == PoreShapeModel::SPHERICAL)
   {
     residual *= 1.0 + _intermediate_porosity / 1.5;
     _derivative *= 1.0 + _intermediate_porosity / 1.5;
   }
 
   if (_model == ViscoplasticityModel::GTN)
   {
     residual += 2.0 * _intermediate_porosity * std::cosh(_pore_shape_factor * M) - 1.0 -
                 Utility::pow<2>(_intermediate_porosity);
     _derivative += 2.0 * _intermediate_porosity * std::sinh(_pore_shape_factor * M) *
                    _pore_shape_factor * dM_dtrial_gauge;
   }
   else
   {
     const ADReal h = computeH(_power, M);
     const ADReal dh_dM = computeH(_power, M, true);
 
     residual += _intermediate_porosity * (h + _power_factor / h) - 1.0 -
                 _power_factor * Utility::pow<2>(_intermediate_porosity);
     const ADReal dresidual_dh = _intermediate_porosity * (1.0 - _power_factor / Utility::pow<2>(h));
     _derivative += dresidual_dh * dh_dM * dM_dtrial_gauge;
   }
 
   if (_verbose)
   {
     Moose::out << "in computeResidual:\n"
                << "  position: " << _q_point[_qp] << " hydro_stress: " << _hydro_stress
                << " equiv_stress: " << equiv_stress << " trial_grage: " << trial_gauge
                << " M: " << M << std::endl;
     Moose::out << "  residual: " << residual << "  derivative: " << _derivative << std::endl;
   }
 
   return residual;
 }

◆ computeResidual() [2/2]

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 LAROMANCEStressUpdateBaseTempl< is_ad >, IsotropicPlasticityStressUpdateTempl< is_ad >, CompositePowerLawCreepStressUpdateTempl< is_ad >, PowerLawCreepStressUpdateTempl< is_ad >, PowerLawCreepTestTempl< is_ad >, and CombinedNonlinearHardeningPlasticityTempl< 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;
   };

◆ computeStrainEnergyRateDensity()

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

inlinevirtualinherited

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

Parameters

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

◆ computeStressFinalize()

template<bool is_ad>

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

inlineprotectedvirtualinherited

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

Parameters

inelasticStrainIncrement Inelastic strain increment

Definition at line 47 of file ViscoplasticityStressUpdateBase.h.

Referenced by updateState().

48 {

49 }

◆ computeStressInitialize()

template<bool is_ad>

virtual void ViscoplasticityStressUpdateBaseTempl< is_ad >::computeStressInitialize	(	const GenericReal< is_ad > &	,
		const GenericRankFourTensor< is_ad > &
	)

inlineprotectedvirtualinherited

Perform any necessary initialization before return mapping iterations.

Parameters

effective_trial_stress	Effective trial stress
elasticityTensor	Elasticity tensor

Definition at line 37 of file ViscoplasticityStressUpdateBase.h.

Referenced by updateState().

39 {

40 }

◆ computeTimeStepLimit()

template<bool is_ad>

Real ViscoplasticityStressUpdateBaseTempl< is_ad >::computeTimeStepLimit ( )

overridevirtualinherited

Reimplemented from StressUpdateBaseTempl< is_ad >.

Definition at line 86 of file ViscoplasticityStressUpdateBase.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;
 }

◆ 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 326 of file SingleVariableReturnMappingSolution.C.

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

◆ getTangentCalculationMethod() [1/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;
 }

◆ getTangentCalculationMethod() [2/2]

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

virtualinherited

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

Definition at line 101 of file StressUpdateBase.C.

 {
   return TangentCalculationMethod::ELASTIC;
 }

◆ initialGuess() [1/2]

ADReal ADViscoplasticityStressUpdate::initialGuess ( const ADReal & effective_trial_stress )

overrideprotectedvirtual

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

Definition at line 158 of file ADViscoplasticityStressUpdate.C.

 {
   return effective_trial_stress;
 }

◆ initialGuess() [2/2]

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 ViscoplasticityStressUpdateBaseTempl< is_ad >::initQpStatefulProperties ( )

overrideprotectedvirtualinherited

Reimplemented from Material.

Definition at line 70 of file ViscoplasticityStressUpdateBase.C.

 {
   _effective_inelastic_strain[_qp] = 0.0;
   _inelastic_strain[_qp].zero();
 }

◆ isIsotropic()

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

inlinevirtualinherited

Is the implmented model isotropic? The safe default is 'false'.

Reimplemented in RadialReturnStressUpdateTempl< is_ad >.

Definition at line 130 of file StressUpdateBase.h.

130 { return false; };

◆ 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 IsotropicPlasticityStressUpdateTempl< is_ad >, and CombinedNonlinearHardeningPlasticityTempl< is_ad >.

Definition at line 128 of file SingleVariableReturnMappingSolution.h.

128 {}

◆ maximumPermissibleValue() [1/2]

ADReal ADViscoplasticityStressUpdate::maximumPermissibleValue ( const ADReal & effective_trial_stress ) const

overridevirtual

Definition at line 164 of file ADViscoplasticityStressUpdate.C.

 {
   return effective_trial_stress * _maximum_gauge_ratio;
 }

◆ maximumPermissibleValue() [2/2]

template<bool is_ad>

GenericReal< is_ad > SingleVariableReturnMappingSolutionTempl< is_ad >::maximumPermissibleValue ( const GenericReal< is_ad > & effective_trial_stress ) const

protectedvirtualinherited

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 in RadialReturnStressUpdateTempl< is_ad >, LAROMANCEStressUpdateBaseTempl< is_ad >, and PowerLawCreepTestTempl< is_ad >.

Definition at line 92 of file SingleVariableReturnMappingSolution.C.

 {
   return std::numeric_limits<Real>::max();
 }

◆ minimumPermissibleValue() [1/2]

ADReal ADViscoplasticityStressUpdate::minimumPermissibleValue ( const ADReal & effective_trial_stress ) const

overridevirtual

Definition at line 170 of file ADViscoplasticityStressUpdate.C.

 {
   return effective_trial_stress;
 }

◆ minimumPermissibleValue() [2/2]

template<bool is_ad>

GenericReal< is_ad > SingleVariableReturnMappingSolutionTempl< is_ad >::minimumPermissibleValue ( const GenericReal< is_ad > & effective_trial_stress ) const

protectedvirtualinherited

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 in RadialReturnStressUpdateTempl< is_ad >, and PowerLawCreepTestTempl< is_ad >.

Definition at line 84 of file SingleVariableReturnMappingSolution.C.

 {
   return std::numeric_limits<Real>::lowest();
 }

◆ 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 419 of file SingleVariableReturnMappingSolution.C.

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

 {
   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';
   }
 }

◆ outputIterationSummary()

void ADViscoplasticityStressUpdate::outputIterationSummary	(	std::stringstream *	iter_output,
		const unsigned int	total_it
	)

overrideprotectedvirtual

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 320 of file ADViscoplasticityStressUpdate.C.

 {
   if (iter_output)
   {
     *iter_output << "At element " << _current_elem->id() << " _qp=" << _qp << " Coordinates "
                  << _q_point[_qp] << " block=" << _current_elem->subdomain_id() << '\n';
   }
   ADSingleVariableReturnMappingSolution::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.

121 {

122 }

◆ propagateQpStatefulProperties()

template<bool is_ad>

void ViscoplasticityStressUpdateBaseTempl< is_ad >::propagateQpStatefulProperties ( )

overrideprotectedvirtualinherited

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

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

Reimplemented from StressUpdateBaseTempl< is_ad >.

Definition at line 78 of file ViscoplasticityStressUpdateBase.C.

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

◆ requiresIsotropicTensor()

template<bool is_ad>

bool ViscoplasticityStressUpdateBaseTempl< is_ad >::requiresIsotropicTensor ( )

inlineoverridevirtualinherited

Does the model require the elasticity tensor to be isotropic?

Implements StressUpdateBaseTempl< is_ad >.

Definition at line 23 of file ViscoplasticityStressUpdateBase.h.

23 { return true; }

◆ resetIncrementalMaterialProperties()

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

inlinevirtualinherited

Reset material properties.

Useful for substepping with inelastic models.

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

Definition at line 172 of file StressUpdateBase.h.

172 {};

◆ resetProperties()

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

inlinefinalvirtualinherited

Reimplemented from Material.

Definition at line 138 of file StressUpdateBase.h.

138 {}

◆ resetQpProperties()

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

inlinefinalvirtualinherited

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

Reimplemented from Material.

Definition at line 137 of file StressUpdateBase.h.

137 {}

◆ returnMappingSolve()

template<bool is_ad>

void SingleVariableReturnMappingSolutionTempl< is_ad >::returnMappingSolve	(	const GenericReal< is_ad > &	effective_trial_stress,
		GenericReal< is_ad > &	scalar,
		const ConsoleStream &	console
	)

protectedinherited

Perform the return mapping iterations.

Parameters

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

Definition at line 100 of file SingleVariableReturnMappingSolution.C.

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

 {
   // 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;
   }
 }

◆ setQp()

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

inherited

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

Definition at line 46 of file StressUpdateBase.C.

 {
   _qp = qp;
 }

◆ storeIncrementalMaterialProperties()

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

inlinevirtualinherited

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

Reimplemented in LAROMANCEStressUpdateBaseTempl< is_ad >.

Definition at line 167 of file StressUpdateBase.h.

167 {};

◆ substeppingCapabilityEnabled()

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

inlinevirtualinherited

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

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

Definition at line 147 of file StressUpdateBase.h.

147 { return false; }

◆ substeppingCapabilityRequested()

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

inlinevirtualinherited

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

Reimplemented in RadialReturnStressUpdateTempl< is_ad >.

Definition at line 153 of file StressUpdateBase.h.

153 { return false; }

◆ updateIntermediatePorosity()

template<bool is_ad>

void ViscoplasticityStressUpdateBaseTempl< is_ad >::updateIntermediatePorosity ( const GenericRankTwoTensor< is_ad > & elastic_strain_increment )

protectedinherited

Definition at line 100 of file ViscoplasticityStressUpdateBase.C.

Referenced by updateState().

 {
   // Subtract elastic strain from strain increment to find all inelastic strain increments
   // calculated so far except the one that we're about to calculate. Then calculate intermediate
   // porosity from all inelastic strain increments calculated so far except the one that we're about
   // to calculate
   _intermediate_porosity =
       (1.0 - _porosity_old[_qp]) * (_strain_increment[_qp] - elastic_strain_increment).trace() +
       _porosity_old[_qp];
 
   if (_intermediate_porosity < 0.0)
   {
     if (_negative_behavior == NegativeBehavior::ZERO)
       _intermediate_porosity = 0.0;
     if (_negative_behavior == NegativeBehavior::INITIAL_CONDITION)
       _intermediate_porosity = _initial_porosity;
     if (_negative_behavior == NegativeBehavior::EXCEPTION)
       mooseException("In ", _name, ": porosity is negative.");
   }
 
   if (std::isnan(_intermediate_porosity))
     mooseException("In ", _name, ": porosity is nan. Cutting timestep.");
 }

◆ updateState() [1/2]

void ADViscoplasticityStressUpdate::updateState	(	ADRankTwoTensor &	strain_increment,
		ADRankTwoTensor &	inelastic_strain_increment,
		const ADRankTwoTensor &	rotation_increment,
		ADRankTwoTensor &	stress_new,
		const RankTwoTensor &	stress_old,
		const ADRankFourTensor &	elasticity_tensor,
		const RankTwoTensor &	elastic_strain_old,
		bool	compute_full_tangent_operator = `false`,
		RankFourTensor &	tangent_operator = `_identityTensor`
	)

overridevirtual

Definition at line 75 of file ADViscoplasticityStressUpdate.C.

 {
   // Compute initial hydrostatic stress and porosity
   if (_pore_shape == PoreShapeModel::CYLINDRICAL)
     _hydro_stress = (stress(0, 0) + stress(1, 1)) / 2.0;
   else
     _hydro_stress = stress.trace() / 3.0;
 
   updateIntermediatePorosity(elastic_strain_increment);
 
   // Compute intermediate equivalent stress
   const ADRankTwoTensor dev_stress = stress.deviatoric();
   const ADReal dev_stress_squared = dev_stress.doubleContraction(dev_stress);
   const ADReal equiv_stress = dev_stress_squared == 0.0 ? 0.0 : std::sqrt(1.5 * dev_stress_squared);
 
   computeStressInitialize(equiv_stress, elasticity_tensor);
 
   // Prepare values
   _effective_inelastic_strain[_qp] = _effective_inelastic_strain_old[_qp];
   _inelastic_strain[_qp] = _inelastic_strain_old[_qp];
   inelastic_strain_increment.zero();
 
   // Protect against extremely high values of stresses calculated by other viscoplastic materials
   if (equiv_stress > _maximum_equivalent_stress)
     mooseException("In ",
                    _name,
                    ": equivalent stress (",
                    equiv_stress,
                    ") is higher than maximum_equivalent_stress (",
                    _maximum_equivalent_stress,
                    ").\nCutting time step.");
 
   // If equivalent stress is present, calculate creep strain increment
   if (equiv_stress > _minimum_equivalent_stress)
   {
     // Initalize stress potential
     ADReal dpsi_dgauge(0);
 
     computeInelasticStrainIncrement(_gauge_stress[_qp],
                                     dpsi_dgauge,
                                     inelastic_strain_increment,
                                     equiv_stress,
                                     dev_stress,
                                     stress);
 
     // Update elastic strain increment due to inelastic strain calculated here
     elastic_strain_increment -= inelastic_strain_increment;
     // Update stress due to new strain
     stress = elasticity_tensor * (elastic_strain_old + elastic_strain_increment);
 
     // Compute effective strain from the stress potential. Note that this is approximate and to be
     // used qualitatively
     _effective_inelastic_strain[_qp] += dpsi_dgauge * _dt;
     // Update creep strain due to currently computed inelastic strain
     _inelastic_strain[_qp] += inelastic_strain_increment;
   }
 
   const ADRankTwoTensor new_dev_stress = stress.deviatoric();
   const ADReal new_dev_stress_squared = new_dev_stress.doubleContraction(new_dev_stress);
   const ADReal new_equiv_stress =
       new_dev_stress_squared == 0.0 ? 0.0 : std::sqrt(1.5 * new_dev_stress_squared);
 
   if (MooseUtils::relativeFuzzyGreaterThan(new_equiv_stress, equiv_stress))
     mooseException("In ",
                    _name,
                    ": updated equivalent stress (",
                    MetaPhysicL::raw_value(new_equiv_stress),
                    ") is greater than initial equivalent stress (",
                    MetaPhysicL::raw_value(equiv_stress),
                    "). Try decreasing max_inelastic_increment to avoid this exception.");
 
   computeStressFinalize(inelastic_strain_increment);
 }

◆ updateState() [2/2]

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

virtualinherited

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

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

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

Parameters

strain_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

Definition at line 68 of file StressUpdateBase.C.

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

◆ updateStateSubstep()

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

virtualinherited

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

Definition at line 84 of file StressUpdateBase.C.

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

◆ validParams()

InputParameters ADViscoplasticityStressUpdate::validParams ( )

static

Definition at line 17 of file ADViscoplasticityStressUpdate.C.

 {
   InputParameters params = ADViscoplasticityStressUpdateBase::validParams();
   params += ADSingleVariableReturnMappingSolution::validParams();
   params.addClassDescription(
       "This material computes the non-linear homogenized gauge stress in order to compute the "
       "viscoplastic responce due to creep in porous materials. This material must be used in "
       "conjunction with ADComputeMultiplePorousInelasticStress");
   MooseEnum viscoplasticity_model("LPS GTN", "LPS");
   params.addParam<MooseEnum>(
       "viscoplasticity_model", viscoplasticity_model, "Which viscoplastic model to use");
   MooseEnum pore_shape_model("spherical cylindrical", "spherical");
   params.addParam<MooseEnum>("pore_shape_model", pore_shape_model, "Which pore shape model to use");
   params.addRequiredParam<MaterialPropertyName>(
       "coefficient", "Material property name for the leading coefficient for Norton power law");
   params.addRequiredRangeCheckedParam<Real>(
       "power", "power>=1.0", "Stress exponent for Norton power law");
   params.addParam<Real>(
       "maximum_gauge_ratio",
       1.0e6,
       "Maximum ratio between the gauge stress and the equivalent stress. This "
       "should be a high number. Note that this does not set an upper bound on the value, but "
       "rather will help with convergence of the inner Newton loop");
   params.addParam<Real>(
       "minimum_equivalent_stress",
       1.0e-3,
       "Minimum value of equivalent stress below which viscoplasticiy is not calculated.");
   params.addParam<Real>("maximum_equivalent_stress",
                         1.0e12,
                         "Maximum value of equivalent stress above which an exception is thrown "
                         "instead of calculating the properties in this material.");
 
   params.addParamNamesToGroup("verbose maximum_gauge_ratio maximum_equivalent_stress", "Advanced");
   return params;
 }

Member Data Documentation

◆ _base_name

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

protectedinherited

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

Definition at line 191 of file StressUpdateBase.h.

◆ _bracket_solution

template<bool is_ad>

bool SingleVariableReturnMappingSolutionTempl< is_ad >::_bracket_solution

protectedinherited

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

Definition at line 145 of file SingleVariableReturnMappingSolution.h.

◆ _check_range

template<bool is_ad>

bool SingleVariableReturnMappingSolutionTempl< is_ad >::_check_range

protectedinherited

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

Definition at line 138 of file SingleVariableReturnMappingSolution.h.

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

◆ _coefficient

const ADMaterialProperty<Real>& ADViscoplasticityStressUpdate::_coefficient

protected

Leading coefficient.

Definition at line 98 of file ADViscoplasticityStressUpdate.h.

Referenced by computeInelasticStrainIncrement().

◆ _current_elem

const Elem *const & Material::_current_elem

inherited

Referenced by outputIterationSummary().

◆ _derivative

ADReal ADViscoplasticityStressUpdate::_derivative

protected

Container for _derivative.

Definition at line 122 of file ADViscoplasticityStressUpdate.h.

Referenced by computeDerivative(), and computeResidual().

◆ _dhydro_stress_dsigma

const RankTwoTensor ADViscoplasticityStressUpdate::_dhydro_stress_dsigma

protected

Derivative of hydrostatic stress with respect to the stress tensor.

Definition at line 119 of file ADViscoplasticityStressUpdate.h.

Referenced by computeDGaugeDSigma().

◆ _dt

Real & Material::_dt

inherited

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

◆ _effective_inelastic_strain

template<bool is_ad>

GenericMaterialProperty<Real, is_ad>& ViscoplasticityStressUpdateBaseTempl< is_ad >::_effective_inelastic_strain

protectedinherited

Effective inelastic strain material property.

Definition at line 60 of file ViscoplasticityStressUpdateBase.h.

Referenced by updateState().

◆ _effective_inelastic_strain_old

template<bool is_ad>

const MaterialProperty<Real>& ViscoplasticityStressUpdateBaseTempl< is_ad >::_effective_inelastic_strain_old

protectedinherited

Definition at line 61 of file ViscoplasticityStressUpdateBase.h.

Referenced by updateState().

◆ _gauge_stress

ADMaterialProperty<Real>& ADViscoplasticityStressUpdate::_gauge_stress

protected

Gauge stress.

Definition at line 101 of file ADViscoplasticityStressUpdate.h.

Referenced by updateState().

◆ _hydro_stress

ADReal ADViscoplasticityStressUpdate::_hydro_stress

protected

Container for hydrostatic stress.

Definition at line 113 of file ADViscoplasticityStressUpdate.h.

Referenced by computeDGaugeDSigma(), computeInelasticStrainIncrement(), computeResidual(), and updateState().

◆ _identity_two

const RankTwoTensor ADViscoplasticityStressUpdate::_identity_two

protected

Rank two identity tensor.

Definition at line 116 of file ADViscoplasticityStressUpdate.h.

◆ _identityTensor

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

staticprotectedinherited

Definition at line 193 of file StressUpdateBase.h.

◆ _inelastic_strain

template<bool is_ad>

GenericMaterialProperty<RankTwoTensor, is_ad>& ViscoplasticityStressUpdateBaseTempl< is_ad >::_inelastic_strain

protectedinherited

Creep strain material property.

Definition at line 65 of file ViscoplasticityStressUpdateBase.h.

Referenced by updateState().

◆ _inelastic_strain_old

template<bool is_ad>

const MaterialProperty<RankTwoTensor>& ViscoplasticityStressUpdateBaseTempl< is_ad >::_inelastic_strain_old

protectedinherited

Definition at line 66 of file ViscoplasticityStressUpdateBase.h.

Referenced by updateState().

◆ _initial_porosity

template<bool is_ad>

const Real ViscoplasticityStressUpdateBaseTempl< is_ad >::_initial_porosity

protectedinherited

Initial porosity.

Definition at line 82 of file ViscoplasticityStressUpdateBase.h.

◆ _intermediate_porosity

template<bool is_ad>

GenericReal<is_ad> ViscoplasticityStressUpdateBaseTempl< is_ad >::_intermediate_porosity

protectedinherited

Container for the porosity calculated from all other intelastic models except the current model.

Definition at line 73 of file ViscoplasticityStressUpdateBase.h.

Referenced by computeDGaugeDSigma(), computeInelasticStrainIncrement(), and computeResidual().

◆ _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 ViscoplasticityStressUpdateBaseTempl< is_ad >::_max_inelastic_increment

protectedinherited

Max increment for inelastic strain.

Definition at line 70 of file ViscoplasticityStressUpdateBase.h.

◆ _maximum_equivalent_stress

const Real ADViscoplasticityStressUpdate::_maximum_equivalent_stress

protected

Maximum value of equivalent stress above which an exception is thrown.

Definition at line 110 of file ADViscoplasticityStressUpdate.h.

Referenced by updateState().

◆ _maximum_gauge_ratio

const Real ADViscoplasticityStressUpdate::_maximum_gauge_ratio

protected

Maximum ratio between the gauge stress and the equilvalent stress.

Definition at line 104 of file ADViscoplasticityStressUpdate.h.

Referenced by maximumPermissibleValue().

◆ _minimum_equivalent_stress

const Real ADViscoplasticityStressUpdate::_minimum_equivalent_stress

protected

Minimum value of equivalent stress below which viscoplasticiy is not calculated.

Definition at line 107 of file ADViscoplasticityStressUpdate.h.

Referenced by updateState().

◆ _model

enum ADViscoplasticityStressUpdate::ViscoplasticityModel ADViscoplasticityStressUpdate::_model

protected

Referenced by computeDGaugeDSigma(), and computeResidual().

◆ _negative_behavior

template<bool is_ad>

const NegativeBehavior ViscoplasticityStressUpdateBaseTempl< is_ad >::_negative_behavior

protectedinherited

Enum for negative porosity handling.

Definition at line 92 of file ViscoplasticityStressUpdateBase.h.

◆ _pore_shape

enum ADViscoplasticityStressUpdate::PoreShapeModel ADViscoplasticityStressUpdate::_pore_shape

protected

Referenced by computeDGaugeDSigma(), computeResidual(), and updateState().

◆ _pore_shape_factor

const Real ADViscoplasticityStressUpdate::_pore_shape_factor

protected

Pore shape factor depending on pore shape model.

Definition at line 89 of file ADViscoplasticityStressUpdate.h.

Referenced by computeDGaugeDSigma(), computeH(), and computeResidual().

◆ _porosity_old

template<bool is_ad>

const MaterialProperty<Real>& ViscoplasticityStressUpdateBaseTempl< is_ad >::_porosity_old

protectedinherited

Material property for the old porosity.

Definition at line 76 of file ViscoplasticityStressUpdateBase.h.

◆ _power

const Real ADViscoplasticityStressUpdate::_power

protected

Exponent on the effective stress.

Definition at line 92 of file ADViscoplasticityStressUpdate.h.

Referenced by computeDGaugeDSigma(), computeInelasticStrainIncrement(), and computeResidual().

◆ _power_factor

const Real ADViscoplasticityStressUpdate::_power_factor

protected

Power factor used for LPS model.

Definition at line 95 of file ADViscoplasticityStressUpdate.h.

Referenced by computeDGaugeDSigma(), computeInelasticStrainIncrement(), and computeResidual().

◆ _q_point

const MooseArray< Point > & Material::_q_point

inherited

Referenced by computeResidual(), and outputIterationSummary().

◆ _qp

unsigned int Material::_qp

inherited

Referenced by computeInelasticStrainIncrement(), computeResidual(), ADMultiplePowerLawCreepStressUpdate::computeStrainEnergyRateDensity(), ADMultiplePowerLawCreepStressUpdate::computeStressInitialize(), outputIterationSummary(), RadialReturnStressUpdateTempl< is_ad >::updateEffectiveInelasticStrain(), and updateState().

◆ _strain_increment

template<bool is_ad>

const GenericMaterialProperty<RankTwoTensor, is_ad>& ViscoplasticityStressUpdateBaseTempl< is_ad >::_strain_increment

protectedinherited

Material property for the total strain increment.

Definition at line 57 of file ViscoplasticityStressUpdateBase.h.

◆ _total_strain_base_name

template<bool is_ad>

const std::string ViscoplasticityStressUpdateBaseTempl< is_ad >::_total_strain_base_name

protectedinherited

String designating the base name of the total strain.

Definition at line 54 of file ViscoplasticityStressUpdateBase.h.

◆ _verbose

template<bool is_ad>

const bool ViscoplasticityStressUpdateBaseTempl< is_ad >::_verbose

protectedinherited

Flag to enable verbose output.

Definition at line 79 of file ViscoplasticityStressUpdateBase.h.

Referenced by computeResidual().

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

solid_mechanics/include/materials/ADViscoplasticityStressUpdate.h
solid_mechanics/src/materials/ADViscoplasticityStressUpdate.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ GR2

◆ GR4

◆ GSR2

◆ GSR4

Member Enumeration Documentation

◆ NegativeBehavior

◆ PoreShapeModel

◆ ViscoplasticityModel

Constructor & Destructor Documentation

◆ ADViscoplasticityStressUpdate()

Member Function Documentation

◆ calculateNumberSubsteps()

◆ computeDerivative() [1/2]

◆ computeDerivative() [2/2]

◆ computeDGaugeDSigma()

◆ computeH()

◆ computeInelasticStrainIncrement()

◆ computeReferenceResidual() [1/2]

◆ computeReferenceResidual() [2/2]

◆ computeResidual() [1/2]

◆ computeResidual() [2/2]

◆ computeResidualAndDerivative()

◆ computeStrainEnergyRateDensity()

◆ computeStressFinalize()

◆ computeStressInitialize()

◆ computeTimeStepLimit()

◆ converged()

◆ getTangentCalculationMethod() [1/2]

◆ getTangentCalculationMethod() [2/2]

◆ initialGuess() [1/2]

◆ initialGuess() [2/2]

◆ initQpStatefulProperties()

◆ isIsotropic()

◆ iterationFinalize()

◆ maximumPermissibleValue() [1/2]

◆ maximumPermissibleValue() [2/2]

◆ minimumPermissibleValue() [1/2]

◆ minimumPermissibleValue() [2/2]

◆ outputIterationStep()

◆ outputIterationSummary()

◆ preStep()

◆ propagateQpStatefulProperties()

◆ requiresIsotropicTensor()

◆ resetIncrementalMaterialProperties()

◆ resetProperties()

◆ resetQpProperties()

◆ returnMappingSolve()

◆ setQp()

◆ storeIncrementalMaterialProperties()

◆ substeppingCapabilityEnabled()

◆ substeppingCapabilityRequested()

◆ updateIntermediatePorosity()

◆ updateState() [1/2]

◆ updateState() [2/2]

◆ updateStateSubstep()

◆ validParams()

Member Data Documentation

◆ _base_name

◆ _bracket_solution

◆ _check_range

◆ _coefficient

◆ _current_elem

◆ _derivative

◆ _dhydro_stress_dsigma

◆ _dt

◆ _effective_inelastic_strain

◆ _effective_inelastic_strain_old

◆ _gauge_stress

◆ _hydro_stress