CalculateKResult

class rbinvariantslib.invariants.CalculateKResult(K: float, Bm: float, Bmin: float, mirror_latitude: float | None, starting_point: Tuple[float, float, float], trace_points: ndarray[Any, dtype[float64]], trace_latitude: ndarray[Any, dtype[float64]], trace_field_strength: ndarray[Any, dtype[float64]], integral_axis: ndarray[Any, dtype[float64]], integral_axis_latitude: ndarray[Any, dtype[float64]], integral_integrand: ndarray[Any, dtype[float64]], _trace: FieldLineTrace)

Bases: object

Class to hold the return value of calculate_K(). This class also provides information to inspect the bounce path determined while calculating K.

All arrays are sorted by magnetic latitude.

Parameters:

Kfloat

The second adiabatic invariant, in units of sqrt(G) * Re

Bmfloat

Magnetic field strength at mirroring point, in units of Gauss

Bminfloat

Minimum magnetic field strength along the bounce path, in units of Gauss

mirror_latitudefloat, optional

If mirroring point was specified in terms of a magnetic latitude, this is that magnetic latitude. Units of degrees in SM coordinate system.

starting_pointtuple of floats

Starting point of the field line trace used to determine the bounce path. Units of Re in SM coordinate system.

trace_pointsNDArray[np.float64]

Array of cartesian coordinates along the bounce path

trace_latitudeNDArray[np.float64]

Array of magnetic latitudes along the bounce path, in units of radians

trace_field_strengthNDArray[np.float64]

Array of magnetic field strengths along the bounce path, in units of Gauss.

integral_axis_latitudeNDArray[np.float64]

Corresponds to the intergration used to find K. These are the magnetic latitudes across the integration domain (bounce path)

integral_integrandNDArray[np.float64]

Corresponds to the intergration used to find K. These are the integrand values across the integration domain (bounce path)

Attributes Summary

Bm
Bmin
K
integral_axis
integral_axis_latitude
integral_integrand
mirror_latitude
starting_point
trace_field_strength
trace_latitude
trace_points

Attributes Documentation

Bm: float = <dataclasses._MISSING_TYPE object>

Bmin: float = <dataclasses._MISSING_TYPE object>

K: float = <dataclasses._MISSING_TYPE object>

integral_axis: ndarray[Any, dtype[float64]] = <dataclasses._MISSING_TYPE object>

integral_axis_latitude: ndarray[Any, dtype[float64]] = <dataclasses._MISSING_TYPE object>

integral_integrand: ndarray[Any, dtype[float64]] = <dataclasses._MISSING_TYPE object>

mirror_latitude: float | None = <dataclasses._MISSING_TYPE object>

starting_point: Tuple[float, float, float] = <dataclasses._MISSING_TYPE object>

trace_field_strength: ndarray[Any, dtype[float64]] = <dataclasses._MISSING_TYPE object>

trace_latitude: ndarray[Any, dtype[float64]] = <dataclasses._MISSING_TYPE object>

trace_points: ndarray[Any, dtype[float64]] = <dataclasses._MISSING_TYPE object>