Source code for gtsimulation.magnetic_field.magnetosphere._tsyganenko

from datetime import datetime
from pathlib import Path
import numpy as np

from gtsimulation.common import Units, Regions
from gtsimulation.magnetic_field import AbsBfield
from gtsimulation.magnetic_field.magnetosphere.Functions import transformations, t89, t96, t15B, gauss


[docs] class Tsyganenko(AbsBfield): """ Tsyganenko empirical magnetospheric magnetic field model (T89/T96). This class provides an interface to compute the magnetic field components in the Earth's magnetosphere using the Tsyganenko empirical models (T89 or T96). The model type is selected via the `ModCode` parameter. :param date: Date for model initialization (default: 2000-01-01) :type date: datetime.datetime :param ModCode: Model version selector (89, 96, 15B) :type ModCode: str :raises ValueError: If date is outside model's valid range """ to_meters = Units.RE2m def __init__(self, date: datetime = datetime(2000, 1, 1), ModCode="96"): super().__init__() self.ModelName = "Tsyganenko" self.Region = Regions.Magnetosphere self.mod_code = str(ModCode) self.T_input = None if self.mod_code == '15B': self.T_input = np.load(Path(__file__).resolve().parent.joinpath("Data", "T_input15B_short.npy")) elif self.mod_code in ["89", "96"]: self.T_input = np.load(Path(__file__).resolve().parent.joinpath("Data", "T_input_short.npy")) else: raise ValueError("ModCode must take one of the values '89', '96', '15B'.") if not self.T_input['date'][0] <= date <= self.T_input['date'][-1]: raise ValueError(f"Input date must be between {self.T_input['date'][0]} and {self.T_input['date'][-1]}.") self.Date = date self.__set_psi_ind() def __set_psi_ind(self): self.year = self.Date.year self.doy = self.Date.timetuple().tm_yday self.sec = self.Date.second + 60 * self.Date.minute + 3600 * self.Date.hour self.DTnum = self.Date.toordinal() # + 366 self.ps = self._get_psi() self.parmod = self._get_ind() def _get_psi(self): self.g, self.h, _ = gauss.LoadGaussCoeffs( Path(__file__).resolve().parent.joinpath( "Earth", "IGRF13", "igrf13coeffs.npy" ), self.Date ) # Direction of the centered geomagnetic dipole in GEO dipole_geo = transformations.get_dipole_direction( self.g, self.h ) # Transform dipole direction GEO -> GSM x, _, _ = transformations.geo2gsm( dipole_geo[0], dipole_geo[1], dipole_geo[2], self.year, self.doy, self.sec, self.g, self.h ) # In GSM coordinates: D_x = sin(psi) psi = np.arcsin(np.clip(x, -1.0, 1.0)) return psi def _get_ind(self): ia = np.argmax(self.T_input['date'] >= self.Date) match self.mod_code: case "89": return self.T_input['T89_input'][ia] case "96": return self.T_input['T96_input'][ia].astype(np.float32) case "15B": return self.T_input["T15B_input"][ia].astype(np.float32) case _: return None
[docs] def calc_field(self, x, y, z): X, Y, Z = transformations.geo2gsm(x, y, z, self.year, self.doy, self.sec, self.g, self.h) Bx, By, Bz = 0, 0, 0 if self.mod_code == "89": Bx, By, Bz = t89.t89(self.parmod, self.ps, X, Y, Z) elif self.mod_code == "96": Bx, By, Bz = t96.t96(self.parmod, self.ps, X, Y, Z) elif self.mod_code == "15B": Bx, By, Bz = t15B.t15B(self.parmod, self.ps, X, Y, Z) Bx, By, Bz = transformations.geo2gsm(Bx, By, Bz, self.year, self.doy, self.sec, self.g, self.h, inverse=True) return Bx, By, Bz
[docs] def update_state(self, new_date): self.Date = new_date self.__set_psi_ind()
def __str__(self): return ( "Tsyganenko\n" f"\tMode: {self.mod_code}\n" f"\tPsi: {self.ps}" )