- 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
PolycrystalMatDiffusion
Diffusion equation Kernel that takes an isotropic Diffusivity from a material property
This kernel implements the same term as MatDiffusion
(residual contribution is the same). However, this kernel can account for explicit dependence of on order parameters and the gradients of the order parameters in calculating the Jacobian contributions. This is in contrast to MatDiffusion
, where only explicit dependence of on the order parameters themselves is accounted for. Accounting for the Jacobian contribution can accelerate convergence when explicitly depends on gradients of the order parameters.
The off-diagonal Jacobian contribution is calculated as where is the residual contribution from this kernel, is the basis function coefficient, is the test function, is the trial function, is the variable that is a discrete approximation of, is the basis or shape function, and is the non-linear variable for this kernel. The first term in the above equation is accounted for in MatDiffusion
. The second term is accounted for in this kernel.
Input Parameters
- add_grain_op_gradientsTrueWhether grain order parameter gradient contributions are added to Jacobian.
Default:True
C++ Type:bool
Controllable:No
Description:Whether grain order parameter gradient contributions are added to Jacobian.
- argsOptional vector of arguments for the diffusivity. If provided and diffusivity is a derivative parsed material, Jacobian contributions from the diffusivity will be automatically computed
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Optional vector of arguments for the diffusivity. If provided and diffusivity is a derivative parsed material, Jacobian contributions from the diffusivity will be automatically computed
- 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
- concDeprecated! Use 'v' instead
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Deprecated! Use 'v' instead
- diffusivityDThe diffusivity value or material property
Default:D
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:The diffusivity value or material property
- displacementsThe displacements
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The displacements
- grain_op_varsArray of grain order parameter variables
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Array of grain order parameter variables
- matrix_onlyFalseWhether this object is only doing assembly to matrices (no vectors)
Default:False
C++ Type:bool
Controllable:No
Description:Whether this object is only doing assembly to matrices (no vectors)
- op_numArray of grain order parameter variables (num_name)
C++ Type:unsigned int
Controllable:No
Description:Array of grain order parameter variables (num_name)
- surface_op_varName of the order parameter for solid-pore surface. For use when diffusivity depends on these OP gradients, leave this parameter un-set otherwise.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Name of the order parameter for solid-pore surface. For use when diffusivity depends on these OP gradients, leave this parameter un-set otherwise.
- vCoupled concentration variable for kernel to operate on; if this is not specified, the kernel's nonlinear variable will be used as usual
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Coupled concentration variable for kernel to operate on; if this is not specified, the kernel's nonlinear variable will be used as usual
- var_name_baseArray of grain order parameter variables (base_name)
C++ Type:std::string
Controllable:No
Description:Array of grain order parameter variables (base_name)
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
Contribution To Tagged Field Data 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>
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
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>
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
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.
Advanced Parameters
- 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
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.