[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

6.3 Shapes

Global variable: group Shapes

In Angora, a geometrical shape and the material filling that shape are two distinct and independent elements of the definition of an object. The first of these elements is defined in the Shapes variable, which is a group (see section Groups).

 
Shapes:
{
    RectangularBoxes:
    (
        …
        …
    );
    Spheres:
    (
        …
        …
    );

    …
    …

};

In this example, two sub-variables RectangularBoxes and Spheres of the Shapes group are shown. These are both list variables (see section Lists).

Currently, rectangular boxes and spheres are the only basic shape classes defined in Angora. Unions, intersections, and geometrical transformations of shapes, as well as more basic shape classes will be added to Angora in the future. Please send any comments, suggestions, and requests to help@angorafdtd.org.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

6.3.1 Rectangular Boxes

Sub-variable of Shapes: group RectangularBoxes

Rectangular boxes are defined using the RectangularBoxes variable, which is a list structure under the Shapes group.

 
Shapes:
{
    RectangularBoxes:
    (
        {
            shape_tag = "mybox";
            back_coord_x = -5e-6;
            front_coord_x = 6e-6;
            left_coord_y = -5e-6;
            right_coord_y = 6e-6;
            lower_coord_z = -3e-6;
            upper_coord_z = 4e-6;
        },
        {
            …
            …
        }
    );
};

In this example, two rectangular box shapes are defined in two respective unnamed groups; only the first being shown in complete detail.

Sub-variable of RectangularBoxes: string shape_tag

This string variable assigns a name to the particular shape, so it can be referred to later in the configuration file.

Sub-variable of RectangularBoxes: floating-point back_coord_x (units: m)
Sub-variable of RectangularBoxes: floating-point front_coord_x (units: m)
Sub-variable of RectangularBoxes: floating-point left_coord_y (units: m)
Sub-variable of RectangularBoxes: floating-point right_coord_y (units: m)
Sub-variable of RectangularBoxes: floating-point lower_coord_z (units: m)
Sub-variable of RectangularBoxes: floating-point upper_coord_z (units: m)
Sub-variable of RectangularBoxes: floating-point back_coord_x_in_cells
Sub-variable of RectangularBoxes: floating-point front_coord_x_in_cells
Sub-variable of RectangularBoxes: floating-point left_coord_y_in_cells
Sub-variable of RectangularBoxes: floating-point right_coord_y_in_cells
Sub-variable of RectangularBoxes: floating-point lower_coord_z_in_cells
Sub-variable of RectangularBoxes: floating-point upper_coord_z_in_cells

These variables determine the minimum and maximum Cartesian coordinates of the box in the x, y, and z directions relative to the grid origin (see section Coordinate Origin). The units are either in meters or grid cells. For the latter, the _in_cells suffix should be appended to the variable name.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

6.3.2 Spheres

Sub-variable of Shapes: group Spheres

Spheres are defined using the Spheres variable, which is a list structure under the Shapes group.

 
Shapes:
{
    Spheres:
    (
        {
            shape_tag = "mysphere";
            center_coord_x = 5e-6;
            center_coord_y = 5e-6;
            center_coord_z = 5e-6;
            radius = 4e-6;
        },
        {
            …
            …
        }
    );
};

In this example, two spherical shapes are defined in two respective unnamed groups; only the first being shown in complete detail.

Sub-variable of Spheres: string shape_tag

This string variable assigns a name to the particular shape, so it can be referred to later in the configuration file.

Sub-variable of Spheres: floating-point center_coord_x (units: m)
Sub-variable of Spheres: floating-point center_coord_y (units: m)
Sub-variable of Spheres: floating-point center_coord_z (units: m)
Sub-variable of Spheres: floating-point center_coord_x_in_cells
Sub-variable of Spheres: floating-point center_coord_y_in_cells
Sub-variable of Spheres: floating-point center_coord_z_in_cells

These variables determine the Cartesian coordinate of the center of the sphere relative to the grid origin (see section Coordinate Origin). The units are either in meters or grid cells. For the latter, the _in_cells suffix should be appended to the variable name.

Sub-variable of Spheres: floating-point radius (units: m)
Sub-variable of Spheres: floating-point radius_in_cells

This variable determines the radius of the sphere. The units are either in meters or grid cells. For the latter, the _in_cells suffix should be appended to the variable name.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]

This document was generated by Ilker Rafet Capoglu on December 12, 2012 using texi2html 1.82.