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

This kernel calculates the residual for grain growth for a single phase, poly-crystal system. More...

#include <ADGrainGrowth.h>

Inheritance diagram for ADGrainGrowth:
[legend]

Public Types

typedef DerivativeMaterialPropertyNameInterface::SymbolName SymbolName
 

Public Member Functions

 ADGrainGrowth (const InputParameters &parameters)
 
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 computeDFDOP ()
 Compute the derivative of the bulk free energy w.r.t the order parameter. More...
 
virtual ADReal precomputeQpResidual ()
 

Protected Attributes

const ADMaterialProperty< Real > & _gamma
 
const unsigned int _op_num
 
const std::vector< const ADVariableValue * > _vals
 
const ADMaterialProperty< Real > & _mu
 
const ADMaterialProperty< Real > & _prop_L
 Mobility. More...
 

Detailed Description

This kernel calculates the residual for grain growth for a single phase, poly-crystal system.

A single material property gamma_asymm is used for the prefactor of the cross-terms between order parameters. This is the AD version of ACGrGrPoly

Definition at line 20 of file ADGrainGrowth.h.

Constructor & Destructor Documentation

◆ ADGrainGrowth()

ADGrainGrowth::ADGrainGrowth ( const InputParameters &  parameters)

Definition at line 22 of file ADGrainGrowth.C.

23  : ADGrainGrowthBase(parameters), _gamma(getADMaterialProperty<Real>("gamma_asymm"))
24 {
25 }
ADGrainGrowthBase::ADGrainGrowthBase
ADGrainGrowthBase(const InputParameters &parameters)
Definition: ADGrainGrowthBase.C:21
ADGrainGrowth::_gamma
const ADMaterialProperty< Real > & _gamma
Definition: ADGrainGrowth.h:30

Member Function Documentation

◆ computeDFDOP()

ADReal ADGrainGrowth::computeDFDOP ( )
protectedvirtual

Compute the derivative of the bulk free energy w.r.t the order parameter.

Implements ADAllenCahnBase< Real >.

Definition at line 28 of file ADGrainGrowth.C.

29 {
30  // Sum all other order parameters
31  ADReal SumEtaj = 0.0;
32  for (unsigned int i = 0; i < _op_num; ++i)
33  SumEtaj += (*_vals[i])[_qp] * (*_vals[i])[_qp];
34 
35  return _mu[_qp] * (_u[_qp] * _u[_qp] * _u[_qp] - _u[_qp] + 2.0 * _gamma[_qp] * _u[_qp] * SumEtaj);
36 }
ADGrainGrowthBase::_mu
const ADMaterialProperty< Real > & _mu
Definition: ADGrainGrowthBase.h:30
ADReal
DualNumber< Real, DNDerivativeType, true > ADReal
ADGrainGrowthBase::_vals
const std::vector< const ADVariableValue * > _vals
Definition: ADGrainGrowthBase.h:29
ADGrainGrowthBase::_op_num
const unsigned int _op_num
Definition: ADGrainGrowthBase.h:28
ADGrainGrowth::_gamma
const ADMaterialProperty< Real > & _gamma
Definition: ADGrainGrowth.h:30

◆ precomputeQpResidual()

ADReal ADAllenCahnBase< Real >::precomputeQpResidual ( )
protectedvirtualinherited

Definition at line 61 of file ADAllenCahnBase.h.

62 {
63  return _prop_L[_qp] * computeDFDOP();
64 }
ADAllenCahnBase< Real >::_prop_L
const ADMaterialProperty< Real > & _prop_L
Mobility.
Definition: ADAllenCahnBase.h:38
ADAllenCahnBase< Real >::computeDFDOP
virtual ADReal computeDFDOP()=0
Compute the derivative of the bulk free energy w.r.t the order parameter.

◆ validParams()

InputParameters ADGrainGrowth::validParams ( )
static

Definition at line 15 of file ADGrainGrowth.C.

16 {
17  InputParameters params = ADGrainGrowthBase::validParams();
18  params.addClassDescription("Grain-Boundary model poly-crystalline interface Allen-Cahn Kernel");
19  return params;
20 }
ADGrainGrowthBase::validParams
static InputParameters validParams()
Definition: ADGrainGrowthBase.C:13
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _gamma

const ADMaterialProperty<Real>& ADGrainGrowth::_gamma
protected

Definition at line 30 of file ADGrainGrowth.h.

Referenced by computeDFDOP().

◆ _mu

const ADMaterialProperty<Real>& ADGrainGrowthBase::_mu
protectedinherited

Definition at line 30 of file ADGrainGrowthBase.h.

Referenced by computeDFDOP().

◆ _op_num

const unsigned int ADGrainGrowthBase::_op_num
protectedinherited

Definition at line 28 of file ADGrainGrowthBase.h.

Referenced by computeDFDOP().

◆ _prop_L

const ADMaterialProperty<Real >& ADAllenCahnBase< Real >::_prop_L
protectedinherited

Mobility.

Definition at line 38 of file ADAllenCahnBase.h.

◆ _vals

const std::vector<const ADVariableValue *> ADGrainGrowthBase::_vals
protectedinherited

Definition at line 29 of file ADGrainGrowthBase.h.

Referenced by computeDFDOP().

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