PolycrystalRandomICAction

under construction:Undocumented Class

The PolycrystalRandomICAction has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with an action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

!syntax description /ICs/PolycrystalICs/PolycrystalRandomIC/PolycrystalRandomICAction

Input Parameters

  • var_name_basespecifies the base name of the variables

    C++ Type:std::string

    Options:

    Description:specifies the base name of the variables

  • op_numnumber of order parameters to create

    C++ Type:unsigned int

    Options:

    Description:number of order parameters to create

Required Parameters

  • active__all__ If specified only the blocks named will be visited and made active

    Default:__all__

    C++ Type:std::vector

    Options:

    Description:If specified only the blocks named will be visited and made active

  • random_typeThe type of random polycrystal initial condition. Whether one order parameter is chosen to be 1 at each node or if each order parameter continuously varies from 0 to 1

    C++ Type:MooseEnum

    Options:continuous discrete

    Description:The type of random polycrystal initial condition. Whether one order parameter is chosen to be 1 at each node or if each order parameter continuously varies from 0 to 1

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector

    Options:

    Description:If specified blocks matching these identifiers will be skipped.

Optional Parameters

References