J2 plasticity, associative, with hardning. More...

#include <SolidMechanicsPlasticJ2.h>

Inheritance diagram for SolidMechanicsPlasticJ2:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	SolidMechanicsPlasticJ2 (const InputParameters &parameters)

virtual std::string	modelName () const override

virtual bool	useCustomReturnMap () const override
	Returns false. You will want to override this in your derived class if you write a custom returnMap function. More...

virtual bool	useCustomCTO () const override
	Returns false. You will want to override this in your derived class if you write a custom consistent tangent operator function. More...

virtual bool	returnMap (const RankTwoTensor &trial_stress, Real intnl_old, const RankFourTensor &E_ijkl, Real ep_plastic_tolerance, RankTwoTensor &returned_stress, Real &returned_intnl, std::vector< Real > &dpm, RankTwoTensor &delta_dp, std::vector< Real > &yf, bool &trial_stress_inadmissible) const override
	Performs a custom return-map. More...

virtual RankFourTensor	consistentTangentOperator (const RankTwoTensor &trial_stress, Real intnl_old, const RankTwoTensor &stress, Real intnl, const RankFourTensor &E_ijkl, const std::vector< Real > &cumulative_pm) const override
	Calculates a custom consistent tangent operator. More...

void	initialize ()

void	execute ()

void	finalize ()

virtual unsigned int	numberSurfaces () const
	The number of yield surfaces for this plasticity model. More...

virtual void	yieldFunctionV (const RankTwoTensor &stress, Real intnl, std::vector< Real > &f) const
	Calculates the yield functions. More...

virtual void	dyieldFunction_dstressV (const RankTwoTensor &stress, Real intnl, std::vector< RankTwoTensor > &df_dstress) const
	The derivative of yield functions with respect to stress. More...

virtual void	dyieldFunction_dintnlV (const RankTwoTensor &stress, Real intnl, std::vector< Real > &df_dintnl) const
	The derivative of yield functions with respect to the internal parameter. More...

virtual void	flowPotentialV (const RankTwoTensor &stress, Real intnl, std::vector< RankTwoTensor > &r) const
	The flow potentials. More...

virtual void	dflowPotential_dstressV (const RankTwoTensor &stress, Real intnl, std::vector< RankFourTensor > &dr_dstress) const
	The derivative of the flow potential with respect to stress. More...

virtual void	dflowPotential_dintnlV (const RankTwoTensor &stress, Real intnl, std::vector< RankTwoTensor > &dr_dintnl) const
	The derivative of the flow potential with respect to the internal parameter. More...

virtual void	hardPotentialV (const RankTwoTensor &stress, Real intnl, std::vector< Real > &h) const
	The hardening potential. More...

virtual void	dhardPotential_dstressV (const RankTwoTensor &stress, Real intnl, std::vector< RankTwoTensor > &dh_dstress) const
	The derivative of the hardening potential with respect to stress. More...

virtual void	dhardPotential_dintnlV (const RankTwoTensor &stress, Real intnl, std::vector< Real > &dh_dintnl) const
	The derivative of the hardening potential with respect to the internal parameter. More...

virtual void	activeConstraints (const std::vector< Real > &f, const RankTwoTensor &stress, Real intnl, const RankFourTensor &Eijkl, std::vector< bool > &act, RankTwoTensor &returned_stress) const
	The active yield surfaces, given a vector of yield functions. More...

bool	KuhnTuckerSingleSurface (Real yf, Real dpm, Real dpm_tol) const
	Returns true if the Kuhn-Tucker conditions for the single surface are satisfied. More...

SubProblem &	getSubProblem () const

bool	shouldDuplicateInitialExecution () const

virtual Real	spatialValue (const Point &) const

virtual const std::vector< Point >	spatialPoints () const

void	gatherSum (T &value)

void	gatherMax (T &value)

void	gatherMin (T &value)

void	gatherProxyValueMax (T1 &proxy, T2 &value)

void	gatherProxyValueMin (T1 &proxy, T2 &value)

void	setPrimaryThreadCopy (UserObject *primary)

UserObject *	primaryThreadCopy ()

std::set< UserObjectName >	getDependObjects () const

virtual bool	needThreadedCopy () const

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

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

unsigned int	systemNumber () 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

virtual void	initialSetup ()

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () 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

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

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

const std::set< TagID > &	getScalarVariableCoupleableMatrixTags () 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 MaterialPropertyName &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 MaterialPropertyName &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 MaterialPropertyName &name)

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

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

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

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

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

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

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

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

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

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty ()

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

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

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

virtual const std::unordered_set< unsigned int > &	getMatPropDependencies () const

virtual void	resolveOptionalProperties ()

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

bool	isImplicit ()

Moose::StateArg	determineState () const

virtual void	threadJoin (const UserObject &) override

virtual void	threadJoin (const UserObject &) override

virtual void	subdomainSetup () override

virtual void	subdomainSetup () override

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 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)

MaterialBase &	getMaterial (const std::string &name)

MaterialBase &	getMaterial (const std::string &name)

MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)

MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)

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)

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

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

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

Sampler &	getSampler (const std::string &name)

