https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ADCoupledSwitchingTimeDerivative Class Reference

#include <CoupledSwitchingTimeDerivative.h>

Inheritance diagram for ADCoupledSwitchingTimeDerivative:
[legend]

Public Types

typedef DerivativeMaterialPropertyNameInterface::SymbolName SymbolName
 

Public Member Functions

virtual void initialSetup () 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 ADReal precomputeQpResidual () override
 

Protected Attributes

const VariableName _v_name
 name of order parameter that derivatives are taken wrt (needed to retrieve the derivative material properties) More...
 
std::vector< MaterialPropertyName > _Fj_names
 Names of functions for each phase \( F_j \). More...
 
const unsigned int _num_j
 Number of phases. More...
 
std::vector< const GenericMaterialProperty< Real, is_ad > *> _prop_Fj
 Values of the functions for each phase \( F_j \). More...
 
std::vector< MaterialPropertyName > _hj_names
 switching function names More...
 
std::vector< const GenericMaterialProperty< Real, is_ad > *> _prop_dhjdetai
 Derivatives of the switching functions wrt the order parameter for this kernel. More...
 

Detailed Description

Definition at line 91 of file CoupledSwitchingTimeDerivative.h.

Member Function Documentation

◆ initialSetup()

void CoupledSwitchingTimeDerivativeTempl< is_ad >::initialSetup ( )
overridevirtualinherited

Definition at line 90 of file CoupledSwitchingTimeDerivative.C.

91 {
92  for (unsigned int n = 0; n < _num_j; ++n)
93  this->template validateNonlinearCoupling<GenericReal<is_ad>>(_hj_names[n]);
94 }
GenericReal
Moose::GenericType< Real, is_ad > GenericReal
DerivativeMaterialInterface< JvarMapKernelInterface< CoupledSwitchingTimeDerivativeBase< is_ad > > >::validateNonlinearCoupling
void validateNonlinearCoupling(const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
CoupledSwitchingTimeDerivativeTempl< true >::_hj_names
std::vector< MaterialPropertyName > _hj_names
switching function names
Definition: CoupledSwitchingTimeDerivative.h:60

◆ precomputeQpResidual()

ADReal ADCoupledSwitchingTimeDerivative::precomputeQpResidual ( )
overrideprotectedvirtual

Definition at line 115 of file CoupledSwitchingTimeDerivative.C.

116 {
117  ADReal sum = 0.0;
118  for (unsigned int n = 0; n < _num_j; ++n)
119  sum += (*_prop_dhjdetai[n])[_qp] * (*_prop_Fj[n])[_qp];
120 
121  return _v_dot[_qp] * sum;
122 }
CoupledSwitchingTimeDerivativeTempl< true >::_prop_dhjdetai
std::vector< const GenericMaterialProperty< Real, is_ad > *> _prop_dhjdetai
Derivatives of the switching functions wrt the order parameter for this kernel.
Definition: CoupledSwitchingTimeDerivative.h:63
ADReal
DualNumber< Real, DNDerivativeType, true > ADReal
CoupledSwitchingTimeDerivativeTempl< true >::_prop_Fj
std::vector< const GenericMaterialProperty< Real, is_ad > *> _prop_Fj
Values of the functions for each phase .
Definition: CoupledSwitchingTimeDerivative.h:57

◆ validParams()

InputParameters CoupledSwitchingTimeDerivativeTempl< is_ad >::validParams ( )
staticinherited

Definition at line 17 of file CoupledSwitchingTimeDerivative.C.

18 {
19  InputParameters params = CoupledSwitchingTimeDerivativeBase<is_ad>::validParams();
20  params.addClassDescription(
21  "Coupled time derivative Kernel that multiplies the time derivative by "
22  "$\\frac{dh_\\alpha}{d\\eta_i} F_\\alpha + \\frac{dh_\\beta}{d\\eta_i} F_\\beta + \\dots$");
23  params.addRequiredParam<std::vector<MaterialPropertyName>>(
24  "Fj_names", "List of functions for each phase. Place in same order as hj_names!");
25  params.addRequiredParam<std::vector<MaterialPropertyName>>(
26  "hj_names", "Switching Function Materials that provide h. Place in same order as Fj_names!");
27  params.addCoupledVar("args", "Vector of variable arguments of Fj and hj");
28  params.deprecateCoupledVar("args", "coupled_variables", "02/27/2024");
29  return params;
30 }
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
validParams
InputParameters validParams()
InputParameters::deprecateCoupledVar
void deprecateCoupledVar(const std::string &old_name, const std::string &new_name, const std::string &removal_date)
InputParameters::addCoupledVar
void addCoupledVar(const std::string &name, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _Fj_names

std::vector<MaterialPropertyName> CoupledSwitchingTimeDerivativeTempl< is_ad >::_Fj_names
protectedinherited

Names of functions for each phase \( F_j \).

Definition at line 51 of file CoupledSwitchingTimeDerivative.h.

◆ _hj_names

std::vector<MaterialPropertyName> CoupledSwitchingTimeDerivativeTempl< is_ad >::_hj_names
protectedinherited

switching function names

Definition at line 60 of file CoupledSwitchingTimeDerivative.h.

◆ _num_j

const unsigned int CoupledSwitchingTimeDerivativeTempl< is_ad >::_num_j
protectedinherited

Number of phases.

Definition at line 54 of file CoupledSwitchingTimeDerivative.h.

Referenced by precomputeQpResidual().

◆ _prop_dhjdetai

std::vector<const GenericMaterialProperty<Real, is_ad> *> CoupledSwitchingTimeDerivativeTempl< is_ad >::_prop_dhjdetai
protectedinherited

Derivatives of the switching functions wrt the order parameter for this kernel.

Definition at line 63 of file CoupledSwitchingTimeDerivative.h.

Referenced by precomputeQpResidual().

◆ _prop_Fj

std::vector<const GenericMaterialProperty<Real, is_ad> *> CoupledSwitchingTimeDerivativeTempl< is_ad >::_prop_Fj
protectedinherited

Values of the functions for each phase \( F_j \).

Definition at line 57 of file CoupledSwitchingTimeDerivative.h.

Referenced by precomputeQpResidual().

◆ _v_name

const VariableName CoupledSwitchingTimeDerivativeTempl< is_ad >::_v_name
protectedinherited

name of order parameter that derivatives are taken wrt (needed to retrieve the derivative material properties)

Definition at line 48 of file CoupledSwitchingTimeDerivative.h.

The documentation for this class was generated from the following files:
Generated on Fri Jul 18 2025 13:44:30 for https://mooseframework.inl.gov by   doxygen 1.8.14