#include <CrystalPlasticityStressUpdateBase.h>

Inheritance diagram for CrystalPlasticityStressUpdateBase:

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

enum	TEST_TYPE

typedef DataFileName	DataFileParameterType

Public Member Functions
	CrystalPlasticityStressUpdateBase (const InputParameters &parameters)

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

void	setSubstepDt (const Real &substep_dt)
	Sets the value of the _substep_dt for inheriting classes. More...

virtual void	initQpStatefulProperties () override
	initializes the stateful properties such as PK2 stress, resolved shear stress, plastic deformation gradient, slip system resistances, etc. More...

virtual void	setMaterialVectorSize ()

virtual void	getSlipSystems ()
	A helper method to read in plane normal and direction vectors from a file and to normalize the vectors. More...

void	transformHexagonalMillerBravaisSlipSystems (const MooseUtils::DelimitedFileReader &reader)
	A helper method to transform the Miller-Bravais 4-index notation for HCP crystals into a a 3-index Cartesian representation, using the convention a$_1$ = x of axis alignment in the basal plane. More...

void	calculateFlowDirection (const RankTwoTensor &crysrot)
	Computes the Schmid tensor (m x n) for the original (reference) crystal lattice orientation for each glide slip system. More...

void	calculateShearStress (const RankTwoTensor &pk2, const RankTwoTensor &inverse_eigenstrain_deformation_grad, const unsigned int &num_eigenstrains)
	Computes the shear stess for each slip system. More...

virtual void	calculateTotalPlasticDeformationGradientDerivative (RankFourTensor &dfpinvdpk2, const RankTwoTensor &inverse_plastic_deformation_grad_old, const RankTwoTensor &inverse_eigenstrain_deformation_grad_old, const unsigned int &num_eigenstrains)
	Calculates the total value of ${d{F}^P^{-1}}{d{PK2}}$ and is intended to be an overwritten helper method for inheriting classes with multiple constitutive dislocation slip mechanisms, e.g. More...

void	calculateSchmidTensor (const unsigned int &number_dislocation_systems, const std::vector< RealVectorValue > &plane_normal_vector, const std::vector< RealVectorValue > &direction_vector, std::vector< RankTwoTensor > &schmid_tensor, const RankTwoTensor &crysrot)
	A helper method to rotate the a direction and plane normal system set into the local crystal llatice orientation as defined by the crystal rotation tensor from the Elasticity tensor class. More...

void	sortCrossSlipFamilies ()
	A helper method to sort the slip systems of a crystal into cross slip families based on common slip directions. More...

unsigned int	identifyCrossSlipFamily (const unsigned int index)
	A helper method for inherting classes to identify to which cross slip family vector a particular slip system index belongs after the slip systems have been sorted. More...

virtual void	setInitialConstitutiveVariableValues ()
	This virtual method is called to set the constitutive internal state variables current value and the previous substep value to the old property value for the start of the stress convergence while loop. More...

virtual void	setSubstepConstitutiveVariableValues ()
	This virtual method is called to set the current constitutive internal state variable value to that of the previous substep at the beginning of the next substep increment. More...

virtual void	updateSubstepConstitutiveVariableValues ()
	Stores the current value of the constitutive internal state variables into a separate material property in case substepping is required, once the constitutive variables have passed convergence tolerances. More...

virtual bool	calculateSlipRate ()=0
	This virtual method is called to calculate the slip system slip increment based on the constitutive model defined in the child class. More...

virtual void	calculateEquivalentSlipIncrement (RankTwoTensor &)

virtual void	calculateConstitutiveSlipDerivative (std::vector< Real > &)=0
	This virtual method is called to find the derivative of the slip increment with respect to the applied shear stress on the slip system based on the constiutive model defined in the child class. More...

virtual void	cacheStateVariablesBeforeUpdate ()
	Finalizes the values of the state variables and slip system resistance for the current timestep after convergence has been reached. More...

virtual void	calculateStateVariableEvolutionRateComponent ()

virtual bool	updateStateVariables ()=0
	Finalizes the values of the state variables and slip system resistance for the current timestep after convergence has been reached. More...

virtual void	calculateSlipResistance ()

virtual bool	areConstitutiveStateVariablesConverged ()
	Determines if all the state variables have converged. More...

virtual bool	isConstitutiveStateVariableConverged (const std::vector< Real > &current_var, const std::vector< Real > &var_before_update, const std::vector< Real > &previous_substep_var, const Real &tolerance)
	Check if a typical state variable, e.g. 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


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

virtual 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
	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	CrystalLatticeType { CrystalLatticeType::BCC, CrystalLatticeType::FCC, CrystalLatticeType::HCP }

enum	QP_Data_Type

Protected Member Functions
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)

Protected Attributes
const std::string	_base_name
	Base name prepended to all material property names to allow for multi-material systems. More...

enum CrystalPlasticityStressUpdateBase::CrystalLatticeType	_crystal_lattice_type

const std::vector< Real >	_unit_cell_dimension

const unsigned int	_number_slip_systems
	Maximum number of active slip systems for the crystalline material being modeled. More...