T &	getSamplerByName (const SamplerName &name)

Sampler &	getSamplerByName (const SamplerName &name)

virtual void	meshChanged ()

virtual void	meshDisplaced ()

PerfGraph &	perfGraph ()

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

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

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

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)

Public Attributes
const Real	_f_tol
	Tolerance on yield function. More...

const Real	_ic_tol
	Tolerance on internal constraint. More...

const ConsoleStream	_console

Static Public Attributes
static constexpr PropertyValue::id_type	default_property_id

static constexpr PropertyValue::id_type	zero_property_id

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
virtual Real	yieldFunction (const RankTwoTensor &stress, Real intnl) const override
	The following functions are what you should override when building single-plasticity models. More...

virtual RankTwoTensor	dyieldFunction_dstress (const RankTwoTensor &stress, Real intnl) const override
	The derivative of yield function with respect to stress. More...

Real	dyieldFunction_dintnl (const RankTwoTensor &stress, Real intnl) const override
	The derivative of yield function with respect to the internal parameter. More...

virtual RankTwoTensor	flowPotential (const RankTwoTensor &stress, Real intnl) const override
	The flow potential. More...

virtual RankFourTensor	dflowPotential_dstress (const RankTwoTensor &stress, Real intnl) const override
	The derivative of the flow potential with respect to stress. More...

RankTwoTensor	dflowPotential_dintnl (const RankTwoTensor &stress, Real intnl) const override
	The derivative of the flow potential with respect to the internal parameter. More...

virtual Real	yieldStrength (Real intnl) const
	YieldStrength. More...

virtual Real	dyieldStrength (Real intnl) const
	d(yieldStrength)/d(intnl) More...

virtual Real	hardPotential (const RankTwoTensor &stress, Real intnl) const
	The hardening potential. More...

virtual RankTwoTensor	dhardPotential_dstress (const RankTwoTensor &stress, Real intnl) const
	The derivative of the hardening potential with respect to stress. More...

virtual Real	dhardPotential_dintnl (const RankTwoTensor &stress, Real intnl) const
	The derivative of the hardening potential with respect to the internal parameter. More...

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &name) const override

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override

virtual void	addUserObjectDependencyHelper (const UserObject &uo) const override

void	addReporterDependencyHelper (const ReporterName &reporter_name) override

const ReporterName &	getReporterName (const std::string &param_name) 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

const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)

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

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

bool	hasMeshProperty (const std::string &data_name) const

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

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_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	checkMaterialProperty (const std::string &name, const unsigned int state)

void	markMatPropRequested (const std::string &)

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

void	checkExecutionStage ()

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_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)

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

const THREAD_ID	_tid

Assembly &	_assembly

const Moose::CoordinateSystemType &	_coord_sys

const bool	_duplicate_initial_execution

std::set< std::string >	_depend_uo

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

FEProblemBase &	_mci_feproblem

FEProblemBase &	_mdi_feproblem

MooseApp &	_pg_moose_app

const std::string	_prefix

FEProblemBase &	_sc_fe_problem

const THREAD_ID	_sc_tid

const Real &	_real_zero

const VariableValue &	_scalar_zero

const Point &	_point_zero

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

const Parallel::Communicator &	_communicator

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

Private Attributes
const SolidMechanicsHardeningModel &	_strength
	yield strength, from user input More...

const unsigned	_max_iters
	max iters for custom return map loop More...

const bool	_use_custom_returnMap
	Whether to use the custom return-map algorithm. More...

const bool	_use_custom_cto
	Whether to use the custom consistent tangent operator calculation. More...

Detailed Description

J2 plasticity, associative, with hardning.

Yield_function = sqrt(3*J2) - yield_strength

Definition at line 19 of file SolidMechanicsPlasticJ2.h.

Constructor & Destructor Documentation

◆ SolidMechanicsPlasticJ2()

SolidMechanicsPlasticJ2::SolidMechanicsPlasticJ2 ( const InputParameters & parameters )

Definition at line 43 of file SolidMechanicsPlasticJ2.C.

   : SolidMechanicsPlasticModel(parameters),
     _strength(getUserObject<SolidMechanicsHardeningModel>("yield_strength")),
     _max_iters(getParam<unsigned>("max_iterations")),
     _use_custom_returnMap(getParam<bool>("use_custom_returnMap")),
     _use_custom_cto(getParam<bool>("use_custom_cto"))
 {
 }

Member Function Documentation

◆ activeConstraints()

void SolidMechanicsPlasticModel::activeConstraints	(	const std::vector< Real > &	f,
		const RankTwoTensor &	stress,
		Real	intnl,
		const RankFourTensor &	Eijkl,
		std::vector< bool > &	act,
		RankTwoTensor &	returned_stress
	)		const

virtualinherited

The active yield surfaces, given a vector of yield functions.

This is used by FiniteStrainMultiPlasticity to determine the initial set of active constraints at the trial (stress, intnl) configuration. It is up to you (the coder) to determine how accurate you want the returned_stress to be. Currently it is only used by FiniteStrainMultiPlasticity to estimate a good starting value for the Newton-Rahson procedure, so currently it may not need to be super perfect.

