get_tsyganenko¶
- dasilva_invariants.models.get_tsyganenko(model_name: str, params: Dict[str, ndarray[Any, dtype[float64]]], time: datetime, x_re_sm_grid: ndarray[Any, dtype[float64]], y_re_sm_grid: ndarray[Any, dtype[float64]], z_re_sm_grid: ndarray[Any, dtype[float64]], inner_boundary: float, external_field_only: bool = False) MagneticFieldModel¶
Helper function to get one of the tsyganenko fields on an LFM grid.
- Parameters:
- model_name{‘T96’, ‘TS05’}
Name of the magnetic field model to use.
- paramsdictionary of string to array
Parameters to support Tsyganenko magnetic field mode
- timedatetime, no timezone
Time to support the Tsyganenko magnetic field model
- x_re_sm_gridarray of shame (m, n, p)
x coordinates
- y_re_sm_gridarray of shame (m, n, p)
y coordinates
- z_re_sm_gridarray of shame (m, n, p)
z coordinates
- inner_boundaryfloat
Inner boundary of model
- external_field_onlybool
Set to True to not include the internal (dipole) model
- Returns:
- model
MagneticFieldModel Magnetic model on LFM grid with dipole field values. Grid is in units of Re and magnetic field is is units of Gauss.
- model