std::string	_slip_sys_file_name
	File should contain slip plane normal and direction. More...

Real	_rel_state_var_tol
	Internal variable update equation tolerance. More...

Real	_slip_incr_tol
	Slip increment tolerance. More...

Real	_resistance_tol
	Tolerance for change in slip system resistance over an increment. More...

Real	_zero_tol
	Residual tolerance when variable value is zero. Default 1e-12. More...

MaterialProperty< std::vector< Real > > &	_slip_increment
	Current slip increment material property. More...

MaterialProperty< std::vector< Real > > &	_tau
	Resolved shear stress on each slip system. More...

const bool	_print_convergence_message
	Flag to print to console warning messages on stress, constitutive model convergence. More...

Real	_substep_dt
	Substepping time step value used within the inheriting constitutive models. More...

std::vector< std::vector< unsigned int > >	_cross_slip_familes
	Sorted slip system indices into cross slip family groups. More...

bool	_calculate_cross_slip
	Flag to run the cross slip calculations if cross slip numbers are specified. More...

	CURR

	PREV

bool	_bnd

bool	_neighbor

const MooseArray< Point > &	_q_point

const QBase *const &	_qrule

const MooseArray< Real > &	_JxW

const Elem *const &	_current_elem

const SubdomainID &	_current_subdomain_id

const unsigned int &	_current_side

const ConstantTypeEnum	_constant_option

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

THREAD_ID	_tid

Assembly &	_assembly

unsigned int	_qp

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

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


const Real	_number_cross_slip_directions
	Parameters to characterize the cross slip behavior of the crystal. More...

const Real	_number_cross_slip_planes


MaterialProperty< std::vector< Real > > &	_slip_resistance
	Slip system resistance. More...

const MaterialProperty< std::vector< Real > > &	_slip_resistance_old


std::vector< RealVectorValue >	_slip_direction
	Slip system direction and normal and associated Schmid tensors. More...

std::vector< RealVectorValue >	_slip_plane_normal

MaterialProperty< std::vector< RankTwoTensor > > &	_flow_direction

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

Detailed Description

Definition at line 17 of file CrystalPlasticityStressUpdateBase.h.

Member Enumeration Documentation

◆ CrystalLatticeType

enum CrystalPlasticityStressUpdateBase::CrystalLatticeType

strongprotected

Enumerator
BCC
FCC
HCP

Definition at line 192 of file CrystalPlasticityStressUpdateBase.h.

192 { BCC, FCC, HCP } _crystal_lattice_type;

CrystalPlasticityStressUpdateBase::_crystal_lattice_type

enum CrystalPlasticityStressUpdateBase::CrystalLatticeType _crystal_lattice_type

Constructor & Destructor Documentation

◆ CrystalPlasticityStressUpdateBase()

CrystalPlasticityStressUpdateBase::CrystalPlasticityStressUpdateBase ( const InputParameters & parameters )

Definition at line 83 of file CrystalPlasticityStressUpdateBase.C.

   : Material(parameters),
     _base_name(isParamValid("base_name") ? getParam<std::string>("base_name") + "_" : ""),
     _crystal_lattice_type(
         getParam<MooseEnum>("crystal_lattice_type").getEnum<CrystalLatticeType>()),
     _unit_cell_dimension(getParam<std::vector<Real>>("unit_cell_dimension")),
     _number_slip_systems(getParam<unsigned int>("number_slip_systems")),
     _slip_sys_file_name(getParam<FileName>("slip_sys_file_name")),
     _number_cross_slip_directions(getParam<Real>("number_cross_slip_directions")),
     _number_cross_slip_planes(getParam<Real>("number_cross_slip_planes")),
 
     _rel_state_var_tol(getParam<Real>("stol")),
     _slip_incr_tol(getParam<Real>("slip_increment_tolerance")),
     _resistance_tol(getParam<Real>("resistance_tol")),
     _zero_tol(getParam<Real>("zero_tol")),
 
     _slip_resistance(declareProperty<std::vector<Real>>(_base_name + "slip_resistance")),
     _slip_resistance_old(getMaterialPropertyOld<std::vector<Real>>(_base_name + "slip_resistance")),
     _slip_increment(declareProperty<std::vector<Real>>(_base_name + "slip_increment")),
 
     _slip_direction(_number_slip_systems),
     _slip_plane_normal(_number_slip_systems),
     _flow_direction(declareProperty<std::vector<RankTwoTensor>>(_base_name + "flow_direction")),
     _tau(declareProperty<std::vector<Real>>(_base_name + "applied_shear_stress")),
     _print_convergence_message(getParam<bool>("print_state_variable_convergence_error_messages"))
 {
   getSlipSystems();
   sortCrossSlipFamilies();
 
   if (parameters.isParamSetByUser("number_cross_slip_directions"))
     _calculate_cross_slip = true;
   else
     _calculate_cross_slip = false;
 }

Member Function Documentation

◆ areConstitutiveStateVariablesConverged()

virtual bool CrystalPlasticityStressUpdateBase::areConstitutiveStateVariablesConverged ( )

inlinevirtual

Determines if all the state variables have converged.

