ComputeThermalExpansionEigenstrainBaseTempl< is_ad > Class Template Reference

ComputeThermalExpansionEigenstrainBase is a base class for all models that compute eigenstrains due to thermal expansion of a material. More...

#include <ComputeThermalExpansionEigenstrainBase.h>

Inheritance diagram for ComputeThermalExpansionEigenstrainBaseTempl< is_ad >:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	ComputeThermalExpansionEigenstrainBaseTempl (const InputParameters &parameters)
virtual void	subdomainSetup () final
	resize _temperature_buffer More...
virtual void	computeProperties () final
	update _temperature_buffer More...
virtual void	computeQpEigenstrain () override
const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialProperty (const std::string &name)
const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialPropertyByName (const std::string &name)
void	validateDerivativeMaterialPropertyBase (const std::string &base)
const MaterialPropertyName	derivativePropertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
const MaterialPropertyName	derivativePropertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
const MaterialPropertyName	derivativePropertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
const MaterialPropertyName	derivativePropertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)
void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)
void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual ValueAndDerivative< is_ad >	computeThermalStrain ()=0
	computeThermalStrain must be overridden in derived classes. More...

Protected Attributes
const std::vector< ValueAndDerivative< is_ad > > &	_temperature
	Temperature to use in the eigenstrain calculation (current value if _use_old_temperature=false, old value if _use_old_temperature=true). More...
const bool	_use_old_temperature
	lag temperature variable More...
const VariableValue &	_temperature_old
	previous time step temperature More...
MaterialProperty< RankTwoTensor > *	_deigenstrain_dT
const VariableValue &	_stress_free_temperature

Private Attributes
std::vector< ValueAndDerivative< is_ad > >	_temperature_buffer
	Temperature used in the eigenstrain calculation (current value if _use_old_temperature=false, old value if _use_old_temperature=true). More...
const GenericVariableValue< is_ad > &	_temperature_prop
	current temperature More...
MaterialProperty< Real > *	_mean_thermal_expansion_coefficient
	mean coefficient of thermal expansion (for output verification) More...

Detailed Description

template<bool is_ad>
class ComputeThermalExpansionEigenstrainBaseTempl< is_ad >

ComputeThermalExpansionEigenstrainBase is a base class for all models that compute eigenstrains due to thermal expansion of a material.

Definition at line 26 of file ComputeThermalExpansionEigenstrainBase.h.

Constructor & Destructor Documentation

ComputeThermalExpansionEigenstrainBaseTempl()

template<bool is_ad>

ComputeThermalExpansionEigenstrainBaseTempl< is_ad >::ComputeThermalExpansionEigenstrainBaseTempl

(

const InputParameters &

parameters

)

Definition at line 32 of file ComputeThermalExpansionEigenstrainBase.C.

  : DerivativeMaterialInterface<ComputeEigenstrainBaseTempl<is_ad>>(parameters),
    _temperature(_temperature_buffer),
    _use_old_temperature(this->template getParam<bool>("use_old_temperature")),
    _temperature_old(this->_fe_problem.isTransient() ? this->coupledValueOld("temperature")
                                                     : this->_zero),
    _deigenstrain_dT((is_ad || this->isCoupledConstant("temperature"))
                         ? nullptr
                         : &this->template declarePropertyDerivative<RankTwoTensor>(
                               _eigenstrain_name, this->coupledName("temperature"))),
    _stress_free_temperature(this->coupledValue("stress_free_temperature")),
    _temperature_prop(this->template coupledGenericValue<is_ad>("temperature")),
    _mean_thermal_expansion_coefficient(
        this->isParamValid("mean_thermal_expansion_coefficient_name")
            ? &this->template declareProperty<Real>(this->template getParam<MaterialPropertyName>(
                  "mean_thermal_expansion_coefficient_name"))
            : nullptr)
{
  if (_use_old_temperature && !this->_fe_problem.isTransient())
    this->paramError(
        "use_old_temperature",
        "The old state of the temperature variable is only available in a transient simulation.");
}

Member Function Documentation

computeProperties()

template<bool is_ad>

void ComputeThermalExpansionEigenstrainBaseTempl< is_ad >::computeProperties ( )

finalvirtual

update _temperature_buffer

