- op_numNumber of grains, should be 2
C++ Type:unsigned int
Description:Number of grains, should be 2
- var_name_basespecifies the base name of the variables
C++ Type:std::string
Description:specifies the base name of the variables
- x1The x coordinate of the lower left-hand corner of the box
C++ Type:double
Description:The x 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
Description:The x coordinate of the upper right-hand corner of the box
- y1The y coordinate of the lower left-hand corner of the box
C++ Type:double
Description:The y coordinate of the lower left-hand corner of the box
- y2The y coordinate of the upper right-hand corner of the box
C++ Type:double
Description:The y coordinate of the upper right-hand corner of the box
BicrystalBoundingBoxICAction
under construction:Undocumented Action Class
The BicrystalBoundingBoxICAction 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.
# BicrystalBoundingBoxICAction
!syntax description /ICs/PolycrystalICs/BicrystalBoundingBoxIC/BicrystalBoundingBoxICAction
## Overview
!! Replace these lines with information regarding the BicrystalBoundingBoxICAction action.
## Example Input File Syntax
!! Describe and include an example of how to use the BicrystalBoundingBoxICAction action.
!syntax parameters /ICs/PolycrystalICs/BicrystalBoundingBoxIC/BicrystalBoundingBoxICAction
Constructs a bicrystal, where one grain is on the inside of the box and the other grain is the outside of the box
Input Parameters
- active__all__ If specified only the blocks named will be visited and made active
Default:__all__
C++ Type:std::vector
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
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
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
Description:The z coordinate of the upper right-hand corner of the box