Tricrystal2CircleGrainsICAction

buildconstruction:Undocumented Action Class

The Tricrystal2CircleGrainsICAction 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 an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Overview

Example Input File Syntax

Input Parameters

  • op_numnumber of order parameters to create

    C++ Type:unsigned int

    Controllable:No

    Description:number of order parameters to create

  • var_name_basespecifies the base name of the variables

    C++ Type:std::string

    Controllable:No

    Description:specifies the base name of the variables

Required Parameters

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

    Default:__all__

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

    Controllable:No

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

  • blockBlock restriction for the initial condition

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

    Controllable:No

    Description:Block restriction for the initial condition

  • inactiveIf specified blocks matching these identifiers will be skipped.

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

    Controllable:No

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

Optional Parameters