gtsimulation.MagneticFields package

Subpackages

• gtsimulation.MagneticFields.Galaxy package
  • Submodules
    • JF12mod
      • JF12mod.CalcBfield()
      • JF12mod.ToMeters
      • JF12mod.UpdateState()
      • JF12mod.to_string()
    • ModelTypes
      • ModelTypes.base
      • ModelTypes.cre10
      • ModelTypes.expX
      • ModelTypes.neCL
      • ModelTypes.nebCor
      • ModelTypes.synCG
      • ModelTypes.twistX
    • UF23
      • UF23.CalcBfield()
      • UF23.ToMeters
      • UF23.UpdateState()
      • UF23.to_string()
  • Module contents
• gtsimulation.MagneticFields.Heliosphere package
  • Submodules
    • Parker
      • Parker.CalcBfield()
      • Parker.CalcTiltAngle()
      • Parker.HCS()
      • Parker.ToMeters
      • Parker.UpdateState()
      • Parker.a()
      • Parker.km2AU
      • Parker.omega
      • Parker.rs
      • Parker.to_string()
      • Parker.v_wind()
      • Parker.years11
    • ParkerUniform
      • ParkerUniform.CalcBfield()
      • ParkerUniform.to_string()
    • UniformHelio
      • UniformHelio.CalcBfield()
      • UniformHelio.ToMeters
      • UniformHelio.UpdateState()
      • UniformHelio.calc_spectrum_2d()
      • UniformHelio.calc_spectrum_slab()
      • UniformHelio.to_string()
  • Module contents
• gtsimulation.MagneticFields.Magnetosphere package
  • Submodules
    • AddLon()
    • AddTrajectory()
    • FieldLine()
    • FindParticleOrigin()
    • GetBCparams()
    • GetEarthBfieldLine()
    • GetLarmorRadius()
    • GetLshell()
    • GetParticleOrigin()
    • GetTrackParams()
    • Dipole
      • Dipole.CalcBfield()
      • Dipole.GetNDaysInMonth()
      • Dipole.Re
      • Dipole.ToMeters
      • Dipole.UpdateState()
      • Dipole.to_string()
    • Gauss
      • Gauss.CalcBfield()
      • Gauss.SetFullModelName()
      • Gauss.ToMeters
      • Gauss.UpdateState()
      • Gauss.to_string()
    • GaussModels
      • GaussModels.CHAOS
      • GaussModels.CM
      • GaussModels.COV_OBS
      • GaussModels.DIFI
      • GaussModels.IGRF
      • GaussModels.LCS
      • GaussModels.SIFM
    • GaussTypes
      • GaussTypes.core
      • GaussTypes.ionosphere
      • GaussTypes.static
    • Tsyganenko
      • Tsyganenko.CalcBfield()
      • Tsyganenko.ToMeters
      • Tsyganenko.UpdateState()
      • Tsyganenko.to_string()
  • Module contents

Submodules

class gtsimulation.MagneticFields.magnetic_field.AbsBfield(use_tesla=True, use_meters=True, **kwargs)

Bases: ABC

abstractmethod CalcBfield(x, y, z, **kwargs)

GetBfield(x, y, z, **kwargs)

ToMeters = 1

abstractmethod UpdateState(new_date)

classmethod from_meters(x, y, z)

abstractmethod to_string()

static to_tesla(Bx, By, Bz)

class gtsimulation.MagneticFields.summed_field.Summed(models, **kwargs)

Bases: AbsBfield

CalcBfield(x, y, z, **kwargs)

UpdateState(new_date: datetime)

to_string()

class gtsimulation.MagneticFields.uniform.Uniform(B, **kwargs)

Bases: AbsBfield

CalcBfield(*args, **kwargs)

UpdateState(new_date)

to_string()

Module contents

class gtsimulation.MagneticFields.AbsBfield(use_tesla=True, use_meters=True, **kwargs)

Bases: ABC

abstractmethod CalcBfield(x, y, z, **kwargs)

GetBfield(x, y, z, **kwargs)

ToMeters = 1

abstractmethod UpdateState(new_date)

classmethod from_meters(x, y, z)

abstractmethod to_string()

static to_tesla(Bx, By, Bz)

class gtsimulation.MagneticFields.Summed(models, **kwargs)

Bases: AbsBfield

CalcBfield(x, y, z, **kwargs)

UpdateState(new_date: datetime)

to_string()

class gtsimulation.MagneticFields.Uniform(B, **kwargs)

Bases: AbsBfield

CalcBfield(*args, **kwargs)

UpdateState(new_date)

to_string()