Plastic Model base class The virtual functions written below must be over-ridden in derived classes to provide actual values. More...

#include <TensorMechanicsPlasticModel.h>

Inheritance diagram for TensorMechanicsPlasticModel:

[legend]

Public Member Functions
	TensorMechanicsPlasticModel (const InputParameters &parameters)

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

virtual std::string	modelName () const =0

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

virtual bool	useCustomCTO () const
	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
	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
	Calculates a custom consistent tangent operator. 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...

Static Public Member Functions
static InputParameters	validParams ()

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

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

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

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

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

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

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

virtual RankTwoTensor	dflowPotential_dintnl (const RankTwoTensor &stress, Real intnl) const
	The derivative of the flow potential with respect to the internal parameter. 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...

Detailed Description

Plastic Model base class The virtual functions written below must be over-ridden in derived classes to provide actual values.

It is assumed there is only one internal parameter, and that is a function of the plastic multiplier, with rate given by hardPotential

For better or worse, I have created two versions of all functions (eg yieldFunction, flowPotential, etc). This is so that for single-surface plasticity you can just override the 'protected' functions: Real yieldFunction(stress, intnl) (and similar), and don't have to worry about all the multi-surface stuff, since in multi-surface yieldFunction (etc) return std::vectors of stuff. In the case of multi-surface plasticity models you DO need to override the 'public' functions (with a 'V' in their name): void yieldFunctionV(stress, intnl, f) versions.

Definition at line 42 of file TensorMechanicsPlasticModel.h.

Constructor & Destructor Documentation

◆ TensorMechanicsPlasticModel()

TensorMechanicsPlasticModel::TensorMechanicsPlasticModel ( const InputParameters & parameters )

Definition at line 34 of file TensorMechanicsPlasticModel.C.

   : GeneralUserObject(parameters),
     _f_tol(getParam<Real>("yield_function_tolerance")),
     _ic_tol(getParam<Real>("internal_constraint_tolerance"))
 {
 }

Member Function Documentation

◆ activeConstraints()

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

virtual

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 TensorMechanicsPlasticMohrCoulombMulti, TensorMechanicsPlasticTensileMulti, TensorMechanicsPlasticMeanCapTC, TensorMechanicsPlasticWeakPlaneShear, and TensorMechanicsPlasticWeakPlaneTensile.

Definition at line 188 of file TensorMechanicsPlasticModel.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 TensorMechanicsPlasticModel::consistentTangentOperator	(	const RankTwoTensor &	trial_stress,
		Real	intnl_old,
		const RankTwoTensor &	stress,
		Real	intnl,
		const RankFourTensor &	E_ijkl,
		const std::vector< Real > &	cumulative_pm
	)		const

virtual

Calculates a custom consistent tangent operator.

You may choose to over-ride this in your derived TensorMechanicsPlasticXXXX 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 in TensorMechanicsPlasticTensileMulti, TensorMechanicsPlasticDruckerPragerHyperbolic, TensorMechanicsPlasticMeanCapTC, and TensorMechanicsPlasticJ2.

Definition at line 254 of file TensorMechanicsPlasticModel.C.

 {
   return E_ijkl;
 }

Referenced by TensorMechanicsPlasticJ2::consistentTangentOperator(), TensorMechanicsPlasticDruckerPragerHyperbolic::consistentTangentOperator(), TensorMechanicsPlasticMeanCapTC::consistentTangentOperator(), and TensorMechanicsPlasticTensileMulti::consistentTangentOperator().

◆ dflowPotential_dintnl()

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

protectedvirtual

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 in TensorMechanicsPlasticMeanCapTC, TensorMechanicsPlasticDruckerPrager, TensorMechanicsPlasticJ2, TensorMechanicsPlasticWeakPlaneShear, TensorMechanicsPlasticWeakPlaneTensile, TensorMechanicsPlasticMohrCoulomb, TensorMechanicsPlasticTensile, TensorMechanicsPlasticMeanCap, TensorMechanicsPlasticSimpleTester, and TensorMechanicsPlasticWeakPlaneTensileN.

Definition at line 133 of file TensorMechanicsPlasticModel.C.

 {
   return RankTwoTensor();
 }

Referenced by dflowPotential_dintnlV().

◆ dflowPotential_dintnlV()

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

virtual

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 TensorMechanicsPlasticMohrCoulombMulti, and TensorMechanicsPlasticTensileMulti.

