- op_indexThe index for the current order parameter
C++ Type:unsigned int
Description:The index for the current order parameter
- polycrystal_ic_uoUser object generating a point to grain number mapping
C++ Type:UserObjectName
Description:User object generating a point to grain number mapping
- variableThe variable this initial condition is supposed to provide values for.
C++ Type:VariableName
Description:The variable this initial condition is supposed to provide values for.
PolycrystalColoringIC
The PolycrystalColoringIC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
Random Voronoi tesselation polycrystal (used by PolycrystalVoronoiICAction)
Overview
Example Input File Syntax
Input Parameters
- blockThe list of block ids (SubdomainID) that this object will be applied
C++ Type:std::vector<SubdomainName>
Description:The list of block ids (SubdomainID) that this object will be applied
- boundaryThe list of boundary IDs from the mesh where this boundary condition applies
C++ Type:std::vector<BoundaryName>
Description:The list of boundary IDs from the mesh where this boundary condition applies
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Description:Set the enabled status of the MooseObject.
- ignore_uo_dependencyFalseWhen set to true, a UserObject retrieved by this IC will not be executed before the this IC
Default:False
C++ Type:bool
Description:When set to true, a UserObject retrieved by this IC will not be executed before the this IC