Parameters

	f	values of the yield functions
	stress	stress tensor
	intnl	internal parameter
	Eijkl	elasticity tensor (stress = Eijkl*strain)
[out]	act	act[i] = true if the i_th yield function is active
[out]	returned_stress	Approximate value of the returned stress

Reimplemented in SolidMechanicsPlasticMohrCoulombMulti, SolidMechanicsPlasticTensileMulti, SolidMechanicsPlasticMeanCapTC, SolidMechanicsPlasticWeakPlaneShear, and SolidMechanicsPlasticWeakPlaneTensile.

Definition at line 186 of file SolidMechanicsPlasticModel.C.

 {
   mooseAssert(f.size() == numberSurfaces(),
               "f incorrectly sized at " << f.size() << " in activeConstraints");
   act.resize(numberSurfaces());
   for (unsigned surface = 0; surface < numberSurfaces(); ++surface)
     act[surface] = (f[surface] > _f_tol);
 }

◆ consistentTangentOperator()

RankFourTensor SolidMechanicsPlasticJ2::consistentTangentOperator	(	const RankTwoTensor &	trial_stress,
		Real	intnl_old,
		const RankTwoTensor &	stress,
		Real	intnl,
		const RankFourTensor &	E_ijkl,
		const std::vector< Real > &	cumulative_pm
	)		const

overridevirtual

Calculates a custom consistent tangent operator.

You may choose to over-ride this in your derived SolidMechanicsPlasticXXXX class.

(Note, if you over-ride returnMap, you will probably want to override consistentTangentOpertor too, otherwise it will default to E_ijkl.)

Parameters

stress_old	trial stress before returning
intnl_old	internal parameter before returning
stress	current returned stress state
intnl	internal parameter
E_ijkl	elasticity tensor
cumulative_pm	the cumulative plastic multipliers

Returns: the consistent tangent operator: E_ijkl if not over-ridden

Reimplemented from SolidMechanicsPlasticModel.

Definition at line 195 of file SolidMechanicsPlasticJ2.C.

 {
   if (!_use_custom_cto)
     return SolidMechanicsPlasticModel::consistentTangentOperator(
         trial_stress, intnl_old, stress, intnl, E_ijkl, cumulative_pm);
 
   Real mu = E_ijkl(0, 1, 0, 1);
 
   Real h = 3 * mu + dyieldStrength(intnl);
   RankTwoTensor sij = stress.deviatoric();
   Real sII = stress.secondInvariant();
   Real equivalent_stress = std::sqrt(3.0 * sII);
   Real zeta = cumulative_pm[0] / (1.0 + 3.0 * mu * cumulative_pm[0] / equivalent_stress);
 
   return E_ijkl - 3.0 * mu * mu / sII / h * sij.outerProduct(sij) -
          4.0 * mu * mu * zeta * dflowPotential_dstress(stress, intnl);
 }

◆ dflowPotential_dintnl()

RankTwoTensor SolidMechanicsPlasticJ2::dflowPotential_dintnl	(	const RankTwoTensor &	stress,
		Real	intnl
	)		const

overrideprotectedvirtual

The derivative of the flow potential with respect to the internal parameter.

Parameters

stress	the stress at which to calculate the flow potential
intnl	internal parameter

Returns: dr_dintnl(i, j) = dr(i, j)/dintnl

Reimplemented from SolidMechanicsPlasticModel.

Definition at line 99 of file SolidMechanicsPlasticJ2.C.

 {
   return RankTwoTensor();
 }

◆ dflowPotential_dintnlV()

void SolidMechanicsPlasticModel::dflowPotential_dintnlV	(	const RankTwoTensor &	stress,
		Real	intnl,
		std::vector< RankTwoTensor > &	dr_dintnl
	)		const

virtualinherited

The derivative of the flow potential with respect to the internal parameter.

Parameters

	stress	the stress at which to calculate the flow potential
	intnl	internal parameter
[out]	dr_dintnl	dr_dintnl[alpha](i, j) = dr[alpha](i, j)/dintnl

Reimplemented in SolidMechanicsPlasticMohrCoulombMulti, and SolidMechanicsPlasticTensileMulti.

Definition at line 137 of file SolidMechanicsPlasticModel.C.

 {
   return dr_dintnl.assign(1, dflowPotential_dintnl(stress, intnl));
 }

◆ dflowPotential_dstress()

RankFourTensor SolidMechanicsPlasticJ2::dflowPotential_dstress	(	const RankTwoTensor &	stress,
		Real	intnl
	)		const

overrideprotectedvirtual

The derivative of the flow potential with respect to stress.

Parameters

stress	the stress at which to calculate the flow potential
intnl	internal parameter

Returns: dr_dstress(i, j, k, l) = dr(i, j)/dstress(k, l)

Reimplemented from SolidMechanicsPlasticModel.

Reimplemented in SolidMechanicsPlasticIsotropicSD, and SolidMechanicsPlasticOrthotropic.

Definition at line 81 of file SolidMechanicsPlasticJ2.C.