Definition at line 139 of file TensorMechanicsPlasticModel.C.

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

◆ dflowPotential_dstress()

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

protectedvirtual

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 in TensorMechanicsPlasticMeanCapTC, TensorMechanicsPlasticDruckerPrager, TensorMechanicsPlasticIsotropicSD, TensorMechanicsPlasticJ2, TensorMechanicsPlasticWeakPlaneShear, TensorMechanicsPlasticOrthotropic, TensorMechanicsPlasticWeakPlaneTensile, TensorMechanicsPlasticMohrCoulomb, TensorMechanicsPlasticTensile, TensorMechanicsPlasticMeanCap, TensorMechanicsPlasticSimpleTester, TensorMechanicsPlasticDruckerPragerHyperbolic, and TensorMechanicsPlasticWeakPlaneTensileN.

Definition at line 119 of file TensorMechanicsPlasticModel.C.

 {
   return RankFourTensor();
 }

Referenced by dflowPotential_dstressV().

◆ dflowPotential_dstressV()

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

virtual

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 TensorMechanicsPlasticMohrCoulombMulti, and TensorMechanicsPlasticTensileMulti.

Definition at line 125 of file TensorMechanicsPlasticModel.C.

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

◆ dhardPotential_dintnl()

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

protectedvirtual

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

Definition at line 174 of file TensorMechanicsPlasticModel.C.

 {
   return 0.0;
 }

Referenced by dhardPotential_dintnlV().

◆ dhardPotential_dintnlV()

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

virtual

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 180 of file TensorMechanicsPlasticModel.C.

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

◆ dhardPotential_dstress()

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

protectedvirtual

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

Definition at line 160 of file TensorMechanicsPlasticModel.C.

 {
   return RankTwoTensor();
 }

Referenced by dhardPotential_dstressV().

◆ dhardPotential_dstressV()

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

virtual

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 166 of file TensorMechanicsPlasticModel.C.

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

◆ dyieldFunction_dintnl()

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

protectedvirtual

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 in TensorMechanicsPlasticMeanCapTC, TensorMechanicsPlasticDruckerPrager, TensorMechanicsPlasticJ2, TensorMechanicsPlasticWeakPlaneShear, TensorMechanicsPlasticWeakPlaneTensile, TensorMechanicsPlasticMohrCoulomb, TensorMechanicsPlasticTensile, TensorMechanicsPlasticMeanCap, TensorMechanicsPlasticSimpleTester, and TensorMechanicsPlasticWeakPlaneTensileN.

Definition at line 92 of file TensorMechanicsPlasticModel.C.

 {
   return 0.0;
 }

Referenced by dyieldFunction_dintnlV().

◆ dyieldFunction_dintnlV()

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

virtual

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 TensorMechanicsPlasticMohrCoulombMulti, and TensorMechanicsPlasticTensileMulti.

Definition at line 98 of file TensorMechanicsPlasticModel.C.

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

◆ dyieldFunction_dstress()

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

protectedvirtual

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 in TensorMechanicsPlasticMeanCapTC, TensorMechanicsPlasticIsotropicSD, TensorMechanicsPlasticDruckerPrager, TensorMechanicsPlasticJ2, TensorMechanicsPlasticOrthotropic, TensorMechanicsPlasticWeakPlaneShear, TensorMechanicsPlasticWeakPlaneTensile, TensorMechanicsPlasticMohrCoulomb, TensorMechanicsPlasticTensile, TensorMechanicsPlasticMeanCap, TensorMechanicsPlasticSimpleTester, and TensorMechanicsPlasticWeakPlaneTensileN.

Definition at line 77 of file TensorMechanicsPlasticModel.C.

 {
   return RankTwoTensor();
 }

Referenced by dyieldFunction_dstressV().

◆ dyieldFunction_dstressV()

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

virtual

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 TensorMechanicsPlasticMohrCoulombMulti, and TensorMechanicsPlasticTensileMulti.

Definition at line 84 of file TensorMechanicsPlasticModel.C.

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

◆ execute()

void TensorMechanicsPlasticModel::execute ( )

Definition at line 47 of file TensorMechanicsPlasticModel.C.

48 {

49 }

◆ finalize()

void TensorMechanicsPlasticModel::finalize ( )

Definition at line 52 of file TensorMechanicsPlasticModel.C.

53 {

54 }

◆ flowPotential()

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

protectedvirtual

