BicrystalBoundingBoxICAction

under construction:Undocumented Class

The BicrystalBoundingBoxICAction has not been documented. The content contained on this page includes the basic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Bicrystal using a bounding box

Input Parameters

  • var_name_basespecifies the base name of the variables

    C++ Type:std::string

    Options:

    Description:specifies the base name of the variables

  • y2The y coordinate of the upper right-hand corner of the box

    C++ Type:double

    Options:

    Description:The y coordinate of the upper right-hand corner of the box

  • op_numNumber of grains, should be 2

    C++ Type:unsigned int

    Options:

    Description:Number of grains, should be 2

  • y1The y coordinate of the lower left-hand corner of the box

    C++ Type:double

    Options:

    Description:The y coordinate of the lower left-hand corner of the box

  • x2The x coordinate of the upper right-hand corner of the box

    C++ Type:double

    Options:

    Description:The x coordinate of the upper right-hand corner of the box

  • x1The x coordinate of the lower left-hand corner of the box

    C++ Type:double

    Options:

    Description:The x coordinate of the lower left-hand corner of the box

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

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector

    Options:

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

  • z10The z coordinate of the lower left-hand corner of the box

    Default:0

    C++ Type:double

    Options:

    Description:The z coordinate of the lower left-hand corner of the box

  • z20The z coordinate of the upper right-hand corner of the box

    Default:0

    C++ Type:double

    Options:

    Description:The z coordinate of the upper right-hand corner of the box

Optional Parameters

References