BicrystalCircleGrainICAction

under construction:Undocumented Class

The BicrystalCircleGrainICAction 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 with a circular grain and an embedding outer grain

Input Parameters

  • var_name_basespecifies the base name of the variables

    C++ Type:std::string

    Options:

    Description:specifies the base name of the variables

  • yThe y coordinate of the circle grain center

    C++ Type:double

    Options:

    Description:The y coordinate of the circle grain center

  • radiusVoid radius

    C++ Type:double

    Options:

    Description:Void radius

  • op_numNumber of grains, should be 2

    C++ Type:unsigned int

    Options:

    Description:Number of grains, should be 2

  • xThe x coordinate of the circle grain center

    C++ Type:double

    Options:

    Description:The x coordinate of the circle grain center

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

  • int_width0The interfacial width of the void surface. Defaults to sharp interface

    Default:0

    C++ Type:double

    Options:

    Description:The interfacial width of the void surface. Defaults to sharp interface

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector

    Options:

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

  • 3D_sphereTruein 3D, whether the smaller grain is a spheres or columnar grain

    Default:True

    C++ Type:bool

    Options:

    Description:in 3D, whether the smaller grain is a spheres or columnar grain

  • z0The z coordinate of the circle grain center

    Default:0

    C++ Type:double

    Options:

    Description:The z coordinate of the circle grain center

Optional Parameters

References