Geometric Classes

class Line(n, x0, x1)

This class defines and discretizes a 1D region to later be fed to create a Grid object.

Parameters:

  • n (int) – Number of bins along the line.

  • x0 (np.float64 [3]) – First point along the line.

  • x1 (np.float64 [3]) – Final point along the line.

xyz

The points on the grid in Cartesian coordinates. Indexed as [gridpoint, direction].

Type:

np.float64 [:,:]

ehat

The unit vector pointing from x0 to x1

Type:

np.float64 [3]

class Plane(n, origin, zyz, sides)

This class defines and discretizes a 2D region to later be fed to create a Grid object.

Parameters:

  • n (list(int)) – Number of bins along the u and v axes of the plane (defined w.r.t. x, y, z using zyz argument).

  • origin (np.float64 [3]) – Center of the plane in Cartesian coordinates

  • zyz (np.float64 [3]) – Euler ZYZ angles defining u, v from rotations of Cartesian coordinates. Convention is [a, b, c] -> R_{z}(c)R_{y}(b)R_{z}(a)

  • sides (np.float64 [2]) – Side lengths for u, v.

xyz

The points on the grid in Cartesian coordinates. Indexed as [gridpoint in u, gridpoint in v, direction].

Type:

np.float64 [:,:,:]

bas

The basis vectors of the plane. Indexed as [direction, parametric coordinate]

Type:

np.float64 [:,:]

class Box(n, origin, zyz, sides)

This class defines and discretizes a 3D region to later be fed to create a Grid object.

Parameters:

  • n (list(int)) – Number of bins along the u, v, and w axes of the box (defined w.r.t. x, y, z using zyz argument).

  • origin (np.float64 [3]) – Center of the box in Cartesian coordinates

  • zyz (np.float64 [3]) – Euler ZYZ angles defining u, v, and w from rotations of Cartesian coordinates. Convention is [a, b, c] -> R_{z}(c)R_{y}(b)R_{z}(a)

  • sides (np.float64 [2]) – Side lengths along u, v, and w.

xyz

The points on the grid in Cartesian coordinates. Indexed as [gridpoint in u, gridpoint in v, gridpoint in w, direction].

Type:

np.float64 [:,:,:,:]

bas

The basis vectors of the box. Indexed as [direction, parametric coordinate]

Type:

np.float64 [:,:]