4.3.2 pde.grids.coordinates package

Package collecting classes representing orthonormal coordinate systems.

BipolarCoordinates

2-dimensional bipolar coordinates.

BisphericalCoordinates

3-dimensional bispherical coordinates.

CartesianCoordinates

N-dimensional Cartesian coordinates.

CylindricalCoordinates

3-dimensional cylindrical coordinates.

PolarCoordinates

2-dimensional polar coordinates.

SphericalCoordinates

3-dimensional spherical coordinates.

class BipolarCoordinates(scale_parameter=1)[source]

Bases: CoordinatesBase

2-dimensional bipolar coordinates.

Parameters:

scale_parameter (float)

axes: list[str] = ['σ', 'τ']

name of each coordinate axis

Type:

list

coordinate_limits: list[tuple[float, float]] = [(0, 6.283185307179586), (-inf, inf)]

the limits of each coordinate axis

Type:

list of tuple

dim: int = 2

spatial dimension of the coordinate system

Type:

int

class BisphericalCoordinates(scale_parameter=1)[source]

Bases: CoordinatesBase

3-dimensional bispherical coordinates.

Parameters:

scale_parameter (float)

axes: list[str] = ['σ', 'τ', 'φ']

name of each coordinate axis

Type:

list

coordinate_limits: list[tuple[float, float]] = [(0, 3.141592653589793), (-inf, inf), (0, 6.283185307179586)]

the limits of each coordinate axis

Type:

list of tuple

dim: int = 3

spatial dimension of the coordinate system

Type:

int

class CartesianCoordinates(dim)[source]

Bases: CoordinatesBase

N-dimensional Cartesian coordinates.

Parameters:

dim (int) – Dimension of the Cartesian coordinate system

class CylindricalCoordinates[source]

Bases: CoordinatesBase

3-dimensional cylindrical coordinates.

axes: list[str] = ['r', 'φ', 'z']

name of each coordinate axis

Type:

list

coordinate_limits: list[tuple[float, float]] = [(0, inf), (0, 6.283185307179586), (-inf, inf)]

the limits of each coordinate axis

Type:

list of tuple

dim: int = 3

spatial dimension of the coordinate system

Type:

int

class PolarCoordinates[source]

Bases: CoordinatesBase

2-dimensional polar coordinates.

axes: list[str] = ['r', 'φ']

name of each coordinate axis

Type:

list

coordinate_limits: list[tuple[float, float]] = [(0, inf), (0, 6.283185307179586)]

the limits of each coordinate axis

Type:

list of tuple

dim: int = 2

spatial dimension of the coordinate system

Type:

int

class SphericalCoordinates[source]

Bases: CoordinatesBase

3-dimensional spherical coordinates.

axes: list[str] = ['r', 'θ', 'φ']

name of each coordinate axis

Type:

list

coordinate_limits: list[tuple[float, float]] = [(0, inf), (0, 3.141592653589793), (0, 6.283185307179586)]

the limits of each coordinate axis

Type:

list of tuple

dim: int = 3

spatial dimension of the coordinate system

Type:

int

major_axis = 0