ChangedVariableTimeDerivative Class Reference

This calculates the time derivative for a variable multiplied by a generalized susceptibility. More...

#include <ChangedVariableTimeDerivative.h>

Inheritance diagram for ChangedVariableTimeDerivative:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	ChangedVariableTimeDerivative (const InputParameters &parameters)
virtual void	initialSetup ()
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 Real	computeQpResidual ()
virtual Real	computeQpJacobian ()
virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

Protected Attributes
const MaterialProperty< Real > &	_dopdu
	Order parameter derivative. More...
const MaterialProperty< Real > &	_d2opdu2
	2nd order parameter derivative More...
std::vector< const MaterialProperty< Real > * >	_d2opdudarg
	2nd order parameter derivative w.r.t. coupled variables More...

Detailed Description

This calculates the time derivative for a variable multiplied by a generalized susceptibility.

Definition at line 19 of file ChangedVariableTimeDerivative.h.

Constructor & Destructor Documentation

ChangedVariableTimeDerivative()

ChangedVariableTimeDerivative::ChangedVariableTimeDerivative

(

const InputParameters &

parameters

)

Definition at line 28 of file ChangedVariableTimeDerivative.C.

  : DerivativeMaterialInterface<JvarMapKernelInterface<TimeDerivative>>(parameters),
    _dopdu(getMaterialPropertyDerivative<Real>("order_parameter", _var.name())),
    _d2opdu2(getMaterialPropertyDerivative<Real>("order_parameter", _var.name(), _var.name())),
    _d2opdudarg(_n_args)
{
  // fetch derivatives
  for (unsigned int i = 0; i < _n_args; ++i)
    _d2opdudarg[i] = &getMaterialPropertyDerivative<Real>("order_parameter", _var.name(), i);
}

Member Function Documentation

computeQpJacobian()

Real ChangedVariableTimeDerivative::computeQpJacobian ( )

protectedvirtual

Definition at line 52 of file ChangedVariableTimeDerivative.C.

{
  return TimeDerivative::computeQpJacobian() * _dopdu[_qp] +
         TimeDerivative::computeQpResidual() * _d2opdu2[_qp] * _phi[_j][_qp];
}

computeQpOffDiagJacobian()

Real ChangedVariableTimeDerivative::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Definition at line 59 of file ChangedVariableTimeDerivative.C.

{
  // get the coupled variable jvar is referring to
  const unsigned int cvar = mapJvarToCvar(jvar);

  return TimeDerivative::computeQpResidual() * (*_d2opdudarg[cvar])[_qp] * _phi[_j][_qp];
}

computeQpResidual()

Real ChangedVariableTimeDerivative::computeQpResidual ( )

protectedvirtual

Definition at line 46 of file ChangedVariableTimeDerivative.C.

{
  return TimeDerivative::computeQpResidual() * _dopdu[_qp];
}

initialSetup()

void ChangedVariableTimeDerivative::initialSetup ( )

virtual

Definition at line 40 of file ChangedVariableTimeDerivative.C.

{
  validateNonlinearCoupling<Real>("order_parameter");
}

validParams()

InputParameters ChangedVariableTimeDerivative::validParams ( )

static

Definition at line 15 of file ChangedVariableTimeDerivative.C.

{
  InputParameters params = TimeDerivative::validParams();
  params.addClassDescription(
      "A modified time derivative Kernel that multiplies the time derivative by"
      "the derivative of the nonlinear preconditioning function");
  params.addRequiredParam<MaterialPropertyName>(
      "order_parameter",
      "Order parameter material defining the nonlinear preconditioning function");
  params.addCoupledVar("args", "Vector of additional arguments for order_parameter");
  return params;
}

Member Data Documentation

_d2opdu2

const MaterialProperty<Real>& ChangedVariableTimeDerivative::_d2opdu2

protected

2nd order parameter derivative

Definition at line 37 of file ChangedVariableTimeDerivative.h.

Referenced by computeQpJacobian().

_d2opdudarg

std::vector<const MaterialProperty<Real> *> ChangedVariableTimeDerivative::_d2opdudarg

protected

2nd order parameter derivative w.r.t. coupled variables

Definition at line 40 of file ChangedVariableTimeDerivative.h.

Referenced by ChangedVariableTimeDerivative(), and computeQpOffDiagJacobian().

_dopdu

const MaterialProperty<Real>& ChangedVariableTimeDerivative::_dopdu

protected

Order parameter derivative.

Definition at line 34 of file ChangedVariableTimeDerivative.h.

Referenced by computeQpJacobian(), and computeQpResidual().

---

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

• phase_field/include/kernels/ChangedVariableTimeDerivative.h
• phase_field/src/kernels/ChangedVariableTimeDerivative.C