PolycrystalColoringIC

Random Voronoi tesselation polycrystal (used by PolycrystalVoronoiICAction)

Overview

Initializes the order parameter values for the polycrystal grain growth ICs. It works with the various Polycrystal ICs UserObjects.

Example Input File Syntax

We never recommend using this IC directly, but rather creating the full set of ICs for all of the transformed variables using PolycrystalColoringICAction.

Input Parameters

  • op_indexThe index for the current order parameter

    C++ Type:unsigned int

    Controllable:No

    Description:The index for the current order parameter

  • polycrystal_ic_uoUser object generating a point to grain number mapping

    C++ Type:UserObjectName

    Controllable:No

    Description:User object generating a point to grain number mapping

  • 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.

Required 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 object applies

    C++ Type:std::vector<BoundaryName>

    Controllable:No

    Description:The list of boundaries (ids or names) from the mesh where this object applies

  • 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.

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

Advanced Parameters