Definition at line 71 of file ComputeThermalExpansionEigenstrainBase.C.

{
  // we need to convert the temperature variable to a ChainedReal in the is_ad == false case
  for (_qp = 0; _qp < this->_qrule->n_points(); ++_qp)
    if constexpr (is_ad)
      _temperature_buffer[_qp] =
          _use_old_temperature ? _temperature_old[_qp] : _temperature_prop[_qp];
    else
    {
      if (_use_old_temperature)
        _temperature_buffer[_qp] = {_temperature_old[_qp], 0};
      else
        _temperature_buffer[_qp] = {_temperature_prop[_qp], 1};
    }

  ComputeEigenstrainBaseTempl<is_ad>::computeProperties();
}

computeQpEigenstrain()

template<bool is_ad>

void ComputeThermalExpansionEigenstrainBaseTempl< is_ad >::computeQpEigenstrain ( )

overridevirtual

Definition at line 91 of file ComputeThermalExpansionEigenstrainBase.C.

{
  _eigenstrain[_qp].zero();
  const auto thermal_strain = computeThermalStrain();

  if constexpr (is_ad)
  {
    _eigenstrain[_qp].addIa(thermal_strain);
    if (_mean_thermal_expansion_coefficient)
    {
      if (_temperature[_qp] == _stress_free_temperature[_qp])
        (*_mean_thermal_expansion_coefficient)[_qp] = 0.0;
      else
        (*_mean_thermal_expansion_coefficient)[_qp] = MetaPhysicL::raw_value(
            thermal_strain / (_temperature[_qp] - _stress_free_temperature[_qp]));
    }
  }
  else
  {
    _eigenstrain[_qp].addIa(thermal_strain.value());
    if (_mean_thermal_expansion_coefficient)
    {
      if (_temperature[_qp].value() == _stress_free_temperature[_qp])
        (*_mean_thermal_expansion_coefficient)[_qp] = 0.0;
      else
        (*_mean_thermal_expansion_coefficient)[_qp] =
            thermal_strain.value() / (_temperature[_qp].value() - _stress_free_temperature[_qp]);
    }
    if (_deigenstrain_dT)
    {
      (*_deigenstrain_dT)[_qp].zero();
      if (!_use_old_temperature)
        (*_deigenstrain_dT)[_qp].addIa(thermal_strain.derivatives());
    }
  }
}

computeThermalStrain()

template<bool is_ad>

virtual ValueAndDerivative<is_ad> ComputeThermalExpansionEigenstrainBaseTempl< is_ad >::computeThermalStrain ( )

protectedpure virtual

computeThermalStrain must be overridden in derived classes.

The return type ValueAndDerivative<is_ad> contains the value for the thermal strain and its temperature derivative. Derived classes should use _temperature[_qp] to obtain the current temperature. In the is_ad == false case that member variable is agumented and will be of the type ChainedReal. I.e. even with is_ad == false a variant of forward mode automatic differentiation will be used internally to compute the thermal strain and no manual implementation of the temperature derivative is needed.

Returns

thermal strain and its derivative, where the thermal strain is the linear thermal strain ( L / L)

Implemented in ComputeMeanThermalExpansionEigenstrainBaseTempl< is_ad >, ComputeInstantaneousThermalExpansionFunctionEigenstrainTempl< is_ad >, ComputeDilatationThermalExpansionEigenstrainBaseTempl< is_ad >, and ComputeThermalExpansionEigenstrainTempl< is_ad >.

subdomainSetup()

template<bool is_ad>

void ComputeThermalExpansionEigenstrainBaseTempl< is_ad >::subdomainSetup ( )

finalvirtual

resize _temperature_buffer

Definition at line 59 of file ComputeThermalExpansionEigenstrainBase.C.

{
  // call parent class subdomain setup, which ultimately calls Material::subdomainSetup()
  ComputeEigenstrainBaseTempl<is_ad>::subdomainSetup();

  // make sure we have enouch space to hold the augmented temperature values
  const auto nqp = this->_fe_problem.getMaxQps();
  _temperature_buffer.resize(nqp);
}

validParams()

template<bool is_ad>

InputParameters ComputeThermalExpansionEigenstrainBaseTempl< is_ad >::validParams ( )

static