Referenced by consistentTangentOperator(), SolidMechanicsPlasticOrthotropic::dflowPotential_dstress(), and SolidMechanicsPlasticIsotropicSD::dflowPotential_dstress().

 {
   Real sII = stress.secondInvariant();
   if (sII == 0)
     return RankFourTensor();
 
   RankFourTensor dfp = 0.5 * std::sqrt(3.0 / sII) * stress.d2secondInvariant();
   Real pre = -0.25 * std::sqrt(3.0) * std::pow(sII, -1.5);
   RankTwoTensor dII = stress.dsecondInvariant();
   for (unsigned i = 0; i < 3; ++i)
     for (unsigned j = 0; j < 3; ++j)
       for (unsigned k = 0; k < 3; ++k)
         for (unsigned l = 0; l < 3; ++l)
           dfp(i, j, k, l) += pre * dII(i, j) * dII(k, l);
   return dfp;
 }

◆ dflowPotential_dstressV()

void SolidMechanicsPlasticModel::dflowPotential_dstressV	(	const RankTwoTensor &	stress,
		Real	intnl,
		std::vector< RankFourTensor > &	dr_dstress
	)		const

virtualinherited

The derivative of the flow potential with respect to stress.

Parameters

	stress	the stress at which to calculate the flow potential
	intnl	internal parameter
[out]	dr_dstress	dr_dstress[alpha](i, j, k, l) = dr[alpha](i, j)/dstress(k, l)

Reimplemented in SolidMechanicsPlasticMohrCoulombMulti, and SolidMechanicsPlasticTensileMulti.

Definition at line 123 of file SolidMechanicsPlasticModel.C.

 {
   return dr_dstress.assign(1, dflowPotential_dstress(stress, intnl));
 }

◆ dhardPotential_dintnl()

Real SolidMechanicsPlasticModel::dhardPotential_dintnl	(	const RankTwoTensor &	stress,
		Real	intnl
	)		const

protectedvirtualinherited

The derivative of the hardening potential with respect to the internal parameter.

Parameters

stress	the stress at which to calculate the hardening potentials
intnl	internal parameter

Returns: the derivative

Reimplemented in SolidMechanicsPlasticMeanCapTC.

Definition at line 172 of file SolidMechanicsPlasticModel.C.

Referenced by SolidMechanicsPlasticModel::dhardPotential_dintnlV().

 {
   return 0.0;
 }

◆ dhardPotential_dintnlV()

void SolidMechanicsPlasticModel::dhardPotential_dintnlV	(	const RankTwoTensor &	stress,
		Real	intnl,
		std::vector< Real > &	dh_dintnl
	)		const

virtualinherited

The derivative of the hardening potential with respect to the internal parameter.

Parameters

	stress	the stress at which to calculate the hardening potentials
	intnl	internal parameter
[out]	dh_dintnl	dh_dintnl[alpha] = dh[alpha]/dintnl

Definition at line 178 of file SolidMechanicsPlasticModel.C.

 {
   dh_dintnl.resize(numberSurfaces(), dhardPotential_dintnl(stress, intnl));
 }

◆ dhardPotential_dstress()

RankTwoTensor SolidMechanicsPlasticModel::dhardPotential_dstress	(	const RankTwoTensor &	stress,
		Real	intnl
	)		const

protectedvirtualinherited

The derivative of the hardening potential with respect to stress.

Parameters

stress	the stress at which to calculate the hardening potentials
intnl	internal parameter

Returns: dh_dstress(i, j) = dh/dstress(i, j)

Reimplemented in SolidMechanicsPlasticMeanCapTC.

Definition at line 158 of file SolidMechanicsPlasticModel.C.

Referenced by SolidMechanicsPlasticModel::dhardPotential_dstressV().

 {
   return RankTwoTensor();
 }

◆ dhardPotential_dstressV()

void SolidMechanicsPlasticModel::dhardPotential_dstressV	(	const RankTwoTensor &	stress,
		Real	intnl,
		std::vector< RankTwoTensor > &	dh_dstress
	)		const

virtualinherited

The derivative of the hardening potential with respect to stress.

Parameters

	stress	the stress at which to calculate the hardening potentials
	intnl	internal parameter
[out]	dh_dstress	dh_dstress[alpha](i, j) = dh[alpha]/dstress(i, j)

Definition at line 164 of file SolidMechanicsPlasticModel.C.

 {
   dh_dstress.assign(numberSurfaces(), dhardPotential_dstress(stress, intnl));
 }

◆ dyieldFunction_dintnl()

Real SolidMechanicsPlasticJ2::dyieldFunction_dintnl	(	const RankTwoTensor &	stress,
		Real	intnl
	)		const

overrideprotectedvirtual

The derivative of yield function with respect to the internal parameter.

Parameters

stress	the stress at which to calculate the yield function
intnl	internal parameter

Returns: the derivative

Reimplemented from SolidMechanicsPlasticModel.

Definition at line 69 of file SolidMechanicsPlasticJ2.C.

 {
   return -dyieldStrength(intnl);
 }

◆ dyieldFunction_dintnlV()

void SolidMechanicsPlasticModel::dyieldFunction_dintnlV	(	const RankTwoTensor &	stress,
		Real	intnl,
		std::vector< Real > &	df_dintnl
	)		const

