- fa_nameBase name of the free energy function F (f_base in the corresponding KKSBaseMaterial)
C++ Type:MaterialPropertyName
Controllable:No
Description:Base name of the free energy function F (f_base in the corresponding KKSBaseMaterial)
- fb_nameBase name of the free energy function F (f_base in the corresponding KKSBaseMaterial)
C++ Type:MaterialPropertyName
Controllable:No
Description:Base name of the free energy function F (f_base in the corresponding KKSBaseMaterial)
- variableThe name of the variable that this residual object operates on
C++ Type:NonlinearVariableName
Controllable:No
Description:The name of the variable that this residual object operates on
- wDouble well height parameter
C++ Type:double
Controllable:No
Description:Double well height parameter
KKSACBulkF
KKS model kernel (part 1 of 2) for the Bulk Allen-Cahn. This includes all terms NOT dependent on chemical potential.
KKS Allen-Cahn kernel for the terms without a direct composition dependence.
Residual
Jacobian
On-diagonal
We are looking for the derivative of , where . We need to apply the chain rule and will again only keep terms with the derivative.
(The implicit dependence of and on through and does not contribute to the Jacobian, so .
Off-Diagonal
The off-diagonal components are calculated for any other variables that and depend on. For example, for :
in the KKS formulation, so this term would not need to be included if was the only variable depended on. However, the code calculates derivatives with respect to all variables that and depend on in a general way so that the Jacobian entries for other dependencies are correctly computed using the same piece of code. For example, both and could depend on temperature , in which case
which is computed using the same code. The off-diagonal Jacobian contribution is also multiplied by the Allen-Cahn mobility at each point for consistency with the other terms in the Allen-Cahn equation.
Input Parameters
- blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
- coupled_variablesVector of nonlinear variable arguments this object depends on
C++ Type:std::vector<VariableName>
Controllable:No
Description:Vector of nonlinear variable arguments this object depends on
- displacementsThe displacements
C++ Type:std::vector<VariableName>
Controllable:No
Description:The displacements
- g_namegBase name for the double well function g(eta)
Default:g
C++ Type:MaterialPropertyName
Controllable:No
Description:Base name for the double well function g(eta)
- h_namehBase name for the switching function h(eta)
Default:h
C++ Type:MaterialPropertyName
Controllable:No
Description:Base name for the switching function h(eta)
- mob_nameLThe mobility used with the kernel
Default:L
C++ Type:MaterialPropertyName
Controllable:No
Description:The mobility used with the kernel
- prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
Optional Parameters
- absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution
C++ Type:std::vector<TagName>
Controllable:No
Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution
- extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
C++ Type:std::vector<TagName>
Controllable:No
Description:The extra tags for the matrices this Kernel should fill
- extra_vector_tagsThe extra tags for the vectors this Kernel should fill
C++ Type:std::vector<TagName>
Controllable:No
Description:The extra tags for the vectors this Kernel should fill
- matrix_tagssystemThe tag for the matrices this Kernel should fill
Default:system
C++ Type:MultiMooseEnum
Controllable:No
Description:The tag for the matrices this Kernel should fill
- vector_tagsnontimeThe tag for the vectors this Kernel should fill
Default:nontime
C++ Type:MultiMooseEnum
Controllable:No
Description:The tag for the vectors this Kernel should fill
Tagging Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
- diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
C++ Type:std::vector<AuxVariableName>
Controllable:No
Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:Yes
Description:Set the enabled status of the MooseObject.
- implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Controllable:No
Description:Determines whether this object is calculated using an implicit or explicit form
- save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
C++ Type:std::vector<AuxVariableName>
Controllable:No
Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
- seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Controllable:No
Description:The seed for the master random number generator
- use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.