ADComputeEigenstrain< compute_stage > Class Template Reference

ComputeEigenstrain computes an Eigenstrain that is a function of a single variable defined by a base tensor and a scalar function defined in a Derivative Material. More...

#include <ADComputeEigenstrain.h>

Inheritance diagram for ADComputeEigenstrain< compute_stage >:

Public Member Functions
	ADComputeEigenstrain (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual void	computeQpEigenstrain () override
	Compute the eigenstrain and store in _eigenstrain. More...
const	ADMaterialProperty (Real) &_prefactor
virtual void	initQpStatefulProperties () override
virtual void	computeQpProperties () override
	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
RankTwoTensor	_eigen_base_tensor
	usingComputeEigenstrainBaseMembers
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 ADComputeEigenstrain< compute_stage >

ComputeEigenstrain computes an Eigenstrain that is a function of a single variable defined by a base tensor and a scalar function defined in a Derivative Material.

Definition at line 17 of file ADComputeEigenstrain.h.

Constructor & Destructor Documentation

ADComputeEigenstrain()

template<ComputeStage compute_stage>

ADComputeEigenstrain< compute_stage >::ADComputeEigenstrain

(

const InputParameters &

parameters

)

Definition at line 32 of file ADComputeEigenstrain.C.

  : ADComputeEigenstrainBase<compute_stage>(parameters),
    _prefactor(getADMaterialProperty<Real>("prefactor"))
{
  _eigen_base_tensor.fillFromInputVector(getParam<std::vector<Real>>("eigen_base"));
}

Member Function Documentation

ADMaterialProperty() [1/2]

template<ComputeStage compute_stage>

ADComputeEigenstrainBase< compute_stage >::ADMaterialProperty ( RankTwoTensor  ) &

protectedinherited

Stores the current total eigenstrain.

ADMaterialProperty() [2/2]

template<ComputeStage compute_stage>

const ADComputeEigenstrain< compute_stage >::ADMaterialProperty ( Real  ) &

protected

computeQpEigenstrain()

template<ComputeStage compute_stage>

void ADComputeEigenstrain< compute_stage >::computeQpEigenstrain ( )

overrideprotectedvirtual

Compute the eigenstrain and store in _eigenstrain.

Implements ADComputeEigenstrainBase< compute_stage >.

Definition at line 41 of file ADComputeEigenstrain.C.

{
  // Define Eigenstrain
  _eigenstrain[_qp] = _eigen_base_tensor * _prefactor[_qp];
}

computeQpProperties()

template<ComputeStage compute_stage>

void ADComputeEigenstrainBase< compute_stage >::computeQpProperties ( )

overrideprotectedvirtualinherited

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

protectedinherited

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

overrideprotectedvirtualinherited

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 ADComputeEigenstrain< compute_stage >::validParams ( )

static

Definition at line 20 of file ADComputeEigenstrain.C.

{
  InputParameters params = ADComputeEigenstrainBase<compute_stage>::validParams();
  params.addClassDescription("Computes a constant Eigenstrain");
  params.addRequiredParam<std::vector<Real>>(
      "eigen_base", "Vector of values defining the constant base tensor for the Eigenstrain");
  params.addParam<MaterialPropertyName>(
      "prefactor", 1.0, "Name of material defining the variable dependence");
  return params;
}

Member Data Documentation

_base_name

template<ComputeStage compute_stage>

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

protectedinherited

Base name prepended to material property name.

Definition at line 50 of file ADComputeEigenstrainBase.h.

_eigen_base_tensor

template<ComputeStage compute_stage>

RankTwoTensor ADComputeEigenstrain< compute_stage >::_eigen_base_tensor

protected

Definition at line 38 of file ADComputeEigenstrain.h.

Referenced by ADComputeEigenstrain< compute_stage >::ADComputeEigenstrain().

_eigenstrain_name

template<ComputeStage compute_stage>

std::string ADComputeEigenstrainBase< compute_stage >::_eigenstrain_name

protectedinherited

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

protectedinherited

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

Definition at line 69 of file ADComputeEigenstrainBase.h.

usingComputeEigenstrainBaseMembers

template<ComputeStage compute_stage>

ADComputeEigenstrain< compute_stage >::usingComputeEigenstrainBaseMembers

protected

Definition at line 40 of file ADComputeEigenstrain.h.

usingMaterialMembers

template<ComputeStage compute_stage>

ADComputeEigenstrainBase< compute_stage >::usingMaterialMembers

protectedinherited

Definition at line 71 of file ADComputeEigenstrainBase.h.

---

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

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