null_point_find

plasmapy.analysis.nullpoint.null_point_find(
x_arr=None,
y_arr=None,
z_arr=None,
u_arr=None,
v_arr=None,
w_arr=None,
maxiter: int = 500,
err: float = 1e-10,
)[source]

Returns an array of NullPoint object, 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_arr (array_like) – The array representing the coordinates in the x-dimension. If not given, then range values are used to construct a uniform array on that interval.

  • y_arr (array_like) – The array representing the coordinates in the y-dimension. If not given, then range values are used to construct a uniform array on that interval.

  • z_arr (array_like) – The array representing the coordinates in the z-dimension. If not given, then range values are used to construct a uniform array on that interval.

  • u_arr (array_like) – A 3D array containing the x-component of the vector values for the vector space. If not given, the vector values are generated over the vector space using the function func.

  • v_arr (array_like) – A 3D array containing the y-component of the vector values for the vector space. If not given, the vector values are generated over the vector space using the function func.

  • w_arr (array_like) – A 3D array containing the z-component of the vector values for the vector space. If not given, the vector values are generated over the vector space using the function func.

  • maxiter (int, default: 500) – The maximum iterations of the Newton-Raphson method.

  • err (float, default: 1e-10) – The threshold/error that determines if convergence has occurred using the Newton-Raphson method.

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].