plasmapy.analysis.nullpoint

Functionality to find and analyze 3D magnetic null points.

Note

This module is still under development and the API may change in future releases.

Classes

NullPoint(null_loc, classification)

A class for defining a null point in 3D space.

Point(loc)

Abstract class for defining a point in 3D space.

Inheritance diagram of plasmapy.analysis.nullpoint.NullPoint, plasmapy.analysis.nullpoint.Point

Exceptions

NonZeroDivergence()

A class for handling the exception raised by passing in a magnetic field that violates the zero divergence constraint.

NullPointError

A class for handling the exceptions of the null point finder functionality.

Inheritance diagram of plasmapy.analysis.nullpoint.NonZeroDivergence, plasmapy.analysis.nullpoint.NullPointError

Warnings

MultipleNullPointWarning

A class for handling the warning raised by passing in a magnetic field grid that may contain multiple null points in close proximity due to low resolution.

NullPointWarning

A class for handling the warnings of the null point finder functionality.

Inheritance diagram of plasmapy.analysis.nullpoint.MultipleNullPointWarning, plasmapy.analysis.nullpoint.NullPointWarning

Functions

null_point_find([x_arr, y_arr, z_arr, ...])

Returns an array of NullPoint object, representing the null points of the given vector space.

trilinear_approx(vspace, cell)

Return a function whose input is a coordinate within a given grid cell and returns the trilinearly approximated vector value at that particular coordinate in that grid cell.

uniform_null_point_find(x_range, y_range, ...)

Return an array of NullPoint objects, representing the null points of the given vector space.