Reimplemented in CrystalPlasticityHCPDislocationSlipBeyerleinUpdate, CrystalPlasticityKalidindiUpdate, and CrystalPlasticityTwinningKalidindiUpdate.

Definition at line 176 of file CrystalPlasticityStressUpdateBase.h.

176 { return true; }

◆ cacheStateVariablesBeforeUpdate()

virtual void CrystalPlasticityStressUpdateBase::cacheStateVariablesBeforeUpdate ( )

inlinevirtual

Finalizes the values of the state variables and slip system resistance for the current timestep after convergence has been reached.

Reimplemented in CrystalPlasticityKalidindiUpdate, CrystalPlasticityTwinningKalidindiUpdate, and CrystalPlasticityHCPDislocationSlipBeyerleinUpdate.

Definition at line 161 of file CrystalPlasticityStressUpdateBase.h.

161 {}

◆ calculateConstitutiveSlipDerivative()

virtual void CrystalPlasticityStressUpdateBase::calculateConstitutiveSlipDerivative ( std::vector< Real > & )

pure virtual

This virtual method is called to find the derivative of the slip increment with respect to the applied shear stress on the slip system based on the constiutive model defined in the child class.

This method must be overwritten in the child class.

Implemented in CrystalPlasticityKalidindiUpdate, CrystalPlasticityTwinningKalidindiUpdate, and CrystalPlasticityHCPDislocationSlipBeyerleinUpdate.

Referenced by calculateTotalPlasticDeformationGradientDerivative().

◆ calculateEquivalentSlipIncrement()

void CrystalPlasticityStressUpdateBase::calculateEquivalentSlipIncrement ( RankTwoTensor & equivalent_slip_increment )

virtual

Reimplemented in CrystalPlasticityKalidindiUpdate, and CrystalPlasticityHCPDislocationSlipBeyerleinUpdate.

Definition at line 467 of file CrystalPlasticityStressUpdateBase.C.

Referenced by CrystalPlasticityHCPDislocationSlipBeyerleinUpdate::calculateEquivalentSlipIncrement(), and CrystalPlasticityKalidindiUpdate::calculateEquivalentSlipIncrement().

 {
   // Sum up the slip increments to find the equivalent plastic strain due to slip
   for (const auto i : make_range(_number_slip_systems))
     equivalent_slip_increment += _flow_direction[_qp][i] * _slip_increment[_qp][i] * _substep_dt;
 }

◆ calculateFlowDirection()

void CrystalPlasticityStressUpdateBase::calculateFlowDirection ( const RankTwoTensor & crysrot )

Computes the Schmid tensor (m x n) for the original (reference) crystal lattice orientation for each glide slip system.

Definition at line 369 of file CrystalPlasticityStressUpdateBase.C.

 {
   calculateSchmidTensor(
       _number_slip_systems, _slip_plane_normal, _slip_direction, _flow_direction[_qp], crysrot);
 }

◆ calculateSchmidTensor()

void CrystalPlasticityStressUpdateBase::calculateSchmidTensor	(	const unsigned int &	number_dislocation_systems,
		const std::vector< RealVectorValue > &	plane_normal_vector,
		const std::vector< RealVectorValue > &	direction_vector,
		std::vector< RankTwoTensor > &	schmid_tensor,
		const RankTwoTensor &	crysrot
	)

A helper method to rotate the a direction and plane normal system set into the local crystal llatice orientation as defined by the crystal rotation tensor from the Elasticity tensor class.

Definition at line 376 of file CrystalPlasticityStressUpdateBase.C.

Referenced by calculateFlowDirection().

 {
   std::vector<RealVectorValue> local_direction_vector, local_plane_normal;
   local_direction_vector.resize(number_slip_systems);
   local_plane_normal.resize(number_slip_systems);
 
   // Update slip direction and normal with crystal orientation
   for (const auto i : make_range(_number_slip_systems))
   {
     local_direction_vector[i].zero();
     local_plane_normal[i].zero();
 
     for (const auto j : make_range(LIBMESH_DIM))
       for (const auto k : make_range(LIBMESH_DIM))
       {
         local_direction_vector[i](j) =
             local_direction_vector[i](j) + crysrot(j, k) * direction_vector[i](k);
 
         local_plane_normal[i](j) =
             local_plane_normal[i](j) + crysrot(j, k) * plane_normal_vector[i](k);
       }
 
     // Calculate Schmid tensor
     for (const auto j : make_range(LIBMESH_DIM))
       for (const auto k : make_range(LIBMESH_DIM))
       {
         schmid_tensor[i](j, k) = local_direction_vector[i](j) * local_plane_normal[i](k);
       }
   }
 }

◆ calculateShearStress()

void CrystalPlasticityStressUpdateBase::calculateShearStress	(	const RankTwoTensor &	pk2,
		const RankTwoTensor &	inverse_eigenstrain_deformation_grad,
		const unsigned int &	num_eigenstrains
	)

Computes the shear stess for each slip system.

