Vector Fields

CartesianVectorField

Bases: VectorField

Vector field defined by its components in the cartesian coordinate system (x, y, z). The components of the output vector field are cartesian (x, y, z).

CylindricalVectorField

Bases: VectorField

Vector field defined by its components in the cylindrical coordinate system (r, phi, z). The components of the output vector field are cartesian (x, y, z).

SphericalVectorField

Bases: VectorField

Vector field defined by its components in the spherical coordinate system (r, phi, theta). The components of the output vector field are cartesian (x, y, z).

RadialSphericalVectorField

Bases: VectorField

Vector field where all the vectors are pointing radially outwards from the origin. Point cloud specifying the positions of points at which the vector field is evaluated is taken as the input. The components of the output vector field are cartesian (x, y, z).

RadialCylindricalVectorField

Bases: VectorField

Vector field where all the vectors are pointing radially outwards from the line x=0, y=0. Point cloud specifying the positions of points at which the vector field is evaluated is taken as the input. The components of the output vector field are cartesian (x, y, z).

HyperbolicCylindricalVectorField

Bases: VectorField

Hyperbolic vector field centered at the line x=0, y=0. Point cloud specifying the positions of points at which the vector field is evaluated is taken as the input. The components of the output vector field are cartesian (x, y, z).

WindingCylindricalVectorField

Bases: VectorField

Vector field where the vectors rotate around the line x=0, y=0, based on the winding number. Point cloud specifying the positions of points at which the vector field is evaluated is taken as the input. The components of the output vector field are cartesian (x, y, z).

Parameters:
  • gamma (float | int | ndarray) –

    winding number.

gamma: float | int | np.ndarray property

Winding number.

Returns:
  • float | int | ndarray –

    Value of the set winding number.

AngledRadialCylindricalVectorField

Bases: VectorField

Modified radial vector field centered at the line x=0, y=0.

The vectors are at the specified angle with respect to the lines pointing outward from the line x=0, y=0. Point cloud specifying the positions of points at which the vector field is evaluated is taken as the input.

The components of the output vector field are cartesian (x, y, z).

Parameters:
  • alpha (float | int | ndarray) –

    Angle between the vectors and the equidistant surfaces from the line x=0, y=0.

alpha: float | int | np.ndarray property

Angle between the vectors and the equidistant surfaces from the line x=0, y=0.

Returns:
  • float | int | ndarray –

    Value of alpha.

VortexCylindricalVectorField

Bases: VectorField

Vortex vector field centered at the line x=0, y=0. Point cloud specifying the positions of points at which the vector field is evaluated is taken as the input. The components of the output vector field are cartesian (x, y, z).

AngledVortexCylindricalVectorField

Bases: VectorField

Modified vortex vector field centered at the line x=0, y=0. The vectors are at the specified angle with respect to the equidistant surfaces from the line x=0, y=0. Point cloud specifying the positions of points at which the vector field is evaluated is taken as the input. The components of the output vector field are cartesian (x, y, z).

Parameters:
  • alpha (float | int | ndarray) –

    Angle between the vectors and the equidistant surfaces from the line x=0, y=0.

alpha: float | int | np.ndarray property

Angle between the vectors and the equidistant surfaces from the line x=0, y=0.

Returns:
  • float | int | ndarray –

    Value of alpha.

XVectorField

Bases: VectorField

Vector field where only the X component (cartesian coordinates) is non-zero. Point cloud specifying the positions of points at which the vector field is evaluated is taken as the input. The components of the output vector field are cartesian (x, y, z).

YVectorField

Bases: VectorField

Vector field where only the Y component (cartesian coordinates) is non-zero. Point cloud specifying the positions of points at which the vector field is evaluated is taken as the input. The components of the output vector field are cartesian (x, y, z).

ZVectorField

Bases: VectorField

Vector field where only the Z component (cartesian coordinates) is non-zero. Point cloud specifying the positions of points at which the vector field is evaluated is taken as the input. The components of the output vector field are cartesian (x, y, z).

VectorFieldFromSDF

Bases: VectorField

Vector field constructed from an SDF. Point cloud specifying the value of the SDF is taken as an input. The components of the output vector field are cartesian (x, y, z).

Parameters:
  • grid_resolution (tuple | list | ndarray) –

    Number of points along each axis in the grid on which the SDF is evaluated.