- gb_type_orderThe grain boundary type to calculate bnds parameter
C++ Type:double
Controllable:No
Description:The grain boundary type to calculate bnds parameter
- solutionThe name of the SolutionUserObject
C++ Type:UserObjectName
Controllable:No
Description:The name of the SolutionUserObject
- vArray of coupled variables
C++ Type:std::vector<VariableName>
Controllable:No
Description:Array of coupled variables
- variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Controllable:No
Description:The name of the variable that this object applies to
SolutionAuxMisorientationBoundary
This AuxKernel computes the value as
where is the variable the AuxKernel is acting on, (v) are a set of coupled order parameters, and is defined as
where is the GB type imported from a SolutionUserObject and the is the specific GB type to calculate the bnds parameter. When used with order parameters of the polycrystalline grain growth model, the resulting field for is in grain boundaries with specific GB type and in grain interiors and other grain boundaries.
Input Parameters
- add_factor0Add this value (b) to the solution (x): ax+b, where a is the 'scale_factor'
Default:0
C++ Type:double
Controllable:No
Description:Add this value (b) to the solution (x): ax+b, where a is the 'scale_factor'
- 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
- boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
- check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
Default:True
C++ Type:bool
Controllable:No
Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
- directFalseIf true the meshes must be the same and then the values are simply copied over.
Default:False
C++ Type:bool
Controllable:No
Description:If true the meshes must be the same and then the values are simply copied over.
- execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS, PRE_DISPLACE.
Default:LINEAR TIMESTEP_END
C++ Type:ExecFlagEnum
Controllable:No
Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS, PRE_DISPLACE.
- from_variableThe name of the variable to extract from the file
C++ Type:std::string
Controllable:No
Description:The name of the variable to extract from the file
- op_numArray of coupled variables (num_name)
C++ Type:unsigned int
Controllable:No
Description:Array of coupled variables (num_name)
- 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.
- scale_factor1Scale factor (a) to be applied to the solution (x): ax+b, where b is the 'add_factor'
Default:1
C++ Type:double
Controllable:No
Description:Scale factor (a) to be applied to the solution (x): ax+b, where b is the 'add_factor'
- var_name_baseArray of coupled variables (base_name)
C++ Type:std::string
Controllable:No
Description:Array of coupled variables (base_name)
Optional 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.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:Yes
Description:Set the enabled status of the MooseObject.
- 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.