Definition at line 413 of file CrystalPlasticityStressUpdateBase.C.

 {
   if (!num_eigenstrains)
   {
     for (const auto i : make_range(_number_slip_systems))
       _tau[_qp][i] = pk2.doubleContraction(_flow_direction[_qp][i]);
 
     return;
   }
 
   RankTwoTensor eigenstrain_deformation_grad = inverse_eigenstrain_deformation_grad.inverse();
   for (const auto i : make_range(_number_slip_systems))
   {
     // compute PK2_hat using deformation gradient
     RankTwoTensor pk2_hat = eigenstrain_deformation_grad.det() *
                             eigenstrain_deformation_grad.transpose() * pk2 *
                             inverse_eigenstrain_deformation_grad.transpose();
     _tau[_qp][i] = pk2_hat.doubleContraction(_flow_direction[_qp][i]);
   }
 }

◆ calculateSlipRate()

virtual bool CrystalPlasticityStressUpdateBase::calculateSlipRate ( )

pure virtual

This virtual method is called to calculate the slip system slip increment based on the constitutive model defined in the child class.

This method must be overwritten in the child class.

Implemented in CrystalPlasticityKalidindiUpdate, CrystalPlasticityTwinningKalidindiUpdate, and CrystalPlasticityHCPDislocationSlipBeyerleinUpdate.

◆ calculateSlipResistance()

virtual void CrystalPlasticityStressUpdateBase::calculateSlipResistance ( )

inlinevirtual

Reimplemented in CrystalPlasticityHCPDislocationSlipBeyerleinUpdate.

Definition at line 171 of file CrystalPlasticityStressUpdateBase.h.

171 {}

◆ calculateStateVariableEvolutionRateComponent()

virtual void CrystalPlasticityStressUpdateBase::calculateStateVariableEvolutionRateComponent ( )

inlinevirtual

Reimplemented in CrystalPlasticityKalidindiUpdate, CrystalPlasticityTwinningKalidindiUpdate, and CrystalPlasticityHCPDislocationSlipBeyerleinUpdate.

Definition at line 163 of file CrystalPlasticityStressUpdateBase.h.

163 {}

◆ calculateTotalPlasticDeformationGradientDerivative()

void CrystalPlasticityStressUpdateBase::calculateTotalPlasticDeformationGradientDerivative	(	RankFourTensor &	dfpinvdpk2,
		const RankTwoTensor &	inverse_plastic_deformation_grad_old,
		const RankTwoTensor &	inverse_eigenstrain_deformation_grad_old,
		const unsigned int &	num_eigenstrains
	)

virtual

Calculates the total value of ${d{F}^P^{-1}}{d{PK2}}$ and is intended to be an overwritten helper method for inheriting classes with multiple constitutive dislocation slip mechanisms, e.g.

glide and twinning, $ {d{F}^P^{-1}}{d{PK2}_i}$

Definition at line 438 of file CrystalPlasticityStressUpdateBase.C.

 {
   std::vector<Real> dslip_dtau(_number_slip_systems, 0.0);
   std::vector<RankTwoTensor> dtaudpk2(_number_slip_systems);
   std::vector<RankTwoTensor> dfpinvdslip(_number_slip_systems);
 
   calculateConstitutiveSlipDerivative(dslip_dtau);
 
   for (const auto j : make_range(_number_slip_systems))
   {
     if (num_eigenstrains)
     {
       RankTwoTensor eigenstrain_deformation_grad_old =
           inverse_eigenstrain_deformation_grad_old.inverse();
       dtaudpk2[j] = eigenstrain_deformation_grad_old.det() * eigenstrain_deformation_grad_old *
                     _flow_direction[_qp][j] * inverse_eigenstrain_deformation_grad_old;
     }
     else
       dtaudpk2[j] = _flow_direction[_qp][j];
     dfpinvdslip[j] = -inverse_plastic_deformation_grad_old * _flow_direction[_qp][j];
     dfpinvdpk2 += (dfpinvdslip[j] * dslip_dtau[j] * _substep_dt).outerProduct(dtaudpk2[j]);
   }
 }

◆ getSlipSystems()

void CrystalPlasticityStressUpdateBase::getSlipSystems ( )

virtual

A helper method to read in plane normal and direction vectors from a file and to normalize the vectors.

This method is abstracted to allow for reuse in inheriting classes with multiple plane normal and direction vector pairs.

Definition at line 141 of file CrystalPlasticityStressUpdateBase.C.