The flow potential.

Parameters

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

Returns: the flow potential

Reimplemented in TensorMechanicsPlasticMeanCapTC, TensorMechanicsPlasticIsotropicSD, TensorMechanicsPlasticDruckerPrager, TensorMechanicsPlasticJ2, TensorMechanicsPlasticOrthotropic, TensorMechanicsPlasticWeakPlaneShear, TensorMechanicsPlasticWeakPlaneTensile, TensorMechanicsPlasticMohrCoulomb, TensorMechanicsPlasticTensile, TensorMechanicsPlasticMeanCap, TensorMechanicsPlasticSimpleTester, and TensorMechanicsPlasticWeakPlaneTensileN.

Definition at line 106 of file TensorMechanicsPlasticModel.C.

 {
   return RankTwoTensor();
 }

Referenced by flowPotentialV().

◆ flowPotentialV()

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

virtual

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 TensorMechanicsPlasticMohrCoulombMulti, and TensorMechanicsPlasticTensileMulti.

Definition at line 111 of file TensorMechanicsPlasticModel.C.

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

◆ hardPotential()

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

protectedvirtual

The hardening potential.

Parameters

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

Returns: the hardening potential

Reimplemented in TensorMechanicsPlasticMeanCapTC.

Definition at line 147 of file TensorMechanicsPlasticModel.C.

 {
   return -1.0;
 }

Referenced by hardPotentialV().

◆ hardPotentialV()

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

virtual

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 152 of file TensorMechanicsPlasticModel.C.

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

◆ initialize()

void TensorMechanicsPlasticModel::initialize ( )

Definition at line 42 of file TensorMechanicsPlasticModel.C.

43 {

44 }

◆ KuhnTuckerSingleSurface()

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

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 248 of file TensorMechanicsPlasticModel.C.

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

Referenced by TensorMechanicsPlasticMohrCoulombMulti::KuhnTuckerOK(), TensorMechanicsPlasticTensileMulti::KuhnTuckerOK(), and returnMap().

◆ modelName()

std::string TensorMechanicsPlasticModel::modelName ( ) const

pure virtual

Implemented in TensorMechanicsPlasticMeanCapTC, TensorMechanicsPlasticMohrCoulombMulti, TensorMechanicsPlasticTensileMulti, TensorMechanicsPlasticMohrCoulomb, TensorMechanicsPlasticTensile, TensorMechanicsPlasticWeakPlaneShear, TensorMechanicsPlasticWeakPlaneTensile, TensorMechanicsPlasticDruckerPrager, TensorMechanicsPlasticMeanCap, TensorMechanicsPlasticDruckerPragerHyperbolic, TensorMechanicsPlasticSimpleTester, TensorMechanicsPlasticJ2, and TensorMechanicsPlasticWeakPlaneTensileN.

Definition at line 203 of file TensorMechanicsPlasticModel.C.

 {
   return "None";
 }

◆ numberSurfaces()

unsigned TensorMechanicsPlasticModel::numberSurfaces ( ) const

virtual

The number of yield surfaces for this plasticity model.

Reimplemented in TensorMechanicsPlasticMohrCoulombMulti, and TensorMechanicsPlasticTensileMulti.

Definition at line 57 of file TensorMechanicsPlasticModel.C.

 {
   return 1;
 }

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

◆ returnMap()

bool TensorMechanicsPlasticModel::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

virtual

Performs a custom return-map.

You may choose to over-ride this in your derived TensorMechanicsPlasticXXXX 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 in TensorMechanicsPlasticTensileMulti, TensorMechanicsPlasticMohrCoulombMulti, TensorMechanicsPlasticDruckerPragerHyperbolic, TensorMechanicsPlasticMeanCapTC, and TensorMechanicsPlasticJ2.

Definition at line 221 of file TensorMechanicsPlasticModel.C.

 {
   trial_stress_inadmissible = false;
   yieldFunctionV(trial_stress, intnl_old, yf);
  
   for (unsigned sf = 0; sf < numberSurfaces(); ++sf)
     if (yf[sf] > _f_tol)
       trial_stress_inadmissible = true;
  
   // example of checking Kuhn-Tucker
   std::vector<Real> dpm(numberSurfaces(), 0);
   for (unsigned sf = 0; sf < numberSurfaces(); ++sf)
     if (!KuhnTuckerSingleSurface(yf[sf], dpm[sf], 0))
       return false;
   return true;
 }

