ComputeInstantaneousThermalExpansionFunctionEigenstrain computes an eigenstrain for thermal expansion according to an instantaneous thermal expansion function. More...

#include <ComputeInstantaneousThermalExpansionFunctionEigenstrain.h>

Inheritance diagram for ComputeInstantaneousThermalExpansionFunctionEigenstrainTempl< is_ad >:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	ComputeInstantaneousThermalExpansionFunctionEigenstrainTempl (const InputParameters &parameters)

virtual void	subdomainSetup () final
	resize _temperature_buffer

virtual void	computeProperties () final
	update _temperature_buffer

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 void	initQpStatefulProperties () override

virtual ValueAndDerivative< is_ad >	computeThermalStrain () override
	computeThermalStrain must be overridden in derived classes.

Protected Attributes
const Function &	_thermal_expansion_function

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

const bool	_use_old_temperature
	lag temperature variable

const VariableValue &	_temperature_old
	previous time step temperature

MaterialProperty< RankTwoTensor > *	_deigenstrain_dT

const VariableValue &	_stress_free_temperature


GenericMaterialProperty< Real, is_ad > &	_thermal_strain
	Stores the thermal strain as a scalar for use in computing an incremental update.

const MaterialProperty< Real > &	_thermal_strain_old

bool &	_step_one
	Indicates whether we are on the first step, avoiding false positives when restarting.

Private Member Functions
bool	haveMaterialProperty (const std::string &prop_name)

std::vector< VariableName >	buildVariableVector (const VariableName &c1, const VariableName &c2, const VariableName &c3)

void	validateCouplingHelper (const MaterialPropertyName &base, const std::vector< VariableName > &c, const System &system, std::vector< VariableName > &missing)

bool	isNotObjectVariable (const VariableName &name)

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

const GenericVariableValue< is_ad > &	_temperature_prop
	current temperature

MaterialProperty< Real > *	_mean_thermal_expansion_coefficient
	mean coefficient of thermal expansion (for output verification)

FEProblemBase &	_dmi_fe_problem

Detailed Description

template<bool is_ad>
class ComputeInstantaneousThermalExpansionFunctionEigenstrainTempl< is_ad >

ComputeInstantaneousThermalExpansionFunctionEigenstrain computes an eigenstrain for thermal expansion according to an instantaneous thermal expansion function.

Definition at line 19 of file ComputeInstantaneousThermalExpansionFunctionEigenstrain.h.

Constructor & Destructor Documentation

◆ ComputeInstantaneousThermalExpansionFunctionEigenstrainTempl()

template<bool is_ad>

ComputeInstantaneousThermalExpansionFunctionEigenstrainTempl< is_ad >::ComputeInstantaneousThermalExpansionFunctionEigenstrainTempl ( const InputParameters & parameters )

Definition at line 34 of file ComputeInstantaneousThermalExpansionFunctionEigenstrain.C.

  : ComputeThermalExpansionEigenstrainBaseTempl<is_ad>(parameters),
    _thermal_expansion_function(this->getFunction("thermal_expansion_function")),
    _thermal_strain(this->template declareGenericProperty<Real, is_ad>(
        this->_base_name + "InstantaneousThermalExpansionFunction_thermal_strain")),
    _thermal_strain_old(this->template getMaterialPropertyOld<Real>(
        this->_base_name + "InstantaneousThermalExpansionFunction_thermal_strain")),
    _step_one(this->template declareRestartableData<bool>("step_one", true))
{
  if (this->_use_old_temperature)
    this->paramError("use_old_temperature",
                     "The old temperature value cannot be used in this incremental update model.");
}

Member Function Documentation

◆ computeProperties()

template<bool is_ad>

void ComputeThermalExpansionEigenstrainBaseTempl< is_ad >::computeProperties ( )

finalvirtualinherited

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

overridevirtualinherited

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>

ValueAndDerivative< is_ad > ComputeInstantaneousThermalExpansionFunctionEigenstrainTempl< is_ad >::computeThermalStrain ( )

overrideprotectedvirtual

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 (\delta L / L)

Implements ComputeThermalExpansionEigenstrainBaseTempl< is_ad >.

Definition at line 58 of file ComputeInstantaneousThermalExpansionFunctionEigenstrain.C.

{
  if (this->_t_step > 1)
    _step_one = false;
 
  const auto & old_temp =
      (_step_one ? this->_stress_free_temperature[_qp] : this->_temperature_old[_qp]);
  const auto delta_T = this->_temperature[_qp] - old_temp;
 
  const auto alpha_current_temp = _thermal_expansion_function.value(this->_temperature[_qp]);
  const auto alpha_old_temp = _thermal_expansion_function.value(old_temp);
 
  const auto thermal_strain =
      _thermal_strain_old[_qp] + delta_T * 0.5 * (alpha_current_temp + alpha_old_temp);
 
  // Store thermal strain for use in the next timestep (casts ValueAndDerivative<is_ad>
  // to GenericReal<is_ad>).
  _thermal_strain[_qp] = dual_number_cast<GenericReal<is_ad>>(thermal_strain);
 
  return thermal_strain;
}

◆ initQpStatefulProperties()

template<bool is_ad>

void ComputeInstantaneousThermalExpansionFunctionEigenstrainTempl< is_ad >::initQpStatefulProperties ( )

overrideprotectedvirtual

Definition at line 51 of file ComputeInstantaneousThermalExpansionFunctionEigenstrain.C.

{
  _thermal_strain[_qp] = 0;
}

◆ subdomainSetup()

template<bool is_ad>

void ComputeThermalExpansionEigenstrainBaseTempl< is_ad >::subdomainSetup ( )

finalvirtualinherited

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 ComputeInstantaneousThermalExpansionFunctionEigenstrainTempl< is_ad >::validParams ( )

static

Definition at line 20 of file ComputeInstantaneousThermalExpansionFunctionEigenstrain.C.

{
  InputParameters params = ComputeThermalExpansionEigenstrainBaseTempl<is_ad>::validParams();
  params.addClassDescription("Computes eigenstrain due to thermal expansion using a function that "
                             "describes the instantaneous thermal expansion as a function of "
                             "temperature");
  params.addRequiredParam<FunctionName>("thermal_expansion_function",
                                        "Function describing the instantaneous thermal expansion "
                                        "coefficient as a function of temperature");
  params.suppressParameter<bool>("use_old_temperature");
  return params;
}