Referenced by CrystalPlasticityStressUpdateBase().

 {
   bool orthonormal_error = false;
 
   // read in the slip system data from auxiliary text file
   MooseUtils::DelimitedFileReader _reader(_slip_sys_file_name);
   _reader.setFormatFlag(MooseUtils::DelimitedFileReader::FormatFlag::ROWS);
   _reader.read();
 
   // check the size of the input
   if (_reader.getData().size() != _number_slip_systems)
     paramError(
         "number_slip_systems",
         "The number of rows in the slip system file should match the number of slip system.");
 
   for (const auto i : make_range(_number_slip_systems))
   {
     // initialize to zero
     _slip_direction[i].zero();
     _slip_plane_normal[i].zero();
   }
 
   if (_crystal_lattice_type == CrystalLatticeType::HCP)
     transformHexagonalMillerBravaisSlipSystems(_reader);
   else if (_crystal_lattice_type == CrystalLatticeType::BCC ||
            _crystal_lattice_type == CrystalLatticeType::FCC)
   {
     for (const auto i : make_range(_number_slip_systems))
     {
       // directly grab the raw data and scale it by the unit cell dimension
       for (const auto j : index_range(_reader.getData(i)))
       {
         if (j < LIBMESH_DIM)
           _slip_plane_normal[i](j) = _reader.getData(i)[j] / _unit_cell_dimension[j];
         else
           _slip_direction[i](j - LIBMESH_DIM) =
               _reader.getData(i)[j] * _unit_cell_dimension[j - LIBMESH_DIM];
       }
     }
   }
 
   for (const auto i : make_range(_number_slip_systems))
   {
     // normalize
     _slip_plane_normal[i] /= _slip_plane_normal[i].norm();
     _slip_direction[i] /= _slip_direction[i].norm();
 
     if (_crystal_lattice_type != CrystalLatticeType::HCP)
     {
       const auto magnitude = _slip_plane_normal[i] * _slip_direction[i];
       if (std::abs(magnitude) > libMesh::TOLERANCE)
       {
         orthonormal_error = true;
         break;
       }
     }
   }
 
   if (orthonormal_error)
     mooseError("CrystalPlasticityStressUpdateBase Error: The slip system file contains a slip "
                "direction and plane normal pair that are not orthonormal in the Cartesian "
                "coordinate system.");
 }

◆ identifyCrossSlipFamily()

unsigned int CrystalPlasticityStressUpdateBase::identifyCrossSlipFamily ( const unsigned int index )

A helper method for inherting classes to identify to which cross slip family vector a particular slip system index belongs after the slip systems have been sorted.

Returns the integer value of the identified cross slip system family for the outer vector created in sortCrossSlipFamilies.

Definition at line 357 of file CrystalPlasticityStressUpdateBase.C.

 {
   for (unsigned int i = 0; i < _number_cross_slip_directions; ++i)
     for (unsigned int j = 0; j < _number_cross_slip_planes; ++j)
       if (_cross_slip_familes[i][j] == index)
         return i;
 
   // Should never reach this statement
   mooseError("The supplied slip system index is not among the slip system families sorted.");
 }

◆ initQpStatefulProperties()

void CrystalPlasticityStressUpdateBase::initQpStatefulProperties ( )

overridevirtual

initializes the stateful properties such as PK2 stress, resolved shear stress, plastic deformation gradient, slip system resistances, etc.

This class is often overwritten by inherting classes.

Reimplemented from Material.

Reimplemented in CrystalPlasticityKalidindiUpdate, CrystalPlasticityTwinningKalidindiUpdate, and CrystalPlasticityHCPDislocationSlipBeyerleinUpdate.

Definition at line 120 of file CrystalPlasticityStressUpdateBase.C.

Referenced by CrystalPlasticityHCPDislocationSlipBeyerleinUpdate::initQpStatefulProperties(), CrystalPlasticityTwinningKalidindiUpdate::initQpStatefulProperties(), and CrystalPlasticityKalidindiUpdate::initQpStatefulProperties().

 {
   setMaterialVectorSize();
 }

◆ isConstitutiveStateVariableConverged()

bool CrystalPlasticityStressUpdateBase::isConstitutiveStateVariableConverged	(	const std::vector< Real > &	current_var,
		const std::vector< Real > &	var_before_update,
		const std::vector< Real > &	previous_substep_var,
		const Real &	tolerance
	)

virtual

Check if a typical state variable, e.g.

defect density, has converged by comparing the change in the values over the iteration period.

Definition at line 488 of file CrystalPlasticityStressUpdateBase.C.

Referenced by CrystalPlasticityTwinningKalidindiUpdate::areConstitutiveStateVariablesConverged(), CrystalPlasticityKalidindiUpdate::areConstitutiveStateVariablesConverged(), and CrystalPlasticityHCPDislocationSlipBeyerleinUpdate::areConstitutiveStateVariablesConverged().

 {
   // sometimes the state variable size may not equal to the number of slip systems
   unsigned int sz = current_var.size();
   mooseAssert(current_var.size() == sz, "Current variable size does not match");
   mooseAssert(var_before_update.size() == sz, "Variable before update size does not match");
   mooseAssert(previous_substep_var.size() == sz, "Previous substep variable size does not match");
 
   bool is_converged = true;
 
   Real diff_val = 0.0;
   Real abs_prev_substep_val = 0.0;
   for (const auto i : make_range(sz))
   {
     diff_val = std::abs(var_before_update[i] - current_var[i]);
     abs_prev_substep_val = std::abs(previous_substep_var[i]);
 
     // set to false if the state variable is not converged
     if (abs_prev_substep_val < _zero_tol && diff_val > _zero_tol)
       is_converged = false;
     else if (abs_prev_substep_val > _zero_tol && diff_val > tolerance * abs_prev_substep_val)
       is_converged = false;
   }
   return is_converged;
 }

