PolycrystalColoringIC

under construction:Undocumented Class

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.


# PolycrystalColoringIC

!syntax description /ICs/PolycrystalColoringIC

## Overview

!! Replace these lines with information regarding the PolycrystalColoringIC object.

## Example Input File Syntax

!! Describe and include an example of how to use the PolycrystalColoringIC object.

!syntax parameters /ICs/PolycrystalColoringIC

!syntax inputs /ICs/PolycrystalColoringIC

!syntax children /ICs/PolycrystalColoringIC

Random Voronoi tesselation polycrystal (used by PolycrystalVoronoiICAction)

Input Parameters

  • op_indexThe index for the current order parameter

    C++ Type:unsigned int

    Options:

    Description:The index for the current order parameter

  • polycrystal_ic_uoUser object generating a point to grain number mapping

    C++ Type:UserObjectName

    Options:

    Description:User object generating a point to grain number mapping

  • variableThe variable this initial condition is supposed to provide values for.

    C++ Type:VariableName

    Options:

    Description:The variable this initial condition is supposed to provide values for.

Required Parameters

  • blockThe list of block ids (SubdomainID) that this object will be applied

    C++ Type:std::vector

    Options:

    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

    Options:

    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

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    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

    Options:

    Description:When set to true, a UserObject retrieved by this IC will not be executed before the this IC

Advanced Parameters