- Fj_namesList of free energies for each phase. Place in same order as hj_names!
C++ Type:std::vector<MaterialPropertyName>
Unit:(no unit assumed)
Controllable:No
Description:List of free energies for each phase. Place in same order as hj_names!
- all_etasOrder parameters.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Order parameters.
- ci_namesPhase concentrations. They must have the same order as Fj_names and global_cs, for example, c1, c2, b1, b2.
C++ Type:std::vector<MaterialPropertyName>
Unit:(no unit assumed)
Controllable:No
Description:Phase concentrations. They must have the same order as Fj_names and global_cs, for example, c1, c2, b1, b2.
- eta_iOrder parameter that derivatives are taken with respect to
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Order parameter that derivatives are taken with respect to
- gi_nameBase name for the double well function g_i(eta_i).
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:Base name for the double well function g_i(eta_i).
- global_csThe interpolated concentrations c, b, etc.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The interpolated concentrations c, b, etc.
- hj_namesSwitching Function Materials that provide h. Place in same order as Fj_names!
C++ Type:std::vector<MaterialPropertyName>
Unit:(no unit assumed)
Controllable:No
Description:Switching Function Materials that provide h. Place in same order as Fj_names!
- variableThe name of the variable that this residual object operates on
C++ Type:NonlinearVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this residual object operates on
- wiDouble well height parameter.
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Double well height parameter.
NestedKKSMultiACBulkF
KKS model kernel (part 1 of 2) for the Bulk Allen-Cahn. This includes all terms NOT dependent on chemical potential.
Kim-Kim-Suzuki (KKS) nested solve kernel (2 of 3) for multiphase models. An Allen-Cahn kernel for the terms without a direct composition dependence.
Residual is the nonlinear variable of this kernel. For a model with phases:
Jacobian
On-diagonal
We are looking for the derivative of , where . We need to apply the chain rule and will only keep terms with the derivative.
Off-diagonal
Since the partial derivative of phase concentrations w.r.t global concentration is hidden when computing the derivative of , where , the derivative w.r.t must be calculated separately from any other variable dependence. We need to apply the chain rule and will again only keep terms with the derivative.
Similarly, the partial derivative of phase concentrations w.r.t phase parameter is hidden when computing the derivative of , where , the derivative w.r.t must be calculated separately from any other variable dependence. We need to apply the chain rule and will again only keep terms with the derivative.
If contains any other explicit variables, for example temperature :
The off-diagonal Jacobian contribution is 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>
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
Controllable:No
Description:Vector of nonlinear variable arguments this object depends on
- displacementsThe displacements
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The displacements
- mob_nameLThe mobility used with the kernel
Default:L
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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.
- use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
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>
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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.