◆ resetProperties()

virtual void CrystalPlasticityStressUpdateBase::resetProperties ( )

inlinefinalvirtual

Reimplemented from Material.

Definition at line 32 of file CrystalPlasticityStressUpdateBase.h.

32 {}

◆ resetQpProperties()

virtual void CrystalPlasticityStressUpdateBase::resetQpProperties ( )

inlinefinalvirtual

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 31 of file CrystalPlasticityStressUpdateBase.h.

31 {}

◆ setInitialConstitutiveVariableValues()

virtual void CrystalPlasticityStressUpdateBase::setInitialConstitutiveVariableValues ( )

inlinevirtual

This virtual method is called to set the constitutive internal state variables current value and the previous substep value to the old property value for the start of the stress convergence while loop.

Reimplemented in CrystalPlasticityKalidindiUpdate, CrystalPlasticityTwinningKalidindiUpdate, and CrystalPlasticityHCPDislocationSlipBeyerleinUpdate.

Definition at line 119 of file CrystalPlasticityStressUpdateBase.h.

119 {}

◆ setMaterialVectorSize()

void CrystalPlasticityStressUpdateBase::setMaterialVectorSize ( )

virtual

Reimplemented in CrystalPlasticityTwinningKalidindiUpdate, and CrystalPlasticityHCPDislocationSlipBeyerleinUpdate.

Definition at line 126 of file CrystalPlasticityStressUpdateBase.C.

Referenced by initQpStatefulProperties(), CrystalPlasticityHCPDislocationSlipBeyerleinUpdate::setMaterialVectorSize(), and CrystalPlasticityTwinningKalidindiUpdate::setMaterialVectorSize().

 {
   _tau[_qp].resize(_number_slip_systems);
   _flow_direction[_qp].resize(_number_slip_systems);
   for (const auto i : make_range(_number_slip_systems))
   {
     _flow_direction[_qp][i].zero();
     _tau[_qp][i] = 0.0;
   }
 
   _slip_resistance[_qp].resize(_number_slip_systems);
   _slip_increment[_qp].resize(_number_slip_systems);
 }

◆ setQp()

void CrystalPlasticityStressUpdateBase::setQp ( const unsigned int & qp )

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

Definition at line 476 of file CrystalPlasticityStressUpdateBase.C.

 {
   _qp = qp;
 }

◆ setSubstepConstitutiveVariableValues()

virtual void CrystalPlasticityStressUpdateBase::setSubstepConstitutiveVariableValues ( )

inlinevirtual

This virtual method is called to set the current constitutive internal state variable value to that of the previous substep at the beginning of the next substep increment.

In cases where only one substep is taken (or when the first) substep is taken, this method sets the current constitutive internal state variable value to the old value.

Reimplemented in CrystalPlasticityKalidindiUpdate, CrystalPlasticityTwinningKalidindiUpdate, and CrystalPlasticityHCPDislocationSlipBeyerleinUpdate.

Definition at line 128 of file CrystalPlasticityStressUpdateBase.h.

128 {}

◆ setSubstepDt()

void CrystalPlasticityStressUpdateBase::setSubstepDt ( const Real & substep_dt )

Sets the value of the _substep_dt for inheriting classes.

Definition at line 482 of file CrystalPlasticityStressUpdateBase.C.

 {
   _substep_dt = substep_dt;
 }

◆ sortCrossSlipFamilies()

void CrystalPlasticityStressUpdateBase::sortCrossSlipFamilies ( )

A helper method to sort the slip systems of a crystal into cross slip families based on common slip directions.

This method determines if slip directions are parallel, and stores the index of the slip systems from getSlipSystems (the same index is used for the applied shear stress and the internal state variables) in a vector of vectors, where the outer vector separates the individual slip system families and the inner vector stories the indices of the slip systems within a single family. This vector of vectors can then be used in the inheriting classes to calculate cross slip interactions. The values of number_cross_slip_directions and number_cross_slip_planes must be set to use this sorting method.

Definition at line 290 of file CrystalPlasticityStressUpdateBase.C.