virtualinherited

The derivative of yield functions with respect to the internal parameter.

Parameters

	stress	the stress at which to calculate the yield function
	intnl	internal parameter
[out]	df_dintnl	df_dintnl[alpha] = df[alpha]/dintnl

Reimplemented in SolidMechanicsPlasticMohrCoulombMulti, and SolidMechanicsPlasticTensileMulti.

Definition at line 96 of file SolidMechanicsPlasticModel.C.

 {
   return df_dintnl.assign(1, dyieldFunction_dintnl(stress, intnl));
 }

◆ dyieldFunction_dstress()

RankTwoTensor SolidMechanicsPlasticJ2::dyieldFunction_dstress	(	const RankTwoTensor &	stress,
		Real	intnl
	)		const

overrideprotectedvirtual

The derivative of yield function with respect to stress.

Parameters

stress	the stress at which to calculate the yield function
intnl	internal parameter

Returns: df_dstress(i, j) = dyieldFunction/dstress(i, j)

Reimplemented from SolidMechanicsPlasticModel.

Reimplemented in SolidMechanicsPlasticIsotropicSD, and SolidMechanicsPlasticOrthotropic.

Definition at line 59 of file SolidMechanicsPlasticJ2.C.

Referenced by SolidMechanicsPlasticOrthotropic::flowPotential(), flowPotential(), and SolidMechanicsPlasticIsotropicSD::flowPotential().

 {
   Real sII = stress.secondInvariant();
   if (sII == 0.0)
     return RankTwoTensor();
   else
     return 0.5 * std::sqrt(3.0 / sII) * stress.dsecondInvariant();
 }

◆ dyieldFunction_dstressV()

void SolidMechanicsPlasticModel::dyieldFunction_dstressV	(	const RankTwoTensor &	stress,
		Real	intnl,
		std::vector< RankTwoTensor > &	df_dstress
	)		const

virtualinherited

The derivative of yield functions with respect to stress.

Parameters

	stress	the stress at which to calculate the yield function
	intnl	internal parameter
[out]	df_dstress	df_dstress[alpha](i, j) = dyieldFunction[alpha]/dstress(i, j)

Reimplemented in SolidMechanicsPlasticMohrCoulombMulti, and SolidMechanicsPlasticTensileMulti.

Definition at line 82 of file SolidMechanicsPlasticModel.C.

 {
   df_dstress.assign(1, dyieldFunction_dstress(stress, intnl));
 }

◆ dyieldStrength()

Real SolidMechanicsPlasticJ2::dyieldStrength ( Real intnl ) const

protectedvirtual

d(yieldStrength)/d(intnl)

Definition at line 112 of file SolidMechanicsPlasticJ2.C.

Referenced by consistentTangentOperator(), dyieldFunction_dintnl(), and returnMap().

 {
   return _strength.derivative(intnl);
 }

◆ execute()

void SolidMechanicsPlasticModel::execute ( )

virtualinherited

Implements GeneralUserObject.

Definition at line 45 of file SolidMechanicsPlasticModel.C.

46 {

47 }

◆ finalize()

void SolidMechanicsPlasticModel::finalize ( )

virtualinherited

Implements GeneralUserObject.

Definition at line 50 of file SolidMechanicsPlasticModel.C.

51 {

52 }

◆ flowPotential()

RankTwoTensor SolidMechanicsPlasticJ2::flowPotential	(	const RankTwoTensor &	stress,
		Real	intnl
	)		const

overrideprotectedvirtual

The flow potential.

Parameters

stress	the stress at which to calculate the flow potential
intnl	internal parameter

Returns: the flow potential

Reimplemented from SolidMechanicsPlasticModel.

Reimplemented in SolidMechanicsPlasticIsotropicSD, and SolidMechanicsPlasticOrthotropic.

Definition at line 75 of file SolidMechanicsPlasticJ2.C.

 {
   return dyieldFunction_dstress(stress, intnl);
 }

◆ flowPotentialV()

void SolidMechanicsPlasticModel::flowPotentialV	(	const RankTwoTensor &	stress,
		Real	intnl,
		std::vector< RankTwoTensor > &	r
	)		const

virtualinherited

The flow potentials.

Parameters

	stress	the stress at which to calculate the flow potential
	intnl	internal parameter
[out]	r	r[alpha] is the flow potential for the "alpha" yield function

Reimplemented in SolidMechanicsPlasticMohrCoulombMulti, and SolidMechanicsPlasticTensileMulti.

Definition at line 109 of file SolidMechanicsPlasticModel.C.

 {
   return r.assign(1, flowPotential(stress, intnl));
 }

◆ hardPotential()

Real SolidMechanicsPlasticModel::hardPotential	(	const RankTwoTensor &	stress,
		Real	intnl
	)		const

protectedvirtualinherited

The hardening potential.

Parameters

stress	the stress at which to calculate the hardening potential
intnl	internal parameter

Returns: the hardening potential

Reimplemented in SolidMechanicsPlasticMeanCapTC.

Definition at line 145 of file SolidMechanicsPlasticModel.C.

Referenced by SolidMechanicsPlasticModel::hardPotentialV().

 {
   return -1.0;
 }

