CalculateLStarResult

class rbinvariantslib.invariants.CalculateLStarResult(LStar: float, drift_local_times: ndarray[Any, dtype[float64]], drift_rvalues: ndarray[Any, dtype[float64]], drift_K: ndarray[Any, dtype[float64]], drift_K_results: List[CalculateKResult], drift_is_closed: bool, integral_axis: ndarray[Any, dtype[float64]], integral_theta: ndarray[Any, dtype[float64]], integral_integrand: ndarray[Any, dtype[float64]], ivp_result: Any)

Bases: object

Class to hold the return value of calculate_LStar(). This includes the LStar adiabatic invariant as well as all details required to reconstruct the full drift shell.

Parameters:

LStarfloat

Third adiabatic invariant (L*), unitless

drift_local_timesNDArray[np.float64]

Array of magnetic local times around the drive shell.

drift_rvaluesNDArray[np.float64]

Array of drift shell radius at each local time, to be paired with drift_local_times

drift_KNDArray[np.float64]

Array of second adiabatic invariant (K) at each local time, to be paired with drift_local_times

drift_K_resultsdictionary of float to CalculateKResult

Dict mapping local time to CalculateKResult, to be paired with drift_local_times. Through this object one can obtain a bounce motion path at each local time.

drift_is_closedbool

Boolean whether the drift shell was detected to be closed. For more information, see da Silva et al., 2023

integral_axisNDArray[np.float64]

Corresponding to the integral used to calculate LStar, this is the integration axis in local time. Units of radians

integral_thetaNDArray[np.float64]

Corresponding to the integral used to calculate LStar, this is the variable integrated over. Units of radians

integral_integrandNDArray[np.float64]

Corresponding to the integral used to calculate LStar, this is the integrand

Attributes Summary

LStar
drift_K
drift_K_results
drift_is_closed
drift_local_times
drift_rvalues
integral_axis
integral_integrand
integral_theta
ivp_result

Attributes Documentation

LStar: float = <dataclasses._MISSING_TYPE object>

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

drift_K_results: List[CalculateKResult] = <dataclasses._MISSING_TYPE object>

drift_is_closed: bool = <dataclasses._MISSING_TYPE object>

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

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

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

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

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

ivp_result: Any = <dataclasses._MISSING_TYPE object>