Referenced by CrystalPlasticityStressUpdateBase().

 {
   if (_number_cross_slip_directions == 0)
   {
     _cross_slip_familes.resize(0);
     return;
   }
 
   // If cross slip does occur, then set up the system of vectors for the families
   _cross_slip_familes.resize(_number_cross_slip_directions);
   // and set the first index of each inner vector
   for (unsigned int i = 0; i < _number_cross_slip_directions; ++i)
     _cross_slip_familes[i].resize(1);
 
   // Sort the index of the slip system based vectors into separte families
   unsigned int family_counter = 1;
   _cross_slip_familes[0][0] = 0;
 
   for (unsigned int i = 1; i < _number_slip_systems; ++i)
   {
     for (unsigned int j = 0; j < family_counter; ++j)
     {
       // check to see if the slip system direction i matches any of the existing slip directions
       // First calculate the dot product
       Real dot_product = 0.0;
       for (const auto k : make_range(Moose::dim))
       {
         unsigned int check_family_index = _cross_slip_familes[j][0];
         dot_product += std::abs(_slip_direction[check_family_index](k) - _slip_direction[i](k));
       }
       // Then check if the dot product is one, if yes, add to family and break
       if (MooseUtils::absoluteFuzzyEqual(dot_product, 0.0))
       {
         _cross_slip_familes[j].push_back(i);
         if (_cross_slip_familes[j].size() > _number_cross_slip_planes)
           mooseError(
               "Exceeded the number of cross slip planes allowed in a single cross slip family");
 
         break; // exit the loop over the exisiting cross slip families and move to the next slip
                // direction
       }
       // The slip system in question does not belong to an existing family
       else if (j == (family_counter - 1) && !MooseUtils::absoluteFuzzyEqual(dot_product, 0.0))
       {
         if (family_counter > _number_cross_slip_directions)
           mooseError("Exceeds the number of cross slip directions specified for this material");
 
         _cross_slip_familes[family_counter][0] = i;
         family_counter++;
         break;
       }
     }
   }
 
   if (_print_convergence_message)
   {
     mooseWarning("Checking the slip system ordering now:");
     for (unsigned int i = 0; i < _number_cross_slip_directions; ++i)
     {
       Moose::out << "In cross slip family " << i << std::endl;
       for (unsigned int j = 0; j < _number_cross_slip_planes; ++j)
         Moose::out << " is the slip direction number " << _cross_slip_familes[i][j] << std::endl;
     }
   }
 }

◆ transformHexagonalMillerBravaisSlipSystems()

void CrystalPlasticityStressUpdateBase::transformHexagonalMillerBravaisSlipSystems ( const MooseUtils::DelimitedFileReader & reader )

A helper method to transform the Miller-Bravais 4-index notation for HCP crystals into a a 3-index Cartesian representation, using the convention a$_1$ = x of axis alignment in the basal plane.

Definition at line 206 of file CrystalPlasticityStressUpdateBase.C.

Referenced by getSlipSystems().

 {
   const unsigned int miller_bravais_indices = 4;
   RealVectorValue temporary_slip_direction, temporary_slip_plane;
   // temporary_slip_plane.resize(LIBMESH_DIM);
   // temporary_slip_direction.resize(LIBMESH_DIM);
 
   if (_unit_cell_dimension[0] != _unit_cell_dimension[1] ||
       _unit_cell_dimension[0] == _unit_cell_dimension[2])
     mooseError("CrystalPlasticityStressUpdateBase Error: The specified unit cell dimensions are "
                "not consistent with expectations for "
                "HCP crystal hexagonal lattices.");
   else if (reader.getData(0).size() != miller_bravais_indices * 2)
     mooseError("CrystalPlasticityStressUpdateBase Error: The number of entries in the first row of "
                "the slip system file is not consistent with the expectations for the 4-index "
                "Miller-Bravais assumption for HCP crystals. This file should represent both the "
                "slip plane normal and the slip direction with 4-indices each.");
 
   // set up the tranformation matrices
   RankTwoTensor transform_matrix;
   transform_matrix.zero();
   transform_matrix(0, 0) = 1.0 / _unit_cell_dimension[0];
   transform_matrix(1, 0) = 1.0 / (_unit_cell_dimension[0] * std::sqrt(3.0));
   transform_matrix(1, 1) = 2.0 / (_unit_cell_dimension[0] * std::sqrt(3.0));
   transform_matrix(2, 2) = 1.0 / (_unit_cell_dimension[2]);
 
   for (const auto i : make_range(_number_slip_systems))
   {
     // read in raw data from file and store in the temporary vectors
     for (const auto j : index_range(reader.getData(i)))
     {
       // Check that the slip plane normal indices of the basal plane sum to zero for consistency
       Real basal_pl_sum = 0.0;
       for (const auto k : make_range(LIBMESH_DIM))
         basal_pl_sum += reader.getData(i)[k];
 
       if (basal_pl_sum > _zero_tol)
         mooseError(
             "CrystalPlasticityStressUpdateBase Error: The specified HCP basal plane Miller-Bravais "
             "indices do not sum to zero. Check the values supplied in the associated text file.");
 
       // Check that the slip direction indices of the basal plane sum to zero for consistency
       Real basal_dir_sum = 0.0;
       for (const auto k : make_range(miller_bravais_indices, miller_bravais_indices + LIBMESH_DIM))
         basal_dir_sum += reader.getData(i)[k];
 
       if (basal_dir_sum > _zero_tol)
         mooseError("CrystalPlasticityStressUpdateBase Error: The specified HCP slip direction "
                    "Miller-Bravais indices in the basal plane (U, V, and T) do not sum to zero "
                    "within the user specified tolerance (try loosing zero_tol if using the default "
                    "value). Check the values supplied in the associated text file.");
 
       if (j < miller_bravais_indices)
       {
         // Planes are directly copied over, per a_1 = x convention used here:
         // Store the first two indices for the basal plane, (h and k), and drop
         // the redundant third basal plane index (i)
         if (j < 2)
           temporary_slip_plane(j) = reader.getData(i)[j];
         // Store the c-axis index as the third entry in the orthorombic index convention
         else if (j == 3)
           temporary_slip_plane(j - 1) = reader.getData(i)[j];
       }
       else
       {
         const auto direction_j = j - miller_bravais_indices;
         // Store the first two indices for the slip direction in the basal plane,
         //(U, V), and drop the redundant third basal plane index (T)
         if (direction_j < 2)
           temporary_slip_direction(direction_j) = reader.getData(i)[j];
         // Store the c-axis index as the third entry in the orthorombic index convention
         else if (direction_j == 3)
           temporary_slip_direction(direction_j - 1) = reader.getData(i)[j];
       }
     }
 
     // perform transformation calculation
     _slip_direction[i] = transform_matrix * temporary_slip_direction;
     _slip_plane_normal[i] = transform_matrix * temporary_slip_plane;
   }
 }

