ADComputeEigenstrainBase< compute_stage > Class Template Reference

ADComputeEigenstrainBase is the base class for eigenstrain tensors. More...

#include <ADComputeEigenstrainBase.h>

Inheritance diagram for ADComputeEigenstrainBase< compute_stage >:

Public Member Functions
	ADComputeEigenstrainBase (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual void	initQpStatefulProperties () override
virtual void	computeQpProperties () override
virtual void	computeQpEigenstrain ()=0
	Compute the eigenstrain and store in _eigenstrain. More...
	ADMaterialProperty (RankTwoTensor) &_eigenstrain
	Stores the current total eigenstrain. More...
ADReal	computeVolumetricStrainComponent (const ADReal volumetric_strain) const
	Helper function for models that compute the eigenstrain based on a volumetric strain. More...

Protected Attributes
const std::string	_base_name
	Base name prepended to material property name. More...
std::string	_eigenstrain_name
	Material property name for the eigenstrain tensor. More...
bool &	_step_zero
	Restartable data to check for the zeroth and first time steps for thermal calculations. More...
	usingMaterialMembers

Detailed Description

template<ComputeStage compute_stage>
class ADComputeEigenstrainBase< compute_stage >

ADComputeEigenstrainBase is the base class for eigenstrain tensors.

Definition at line 21 of file ADComputeEigenstrainBase.h.

Constructor & Destructor Documentation

ADComputeEigenstrainBase()

template<ComputeStage compute_stage>

ADComputeEigenstrainBase< compute_stage >::ADComputeEigenstrainBase

(

const InputParameters &

parameters

)

Definition at line 38 of file ADComputeEigenstrainBase.C.

  : ADMaterial<compute_stage>(parameters),
    _base_name(isParamValid("base_name") ? getParam<std::string>("base_name") + "_" : ""),
    _eigenstrain_name(_base_name + getParam<std::string>("eigenstrain_name")),
    _eigenstrain(declareADProperty<RankTwoTensor>(_eigenstrain_name)),
    _step_zero(declareRestartableData<bool>("step_zero", true))
{
}

Member Function Documentation

ADMaterialProperty()

template<ComputeStage compute_stage>

ADComputeEigenstrainBase< compute_stage >::ADMaterialProperty ( RankTwoTensor  ) &

protected

Stores the current total eigenstrain.

computeQpEigenstrain()

template<ComputeStage compute_stage>

virtual void ADComputeEigenstrainBase< compute_stage >::computeQpEigenstrain ( )

protectedpure virtual

Compute the eigenstrain and store in _eigenstrain.

Implemented in ADComputeThermalExpansionEigenstrainBase< compute_stage >, and ADComputeEigenstrain< compute_stage >.

computeQpProperties()

template<ComputeStage compute_stage>

void ADComputeEigenstrainBase< compute_stage >::computeQpProperties ( )

overrideprotectedvirtual

Definition at line 59 of file ADComputeEigenstrainBase.C.

{
  if (_t_step >= 1)
    _step_zero = false;
 
  // Skip the eigenstrain calculation in step zero because no solution is computed during
  // the zeroth step, hence computing the eigenstrain in the zeroth step would result in
  // an incorrect calculation of mechanical_strain, which is stateful.
  if (!_step_zero)
    computeQpEigenstrain();
}

computeVolumetricStrainComponent()

template<ComputeStage compute_stage>

ADReal ADComputeEigenstrainBase< compute_stage >::computeVolumetricStrainComponent ( const ADReal  volumetric_strain ) const

protected

Helper function for models that compute the eigenstrain based on a volumetric strain.

This function computes the diagonal components of the eigenstrain tensor as logarithmic strains.

Parameters

volumetric_strain

The current volumetric strain to be applied

Returns

Current strain in one direction due to volumetric strain, expressed as a logarithmic strain

Definition at line 73 of file ADComputeEigenstrainBase.C.

{
  // The engineering strain in a given direction is:
  // epsilon_eng = cbrt(volumetric_strain + 1.0) - 1.0
  //
  // We need to provide this as a logarithmic strain to be consistent with the strain measure
  // used for finite strain:
  // epsilon_log = log(1.0 + epsilon_eng)
  //
  // This can be simplified down to a more direct form:
  // epsilon_log = log(cbrt(volumetric_strain + 1.0))
  // or:
  // epsilon_log = (1/3) log(volumetric_strain + 1.0)
 
  return std::log(volumetric_strain + 1.0) / 3.0;
}

initQpStatefulProperties()

template<ComputeStage compute_stage>

void ADComputeEigenstrainBase< compute_stage >::initQpStatefulProperties ( )

overrideprotectedvirtual

Reimplemented in ADComputeInstantaneousThermalExpansionFunctionEigenstrain< compute_stage >.

Definition at line 50 of file ADComputeEigenstrainBase.C.

{
  // This property can be promoted to be stateful by other models that use it,
  // so it needs to be initalized.
  _eigenstrain[_qp].zero();
}

validParams()

template<ComputeStage compute_stage>

InputParameters ADComputeEigenstrainBase< compute_stage >::validParams ( )

static

Definition at line 18 of file ADComputeEigenstrainBase.C.

{
  InputParameters params = ADMaterial<compute_stage>::validParams();
  params.addParam<std::string>("base_name",
                               "Optional parameter that allows the user to define "
                               "multiple mechanics material systems on the same "
                               "block, i.e. for multiple phases");
  params.addRequiredParam<std::string>("eigenstrain_name",
                                       "Material property name for the eigenstrain tensor computed "
                                       "by this model. IMPORTANT: The name of this property must "
                                       "also be provided to the strain calculator.");
  params.addDeprecatedParam<bool>(
      "incremental_form",
      false,
      "Should the eigenstrain be in incremental form (for incremental models)?",
      "This parameter no longer has any effect. Simply remove it.");
  return params;
}

Referenced by ADComputeEigenstrain< compute_stage >::validParams(), and ADComputeThermalExpansionEigenstrainBase< compute_stage >::validParams().

Member Data Documentation

_base_name

template<ComputeStage compute_stage>

const std::string ADComputeEigenstrainBase< compute_stage >::_base_name

protected

Base name prepended to material property name.

Definition at line 50 of file ADComputeEigenstrainBase.h.

_eigenstrain_name

template<ComputeStage compute_stage>

std::string ADComputeEigenstrainBase< compute_stage >::_eigenstrain_name

protected

Material property name for the eigenstrain tensor.

Definition at line 53 of file ADComputeEigenstrainBase.h.

_step_zero

template<ComputeStage compute_stage>

bool& ADComputeEigenstrainBase< compute_stage >::_step_zero

protected

Restartable data to check for the zeroth and first time steps for thermal calculations.

Definition at line 69 of file ADComputeEigenstrainBase.h.

usingMaterialMembers

template<ComputeStage compute_stage>

ADComputeEigenstrainBase< compute_stage >::usingMaterialMembers

protected

Definition at line 71 of file ADComputeEigenstrainBase.h.

---

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

• tensor_mechanics/include/materials/ADComputeEigenstrainBase.h
• tensor_mechanics/src/materials/ADComputeEigenstrainBase.C