gtsimulation.MagneticFields.Magnetosphere package

Submodules

gtsimulation.MagneticFields.Magnetosphere.Additions.AddLon(lon_total, lon_prev, full_revolutions, index, a_, b_)[source]
gtsimulation.MagneticFields.Magnetosphere.Additions.AddTrajectory(f, b, lonTotal, lon, additions_i, Nm, I1, I2, s)[source]
gtsimulation.MagneticFields.Magnetosphere.Additions.FieldLine(simulator, Rinp, sgn)[source]
gtsimulation.MagneticFields.Magnetosphere.Additions.FindParticleOrigin(Simulator, RetArr_i)[source]
gtsimulation.MagneticFields.Magnetosphere.Additions.GetBCparams(RetArr_i)[source]
gtsimulation.MagneticFields.Magnetosphere.Additions.GetEarthBfieldLine(simulator, rinp)[source]
gtsimulation.MagneticFields.Magnetosphere.Additions.GetLarmorRadius(T0, Hn, Z, M, pitch)[source]
gtsimulation.MagneticFields.Magnetosphere.Additions.GetLshell(I2, Hm)[source]
gtsimulation.MagneticFields.Magnetosphere.Additions.GetParticleOrigin(TrackParams_i)[source]
gtsimulation.MagneticFields.Magnetosphere.Additions.GetTrackParams(Simulator, RetArr_i)[source]
class gtsimulation.MagneticFields.Magnetosphere.Dipole.Dipole(date: int | datetime = 0, units='SI_nT', M=None, psi=0, **kwargs)[source]

Bases: AbsBfield

CalcBfield(x, y, z, **kwargs)[source]
static GetNDaysInMonth(year, month)[source]
Re = 6371137.0
ToMeters = 6378137.1
UpdateState(new_date: datetime)[source]
to_string()[source]
class gtsimulation.MagneticFields.Magnetosphere.Gauss.Gauss(date: datetime, model: GaussModels | str, model_type: GaussTypes | str, version=None, coord: int = 1, **kwargs)[source]

Bases: AbsBfield

CalcBfield(x, y, z, **kwargs)[source]
SetFullModelName()[source]
ToMeters = 1000.0
UpdateState(new_date)[source]
to_string()[source]
class gtsimulation.MagneticFields.Magnetosphere.Gauss.GaussModels(*values)[source]

Bases: Enum

CHAOS = 2
CM = 3
COV_OBS = 4
DIFI = 7
IGRF = 1
LCS = 5
SIFM = 6
class gtsimulation.MagneticFields.Magnetosphere.Gauss.GaussTypes(*values)[source]

Bases: Enum

core = 1
ionosphere = 3
static = 2
class gtsimulation.MagneticFields.Magnetosphere.Tsyganenko.Tsyganenko(date: datetime = datetime.datetime(2000, 1, 1, 0, 0), ModCode='96', **kwargs)[source]

Bases: 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.

Parameters:

  • date (datetime.datetime) – Date for model initialization (default: 2000-01-01)

  • ModCode (str) – Model version selector (89, 96, 15B)

  • kwargs – Additional arguments for base class

Raises:

ValueError – If date is outside model’s valid range

CalcBfield(x, y, z, **kwargs)[source]
ToMeters = 6378137.1
UpdateState(new_date)[source]
to_string()[source]

Module contents