Referenced by TensorMechanicsPlasticJ2::returnMap(), TensorMechanicsPlasticDruckerPragerHyperbolic::returnMap(), TensorMechanicsPlasticMeanCapTC::returnMap(), TensorMechanicsPlasticMohrCoulombMulti::returnMap(), and TensorMechanicsPlasticTensileMulti::returnMap().

◆ useCustomCTO()

bool TensorMechanicsPlasticModel::useCustomCTO ( ) const

virtual

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

Reimplemented in TensorMechanicsPlasticTensileMulti, TensorMechanicsPlasticMeanCapTC, TensorMechanicsPlasticDruckerPragerHyperbolic, and TensorMechanicsPlasticJ2.

Definition at line 215 of file TensorMechanicsPlasticModel.C.

 {
   return false;
 }

◆ useCustomReturnMap()

bool TensorMechanicsPlasticModel::useCustomReturnMap ( ) const

virtual

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

Reimplemented in TensorMechanicsPlasticMohrCoulombMulti, TensorMechanicsPlasticTensileMulti, TensorMechanicsPlasticMeanCapTC, TensorMechanicsPlasticDruckerPragerHyperbolic, and TensorMechanicsPlasticJ2.

Definition at line 209 of file TensorMechanicsPlasticModel.C.

 {
   return false;
 }

◆ validParams()

InputParameters TensorMechanicsPlasticModel::validParams ( )

static

Definition at line 18 of file TensorMechanicsPlasticModel.C.

 {
   InputParameters params = GeneralUserObject::validParams();
   params.addRequiredRangeCheckedParam<Real>("yield_function_tolerance",
                                             "yield_function_tolerance>0",
                                             "If the yield function is less than this amount, the "
                                             "(stress, internal parameter) are deemed admissible.");
   params.addRequiredRangeCheckedParam<Real>("internal_constraint_tolerance",
                                             "internal_constraint_tolerance>0",
                                             "The Newton-Raphson process is only deemed converged "
                                             "if the internal constraint is less than this.");
   params.addClassDescription(
       "Plastic Model base class.  Override the virtual functions in your class");
   return params;
 }

◆ yieldFunction()

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

protectedvirtual

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 in TensorMechanicsPlasticMeanCapTC, TensorMechanicsPlasticIsotropicSD, TensorMechanicsPlasticDruckerPrager, TensorMechanicsPlasticJ2, TensorMechanicsPlasticOrthotropic, TensorMechanicsPlasticWeakPlaneShear, TensorMechanicsPlasticWeakPlaneTensile, TensorMechanicsPlasticMohrCoulomb, TensorMechanicsPlasticTensile, TensorMechanicsPlasticDruckerPragerHyperbolic, TensorMechanicsPlasticMeanCap, TensorMechanicsPlasticSimpleTester, and TensorMechanicsPlasticWeakPlaneTensileN.

Definition at line 63 of file TensorMechanicsPlasticModel.C.

 {
   return 0.0;
 }

Referenced by yieldFunctionV().

◆ yieldFunctionV()

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

virtual

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 TensorMechanicsPlasticMohrCoulombMulti, and TensorMechanicsPlasticTensileMulti.

Definition at line 69 of file TensorMechanicsPlasticModel.C.

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

Referenced by returnMap().

Member Data Documentation

◆ _f_tol

const Real TensorMechanicsPlasticModel::_f_tol

Tolerance on yield function.

Definition at line 175 of file TensorMechanicsPlasticModel.h.

◆ _ic_tol

const Real TensorMechanicsPlasticModel::_ic_tol

Tolerance on internal constraint.

Definition at line 178 of file TensorMechanicsPlasticModel.h.

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

tensor_mechanics/include/userobjects/TensorMechanicsPlasticModel.h
tensor_mechanics/src/userobjects/TensorMechanicsPlasticModel.C

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TensorMechanicsPlasticModel()

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

◆ execute()

◆ finalize()

◆ flowPotential()

◆ flowPotentialV()

◆ hardPotential()

◆ hardPotentialV()

◆ initialize()

◆ KuhnTuckerSingleSurface()

◆ modelName()

◆ numberSurfaces()

◆ returnMap()

◆ useCustomCTO()

◆ useCustomReturnMap()

◆ validParams()

◆ yieldFunction()

◆ yieldFunctionV()

Member Data Documentation

◆ _f_tol

◆ _ic_tol