uniform_null_point_find

plasmapy.analysis.nullpoint.uniform_null_point_find(
x_range,
y_range,
z_range,
func: Callable,
precision=(0.05, 0.05, 0.05),
maxiter: int = 500,
err: float = 1e-10,
)[source]

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

Note

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

Parameters:

  • x_range (array_like, default: [0, 1]) – A 1 by 2 array containing the range of x-values for the vector spaces.

  • y_range (array_like, default: [0, 1]) – A 1 by 2 array containing the range of y-values for the vector spaces.

  • z_range (array_like, default: [0, 1]) – A 1 by 2 array containing the range of z-values for the vector spaces.

  • func (function) – A function that takes in 3 arguments, respectively representing an \((x, y, z)\) coordinate of a point and returns the vector value for that point in the form of a 1 by 3 array.

  • precision (array_like, default: [0.05, 0.05, 0.05]) – A 1 by 3 array containing the approximate precision values for each dimension, in the case where uniform arrays are being used.

Returns:

An array of NullPoint objects representing the null points of the given vector space.

Return type:

array_like of NullPoint

Notes

This method is described by Haynes and Parnell [2007].