◆ hardPotentialV()

void SolidMechanicsPlasticModel::hardPotentialV	(	const RankTwoTensor &	stress,
		Real	intnl,
		std::vector< Real > &	h
	)		const

virtualinherited

The hardening potential.

Parameters

	stress	the stress at which to calculate the hardening potential
	intnl	internal parameter
[out]	h	h[alpha] is the hardening potential for the "alpha" yield function

Definition at line 150 of file SolidMechanicsPlasticModel.C.

 {
   h.assign(numberSurfaces(), hardPotential(stress, intnl));
 }

◆ initialize()

void SolidMechanicsPlasticModel::initialize ( )

virtualinherited

Implements GeneralUserObject.

Definition at line 40 of file SolidMechanicsPlasticModel.C.

41 {

42 }

◆ KuhnTuckerSingleSurface()

bool SolidMechanicsPlasticModel::KuhnTuckerSingleSurface	(	Real	yf,
		Real	dpm,
		Real	dpm_tol
	)		const

inherited

Returns true if the Kuhn-Tucker conditions for the single surface are satisfied.

Parameters

yf	Yield function value
dpm	plastic multiplier
dpm_tol	tolerance on plastic multiplier: viz dpm>-dpm_tol means "dpm is non-negative"

Definition at line 246 of file SolidMechanicsPlasticModel.C.

Referenced by SolidMechanicsPlasticMohrCoulombMulti::KuhnTuckerOK(), SolidMechanicsPlasticTensileMulti::KuhnTuckerOK(), and SolidMechanicsPlasticModel::returnMap().

 {
   return (dpm == 0 && yf <= _f_tol) || (dpm > -dpm_tol && yf <= _f_tol && yf >= -_f_tol);
 }

◆ modelName()

std::string SolidMechanicsPlasticJ2::modelName ( ) const

overridevirtual

Implements SolidMechanicsPlasticModel.

Definition at line 118 of file SolidMechanicsPlasticJ2.C.

 {
   return "J2";
 }

◆ numberSurfaces()

unsigned SolidMechanicsPlasticModel::numberSurfaces ( ) const

virtualinherited

The number of yield surfaces for this plasticity model.

Reimplemented in SolidMechanicsPlasticMohrCoulombMulti, and SolidMechanicsPlasticTensileMulti.

Definition at line 55 of file SolidMechanicsPlasticModel.C.

Referenced by SolidMechanicsPlasticModel::activeConstraints(), SolidMechanicsPlasticModel::dhardPotential_dintnlV(), SolidMechanicsPlasticModel::dhardPotential_dstressV(), SolidMechanicsPlasticModel::hardPotentialV(), and SolidMechanicsPlasticModel::returnMap().

 {
   return 1;
 }

◆ returnMap()

bool SolidMechanicsPlasticJ2::returnMap	(	const RankTwoTensor &	trial_stress,
		Real	intnl_old,
		const RankFourTensor &	E_ijkl,
		Real	ep_plastic_tolerance,
		RankTwoTensor &	returned_stress,
		Real &	returned_intnl,
		std::vector< Real > &	dpm,
		RankTwoTensor &	delta_dp,
		std::vector< Real > &	yf,
		bool &	trial_stress_inadmissible
	)		const

overridevirtual

Performs a custom return-map.

You may choose to over-ride this in your derived SolidMechanicsPlasticXXXX class, and you may implement the return-map algorithm in any way that suits you. Eg, using a Newton-Raphson approach, or a radial-return, etc. This may also be used as a quick way of ascertaining whether (trial_stress, intnl_old) is in fact admissible.

For over-riding this function, please note the following.

(1) Denoting the return value of the function by "successful_return", the only possible output values should be: (A) trial_stress_inadmissible=false, successful_return=true. That is, (trial_stress, intnl_old) is in fact admissible (in the elastic domain). (B) trial_stress_inadmissible=true, successful_return=false. That is (trial_stress, intnl_old) is inadmissible (outside the yield surface), and you didn't return to the yield surface. (C) trial_stress_inadmissible=true, successful_return=true. That is (trial_stress, intnl_old) is inadmissible (outside the yield surface), but you did return to the yield surface. The default implementation only handles case (A) and (B): it does not attempt to do a return-map algorithm.

(2) you must correctly signal "successful_return" using the return value of this function. Don't assume the calling function will do Kuhn-Tucker checking and so forth!

(3) In cases (A) and (B) you needn't set returned_stress, returned_intnl, delta_dp, or dpm. This is for computational efficiency.

(4) In cases (A) and (B), you MUST place the yield function values at (trial_stress, intnl_old) into yf so the calling function can use this information optimally. You will have already calculated these yield function values, which can be quite expensive, and it's not very optimal for the calling function to have to re-calculate them.

(5) In case (C), you need to set: returned_stress (the returned value of stress) returned_intnl (the returned value of the internal variable) delta_dp (the change in plastic strain) dpm (the plastic multipliers needed to bring about the return) yf (yield function values at the returned configuration)

(Note, if you over-ride returnMap, you will probably want to override consistentTangentOpertor too, otherwise it will default to E_ijkl.)

