- op_indexThe index for the current order parameter
C++ Type:unsigned int
Controllable:No
Description:The index for the current order parameter
- op_numNumber of order parameters
C++ Type:unsigned int
Controllable:No
Description:Number of order parameters
- random_typeType of random grain structure
C++ Type:unsigned int
Controllable:No
Description:Type of random grain structure
- variableThe variable this initial condition is supposed to provide values for.
C++ Type:VariableName
Controllable:No
Description:The variable this initial condition is supposed to provide values for.
PolycrystalRandomIC
buildconstruction:Undocumented Class
The PolycrystalRandomIC 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 initial condition for a polycrystalline material
Overview
Example Input File Syntax
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
- boundaryThe list of boundaries (ids or names) from the mesh where this boundary condition applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this boundary condition applies
- legacy_generatorFalseDetermines whether or not the legacy generator (deprecated) should be used.
Default:False
C++ Type:bool
Controllable:No
Description:Determines whether or not the legacy generator (deprecated) should be used.
- 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.
- seed0Seed value for the random number generator
Default:0
C++ Type:unsigned int
Controllable:No
Description:Seed value for the random number generator
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:No
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
Controllable:No
Description:When set to true, a UserObject retrieved by this IC will not be executed before the this IC