Application Usage link

Physics and Syntax

Application Development link

Framework Development link

MOOSEDocs link

Infrastructure

Questions

Information and Tools

PolycrystalRandomIC

under construction: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.


# PolycrystalRandomIC

!syntax description /ICs/PolycrystalRandomIC

## Overview

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

## Example Input File Syntax

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

!syntax parameters /ICs/PolycrystalRandomIC

!syntax inputs /ICs/PolycrystalRandomIC

!syntax children /ICs/PolycrystalRandomIC

Random initial condition for a polycrystalline material

Input Parameters

  • op_indexThe index for the current order parameter

    C++ Type:unsigned int

    Options:

    Description:The index for the current order parameter

  • op_numNumber of order parameters

    C++ Type:unsigned int

    Options:

    Description:Number of order parameters

  • random_typeType of random grain structure

    C++ Type:unsigned int

    Options:

    Description:Type of random grain structure

  • 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

  • legacy_generatorFalseDetermines whether or not the legacy generator (deprecated) should be used.

    Default:False

    C++ Type:bool

    Options:

    Description:Determines whether or not the legacy generator (deprecated) should be used.

  • seed0Seed value for the random number generator

    Default:0

    C++ Type:unsigned int

    Options:

    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

    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