Parameters

	trial_stress	The trial stress
	intnl_old	Value of the internal parameter
	E_ijkl	Elasticity tensor
	ep_plastic_tolerance	Tolerance defined by the user for the plastic strain
[out]	returned_stress	In case (C): lies on the yield surface after returning and produces the correct plastic strain (normality condition). Otherwise: not defined
[out]	returned_intnl	In case (C): the value of the internal parameter after returning. Otherwise: not defined
[out]	dpm	In case (C): the plastic multipliers needed to bring about the return. Otherwise: not defined
[out]	delta_dp	In case (C): The change in plastic strain induced by the return process. Otherwise: not defined
[out]	yf	In case (C): the yield function at (returned_stress, returned_intnl). Otherwise: the yield function at (trial_stress, intnl_old)
[out]	trial_stress_inadmissible	Should be set to false if the trial_stress is admissible, and true if the trial_stress is inadmissible. This can be used by the calling prorgram

Returns: true if a successful return (or a return-map not needed), false if the trial_stress is inadmissible but the return process failed

Reimplemented from SolidMechanicsPlasticModel.

Definition at line 124 of file SolidMechanicsPlasticJ2.C.

 {
   if (!(_use_custom_returnMap))
     return SolidMechanicsPlasticModel::returnMap(trial_stress,
                                                  intnl_old,
                                                  E_ijkl,
                                                  ep_plastic_tolerance,
                                                  returned_stress,
                                                  returned_intnl,
                                                  dpm,
                                                  delta_dp,
                                                  yf,
                                                  trial_stress_inadmissible);
 
   yf.resize(1);
 
   Real yf_orig = yieldFunction(trial_stress, intnl_old);
 
   yf[0] = yf_orig;
 
   if (yf_orig < _f_tol)
   {
     // the trial_stress is admissible
     trial_stress_inadmissible = false;
     return true;
   }
 
   trial_stress_inadmissible = true;
   Real mu = E_ijkl(0, 1, 0, 1);
 
   // Perform a Newton-Raphson to find dpm when
   // residual = 3*mu*dpm - trial_equivalent_stress + yieldStrength(intnl_old + dpm) = 0
   Real trial_equivalent_stress = yf_orig + yieldStrength(intnl_old);
   Real residual;
   Real jac;
   dpm[0] = 0;
   unsigned int iter = 0;
   do
   {
     residual = 3.0 * mu * dpm[0] - trial_equivalent_stress + yieldStrength(intnl_old + dpm[0]);
     jac = 3.0 * mu + dyieldStrength(intnl_old + dpm[0]);
     dpm[0] += -residual / jac;
     if (iter > _max_iters) // not converging
       return false;
     iter++;
   } while (residual * residual > _f_tol * _f_tol);
 
   // set the returned values
   yf[0] = 0;
   returned_intnl = intnl_old + dpm[0];
   RankTwoTensor nn = 1.5 * trial_stress.deviatoric() /
                      trial_equivalent_stress; // = dyieldFunction_dstress(trial_stress, intnl_old) =
                                               // the normal to the yield surface, at the trial
                                               // stress
   returned_stress = 2.0 / 3.0 * nn * yieldStrength(returned_intnl);
   returned_stress.addIa(1.0 / 3.0 * trial_stress.trace());
   delta_dp = nn * dpm[0];
 
   return true;
 }

◆ useCustomCTO()

bool SolidMechanicsPlasticJ2::useCustomCTO ( ) const

overridevirtual

Returns false. You will want to override this in your derived class if you write a custom consistent tangent operator function.

Reimplemented from SolidMechanicsPlasticModel.

Definition at line 225 of file SolidMechanicsPlasticJ2.C.

 {
   return _use_custom_cto;
 }

◆ useCustomReturnMap()

bool SolidMechanicsPlasticJ2::useCustomReturnMap ( ) const

overridevirtual

Returns false. You will want to override this in your derived class if you write a custom returnMap function.

Reimplemented from SolidMechanicsPlasticModel.

Definition at line 219 of file SolidMechanicsPlasticJ2.C.

 {
   return _use_custom_returnMap;
 }

◆ validParams()

InputParameters SolidMechanicsPlasticJ2::validParams ( )

static

Definition at line 20 of file SolidMechanicsPlasticJ2.C.

Referenced by SolidMechanicsPlasticIsotropicSD::validParams().

 {
   InputParameters params = SolidMechanicsPlasticModel::validParams();
   params.addRequiredParam<UserObjectName>(
       "yield_strength",
       "A SolidMechanicsHardening UserObject that defines hardening of the yield strength");
   params.addRangeCheckedParam<unsigned>(
       "max_iterations", 10, "max_iterations>0", "Maximum iterations for custom J2 return map");
   params.addParam<bool>("use_custom_returnMap",
                         true,
                         "Whether to use the custom returnMap "
                         "algorithm.  Set to true if you are using "
                         "isotropic elasticity.");
   params.addParam<bool>("use_custom_cto",
                         true,
                         "Whether to use the custom consistent tangent "
                         "operator computations.  Set to true if you are "
                         "using isotropic elasticity.");
   params.addClassDescription("J2 plasticity, associative, with hardening");
 
   return params;
 }

