https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
BarrierFunctionMaterial Class Reference

Material class to provide the double well function \( g(\eta) \) for the KKS system. More...

#include <BarrierFunctionMaterial.h>

Inheritance diagram for BarrierFunctionMaterial:
[legend]

Public Types

typedef DerivativeMaterialPropertyNameInterface::SymbolName SymbolName
 

Public Member Functions

 BarrierFunctionMaterial (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 void computeQpProperties ()
 

Protected Attributes

MooseEnum _g_order
 Polynomial order of the switching function \( g(\eta) \).
 
bool _well_only
 zero out g contribution in the eta interval [0:1]
 
const VariableValue & _eta
 Coupled variable value for the order parameter \( \eta \).
 
unsigned int _eta_var
 
VariableName _eta_name
 
std::string _function_name
 name of the function of eta (used to generate the material property names)
 
MaterialProperty< Real > & _prop_f
 Material property to store \( f(\eta) \).
 
MaterialProperty< Real > & _prop_df
 Material property to store the derivative \( df(\eta)/d\eta \).
 
MaterialProperty< Real > & _prop_d2f
 Material property to store the second derivative \( d^2f(\eta)/d\eta^2 \).
 

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

FEProblemBase & _dmi_fe_problem
 

Detailed Description

Material class to provide the double well function \( g(\eta) \) for the KKS system.

See also
KKSPhaseChemicalPotential
KKSCHBulk

Definition at line 23 of file BarrierFunctionMaterial.h.

Constructor & Destructor Documentation

◆ BarrierFunctionMaterial()

BarrierFunctionMaterial::BarrierFunctionMaterial ( const InputParameters &  parameters)

Definition at line 32 of file BarrierFunctionMaterial.C.

33 : OrderParameterFunctionMaterial(parameters),
34 _g_order(getParam<MooseEnum>("g_order")),
35 _well_only(getParam<bool>("well_only"))
36{
37}
BarrierFunctionMaterial::_well_only
bool _well_only
zero out g contribution in the eta interval [0:1]
Definition BarrierFunctionMaterial.h:37
BarrierFunctionMaterial::_g_order
MooseEnum _g_order
Polynomial order of the switching function .
Definition BarrierFunctionMaterial.h:34
OrderParameterFunctionMaterial
Material base class for materials that provide the switching function or the double well function .
Definition OrderParameterFunctionMaterial.h:23

Member Function Documentation

◆ computeQpProperties()

void BarrierFunctionMaterial::computeQpProperties ( )
protectedvirtual

Definition at line 40 of file BarrierFunctionMaterial.C.

41{
42 const Real n = _eta[_qp];
43
44 if (_well_only && n >= 0.0 && n <= 1.0)
45 {
46 _prop_f[_qp] = 0.0;
47 _prop_df[_qp] = 0.0;
48 _prop_d2f[_qp] = 0.0;
49 return;
50 }
51
52 switch (_g_order)
53 {
54 case 0: // SIMPLE
55 _prop_f[_qp] = n * n * (1.0 - n) * (1.0 - n);
56 _prop_df[_qp] = 2.0 * n * (n - 1.0) * (2.0 * n - 1.0);
57 _prop_d2f[_qp] = 12.0 * (n * n - n) + 2.0;
58 break;
59
60 case 1: // LOW
61 _prop_f[_qp] = n * (1.0 - n);
62 _prop_df[_qp] = 1.0 - 2.0 * n;
63 _prop_d2f[_qp] = -2.0;
64 break;
65
66 case 2: // HIGH
67 _prop_f[_qp] = n * n * (1.0 - n * n) * (1.0 - n * n);
68 _prop_df[_qp] = n * (2.0 - n * n * (8.0 + 6.0 * n * n));
69 _prop_d2f[_qp] = 2.0 - n * n * (24.0 + 30.0 * n * n);
70 break;
71
72 default:
73 mooseError("Internal error");
74 }
75}
mooseError
void mooseError(Args &&... args)
OrderParameterFunctionMaterial::_prop_df
MaterialProperty< Real > & _prop_df
Material property to store the derivative .
Definition OrderParameterFunctionMaterial.h:42
OrderParameterFunctionMaterial::_prop_f
MaterialProperty< Real > & _prop_f
Material property to store .
Definition OrderParameterFunctionMaterial.h:39
OrderParameterFunctionMaterial::_prop_d2f
MaterialProperty< Real > & _prop_d2f
Material property to store the second derivative .
Definition OrderParameterFunctionMaterial.h:45
OrderParameterFunctionMaterial::_eta
const VariableValue & _eta
Coupled variable value for the order parameter .
Definition OrderParameterFunctionMaterial.h:31
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ validParams()

InputParameters BarrierFunctionMaterial::validParams ( )
static

Definition at line 15 of file BarrierFunctionMaterial.C.

16{
17 InputParameters params = OrderParameterFunctionMaterial::validParams();
18 params.addClassDescription("Helper material to provide $g(\\eta)$ and its derivative in a "
19 "polynomial.\nSIMPLE: $\\eta^2(1-\\eta)^2$\nLOW: $\\eta(1-\\eta)$"
20 "\nHIGH: $\\eta^2(1-\\eta^2)^2$");
21 MooseEnum g_order("SIMPLE=0 LOW HIGH", "SIMPLE");
22 params.addParam<MooseEnum>("g_order", g_order, "Polynomial order of the barrier function g(eta)");
23 params.addParam<bool>("well_only",
24 false,
25 "Make the g zero in [0:1] so it only contributes to "
26 "enforcing the eta range and not to the phase "
27 "transformation barrier.");
28 params.set<std::string>("function_name") = std::string("g");
29 return params;
30}
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)