Definition at line 15 of file ComputeThermalExpansionEigenstrainBase.C.

Referenced by ComputeInstantaneousThermalExpansionFunctionEigenstrainTempl< is_ad >::validParams(), ComputeThermalExpansionEigenstrainTempl< is_ad >::validParams(), ComputeDilatationThermalExpansionEigenstrainBaseTempl< is_ad >::validParams(), and ComputeMeanThermalExpansionEigenstrainBaseTempl< is_ad >::validParams().

{
  InputParameters params = ComputeEigenstrainBaseTempl<is_ad>::validParams();
  params.addCoupledVar("temperature", "Coupled temperature");
  params.addRequiredCoupledVar("stress_free_temperature",
                               "Reference temperature at which there is no "
                               "thermal expansion for thermal eigenstrain "
                               "calculation");
  params.addParam<bool>("use_old_temperature",
                        false,
                        "Flag to optionally use the temperature value from the previous timestep.");
  params.addParam<MaterialPropertyName>("mean_thermal_expansion_coefficient_name",
                                        "Name of the mean coefficient of thermal expansion.");
  return params;
}

Member Data Documentation

_deigenstrain_dT

template<bool is_ad>

MaterialProperty<RankTwoTensor>* ComputeThermalExpansionEigenstrainBaseTempl< is_ad >::_deigenstrain_dT

protected

Definition at line 72 of file ComputeThermalExpansionEigenstrainBase.h.

_mean_thermal_expansion_coefficient

template<bool is_ad>

MaterialProperty<Real>* ComputeThermalExpansionEigenstrainBaseTempl< is_ad >::_mean_thermal_expansion_coefficient

private

mean coefficient of thermal expansion (for output verification)

Definition at line 91 of file ComputeThermalExpansionEigenstrainBase.h.

_stress_free_temperature

template<bool is_ad>

const VariableValue& ComputeThermalExpansionEigenstrainBaseTempl< is_ad >::_stress_free_temperature

protected

Definition at line 74 of file ComputeThermalExpansionEigenstrainBase.h.

_temperature

template<bool is_ad>

const std::vector<ValueAndDerivative<is_ad> >& ComputeThermalExpansionEigenstrainBaseTempl< is_ad >::_temperature

protected

Temperature to use in the eigenstrain calculation (current value if _use_old_temperature=false, old value if _use_old_temperature=true).

We use a const reference to a private member here to prevent derived classes from accidentally overwriting any values.

Definition at line 63 of file ComputeThermalExpansionEigenstrainBase.h.

_temperature_buffer

template<bool is_ad>

std::vector<ValueAndDerivative<is_ad> > ComputeThermalExpansionEigenstrainBaseTempl< is_ad >::_temperature_buffer

private

Temperature used in the eigenstrain calculation (current value if _use_old_temperature=false, old value if _use_old_temperature=true).

Definition at line 85 of file ComputeThermalExpansionEigenstrainBase.h.

_temperature_old

template<bool is_ad>

const VariableValue& ComputeThermalExpansionEigenstrainBaseTempl< is_ad >::_temperature_old

protected

previous time step temperature

Definition at line 69 of file ComputeThermalExpansionEigenstrainBase.h.

_temperature_prop

template<bool is_ad>

const GenericVariableValue<is_ad>& ComputeThermalExpansionEigenstrainBaseTempl< is_ad >::_temperature_prop

private

current temperature

Definition at line 88 of file ComputeThermalExpansionEigenstrainBase.h.

_use_old_temperature

template<bool is_ad>

const bool ComputeThermalExpansionEigenstrainBaseTempl< is_ad >::_use_old_temperature

protected

lag temperature variable

Definition at line 66 of file ComputeThermalExpansionEigenstrainBase.h.

Referenced by ComputeInstantaneousThermalExpansionFunctionEigenstrainTempl< is_ad >::ComputeInstantaneousThermalExpansionFunctionEigenstrainTempl(), and ComputeThermalExpansionEigenstrainBaseTempl< is_ad >::ComputeThermalExpansionEigenstrainBaseTempl().

---

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

• solid_mechanics/include/materials/ComputeThermalExpansionEigenstrainBase.h
• solid_mechanics/src/materials/ComputeThermalExpansionEigenstrainBase.C