◆ updateStateVariables()

virtual bool CrystalPlasticityStressUpdateBase::updateStateVariables ( )

pure virtual

Finalizes the values of the state variables and slip system resistance for the current timestep after convergence has been reached.

Implemented in CrystalPlasticityKalidindiUpdate, CrystalPlasticityTwinningKalidindiUpdate, and CrystalPlasticityHCPDislocationSlipBeyerleinUpdate.

◆ updateSubstepConstitutiveVariableValues()

virtual void CrystalPlasticityStressUpdateBase::updateSubstepConstitutiveVariableValues ( )

inlinevirtual

Stores the current value of the constitutive internal state variables into a separate material property in case substepping is required, once the constitutive variables have passed convergence tolerances.

This separate material property is used as the previous substep value in the associated setSubstepConstitutiveVariableValues method in the next substep (if taken).

Reimplemented in CrystalPlasticityKalidindiUpdate, CrystalPlasticityTwinningKalidindiUpdate, and CrystalPlasticityHCPDislocationSlipBeyerleinUpdate.

Definition at line 137 of file CrystalPlasticityStressUpdateBase.h.

137 {}

◆ validParams()

InputParameters CrystalPlasticityStressUpdateBase::validParams ( )

static

Definition at line 18 of file CrystalPlasticityStressUpdateBase.C.

Referenced by CrystalPlasticityHCPDislocationSlipBeyerleinUpdate::validParams(), CrystalPlasticityTwinningKalidindiUpdate::validParams(), and CrystalPlasticityKalidindiUpdate::validParams().

 {
   InputParameters params = Material::validParams();
   params.addParam<std::string>(
       "base_name",
       "Optional parameter that allows the user to define multiple crystal plasticity mechanisms");
   params.addClassDescription(
       "Crystal Plasticity base class: handles the Newton iteration over the stress residual and "
       "calculates the Jacobian based on constitutive laws provided by inheriting classes");
 
   // The return stress increment classes are intended to be iterative materials, so must set compute
   // = false for all inheriting classes
   params.set<bool>("compute") = false;
   params.suppressParameter<bool>("compute");
 
   params.addParam<MooseEnum>(
       "crystal_lattice_type",
       MooseEnum("BCC FCC HCP", "FCC"),
       "Crystal lattice type or representative unit cell, i.e., BCC, FCC, HCP, etc.");
 
   params.addRangeCheckedParam<std::vector<Real>>(
       "unit_cell_dimension",
       std::vector<Real>{1.0, 1.0, 1.0},
       "unit_cell_dimension_size = 3",
       "The dimension of the unit cell along three directions, where a cubic unit cell is assumed "
       "for cubic crystals and a hexagonal unit cell (a, a, c) is assumed for HCP crystals. These "
       "dimensions will be taken into account while computing the slip systems."
       " Default size is 1.0 along all three directions.");
 
   params.addRequiredParam<unsigned int>(
       "number_slip_systems",
       "The total number of possible active slip systems for the crystalline material");
   params.addRequiredParam<FileName>(
       "slip_sys_file_name",
       "Name of the file containing the slip systems, one slip system per row, with the slip plane "
       "normal given before the slip plane direction.");
   params.addParam<Real>("number_cross_slip_directions",
                         0,
                         "Quanity of unique slip directions, used to determine cross slip familes");
   params.addParam<Real>("number_cross_slip_planes",
                         0,
                         "Quanity of slip planes belonging to a single cross slip direction; used "
                         "to determine cross slip families");
   params.addParam<Real>(
       "slip_increment_tolerance",
       2e-2,
       "Maximum allowable slip in an increment for each individual constitutive model");
   params.addParam<Real>(
       "stol", 1e-2, "Constitutive internal state variable relative change tolerance");
   params.addParam<Real>("resistance_tol",
                         1.0e-2,
                         "Constitutive slip system resistance relative residual tolerance for each "
                         "individual constitutive model");
   params.addParam<Real>("zero_tol",
                         1e-12,
                         "Tolerance for residual check when variable value is zero for each "
                         "individual constitutive model");
   params.addParam<bool>(
       "print_state_variable_convergence_error_messages",
       false,
       "Whether or not to print warning messages from the crystal plasticity specific convergence "
       "checks on both the constiutive model internal state variables.");
   return params;
 }