Member Data Documentation

◆ _eta

const VariableValue& OrderParameterFunctionMaterial::_eta
protectedinherited

Coupled variable value for the order parameter \( \eta \).

Definition at line 31 of file OrderParameterFunctionMaterial.h.

Referenced by computeQpProperties(), MixedSwitchingFunctionMaterial::computeQpProperties(), and SwitchingFunctionMaterial::computeQpProperties().

◆ _eta_name

VariableName OrderParameterFunctionMaterial::_eta_name
protectedinherited

Definition at line 33 of file OrderParameterFunctionMaterial.h.

◆ _eta_var

unsigned int OrderParameterFunctionMaterial::_eta_var
protectedinherited

Definition at line 32 of file OrderParameterFunctionMaterial.h.

◆ _function_name

std::string OrderParameterFunctionMaterial::_function_name
protectedinherited

name of the function of eta (used to generate the material property names)

Definition at line 36 of file OrderParameterFunctionMaterial.h.

◆ _g_order

MooseEnum BarrierFunctionMaterial::_g_order
protected

Polynomial order of the switching function \( g(\eta) \).

Definition at line 34 of file BarrierFunctionMaterial.h.

Referenced by computeQpProperties().

◆ _prop_d2f

MaterialProperty<Real>& OrderParameterFunctionMaterial::_prop_d2f
protectedinherited

Material property to store the second derivative \( d^2f(\eta)/d\eta^2 \).

Definition at line 45 of file OrderParameterFunctionMaterial.h.

Referenced by computeQpProperties(), MixedSwitchingFunctionMaterial::computeQpProperties(), and SwitchingFunctionMaterial::computeQpProperties().

◆ _prop_df

MaterialProperty<Real>& OrderParameterFunctionMaterial::_prop_df
protectedinherited

Material property to store the derivative \( df(\eta)/d\eta \).

Definition at line 42 of file OrderParameterFunctionMaterial.h.

Referenced by computeQpProperties(), MixedSwitchingFunctionMaterial::computeQpProperties(), and SwitchingFunctionMaterial::computeQpProperties().

◆ _prop_f

MaterialProperty<Real>& OrderParameterFunctionMaterial::_prop_f
protectedinherited

Material property to store \( f(\eta) \).

Definition at line 39 of file OrderParameterFunctionMaterial.h.

Referenced by computeQpProperties(), MixedSwitchingFunctionMaterial::computeQpProperties(), and SwitchingFunctionMaterial::computeQpProperties().

◆ _well_only

bool BarrierFunctionMaterial::_well_only
protected

zero out g contribution in the eta interval [0:1]

Definition at line 37 of file BarrierFunctionMaterial.h.

Referenced by computeQpProperties().

The documentation for this class was generated from the following files:
Generated on Fri Aug 21 2026 13:42:20 for https://mooseframework.inl.gov by doxygen 1.9.8