◆ yieldFunction()

Real SolidMechanicsPlasticJ2::yieldFunction	(	const RankTwoTensor &	stress,
		Real	intnl
	)		const

overrideprotectedvirtual

The following functions are what you should override when building single-plasticity models.

The yield function

Parameters

stress	the stress at which to calculate the yield function
intnl	internal parameter

Returns: the yield function

Reimplemented from SolidMechanicsPlasticModel.

Reimplemented in SolidMechanicsPlasticIsotropicSD, and SolidMechanicsPlasticOrthotropic.

Definition at line 53 of file SolidMechanicsPlasticJ2.C.

Referenced by returnMap().

 {
   return std::sqrt(3.0 * stress.secondInvariant()) - yieldStrength(intnl);
 }

◆ yieldFunctionV()

void SolidMechanicsPlasticModel::yieldFunctionV	(	const RankTwoTensor &	stress,
		Real	intnl,
		std::vector< Real > &	f
	)		const

virtualinherited

Calculates the yield functions.

Note that for single-surface plasticity you don't want to override this - override the private yieldFunction below

Parameters

	stress	the stress at which to calculate the yield function
	intnl	internal parameter
[out]	f	the yield functions

Reimplemented in SolidMechanicsPlasticMohrCoulombMulti, and SolidMechanicsPlasticTensileMulti.

Definition at line 67 of file SolidMechanicsPlasticModel.C.

Referenced by SolidMechanicsPlasticModel::returnMap().

 {
   f.assign(1, yieldFunction(stress, intnl));
 }

◆ yieldStrength()

Real SolidMechanicsPlasticJ2::yieldStrength ( Real intnl ) const

protectedvirtual

YieldStrength.

The yield function is sqrt(3*J2) - yieldStrength. In this class yieldStrength = 1, but this may be over-ridden by derived classes with nontrivial hardning

Definition at line 106 of file SolidMechanicsPlasticJ2.C.

Referenced by returnMap(), SolidMechanicsPlasticOrthotropic::yieldFunction(), yieldFunction(), and SolidMechanicsPlasticIsotropicSD::yieldFunction().

 {
   return _strength.value(intnl);
 }

Member Data Documentation

◆ _f_tol

const Real SolidMechanicsPlasticModel::_f_tol

inherited

Tolerance on yield function.

Definition at line 170 of file SolidMechanicsPlasticModel.h.

◆ _ic_tol

const Real SolidMechanicsPlasticModel::_ic_tol

inherited

Tolerance on internal constraint.

Definition at line 173 of file SolidMechanicsPlasticModel.h.

◆ _max_iters

const unsigned SolidMechanicsPlasticJ2::_max_iters

private

max iters for custom return map loop

Definition at line 81 of file SolidMechanicsPlasticJ2.h.

Referenced by returnMap().

◆ _strength

const SolidMechanicsHardeningModel& SolidMechanicsPlasticJ2::_strength

private

yield strength, from user input

Definition at line 78 of file SolidMechanicsPlasticJ2.h.

Referenced by dyieldStrength(), and yieldStrength().

◆ _use_custom_cto

const bool SolidMechanicsPlasticJ2::_use_custom_cto

private

Whether to use the custom consistent tangent operator calculation.

Definition at line 87 of file SolidMechanicsPlasticJ2.h.

Referenced by consistentTangentOperator(), and useCustomCTO().

◆ _use_custom_returnMap

const bool SolidMechanicsPlasticJ2::_use_custom_returnMap

private

Whether to use the custom return-map algorithm.

Definition at line 84 of file SolidMechanicsPlasticJ2.h.

Referenced by returnMap(), and useCustomReturnMap().

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

solid_mechanics/include/userobjects/SolidMechanicsPlasticJ2.h
solid_mechanics/src/userobjects/SolidMechanicsPlasticJ2.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SolidMechanicsPlasticJ2()

Member Function Documentation

◆ activeConstraints()

◆ consistentTangentOperator()

◆ dflowPotential_dintnl()

◆ dflowPotential_dintnlV()

◆ dflowPotential_dstress()

◆ dflowPotential_dstressV()

◆ dhardPotential_dintnl()

◆ dhardPotential_dintnlV()

◆ dhardPotential_dstress()

◆ dhardPotential_dstressV()

◆ dyieldFunction_dintnl()

◆ dyieldFunction_dintnlV()

◆ dyieldFunction_dstress()

◆ dyieldFunction_dstressV()

◆ dyieldStrength()

◆ execute()

◆ finalize()

◆ flowPotential()

◆ flowPotentialV()

◆ hardPotential()

◆ hardPotentialV()

◆ initialize()

◆ KuhnTuckerSingleSurface()

◆ modelName()

◆ numberSurfaces()

◆ returnMap()

◆ useCustomCTO()

◆ useCustomReturnMap()

◆ validParams()

◆ yieldFunction()

◆ yieldFunctionV()

◆ yieldStrength()

Member Data Documentation

◆ _f_tol

◆ _ic_tol

◆ _max_iters

◆ _strength

◆ _use_custom_cto

◆ _use_custom_returnMap