gtsimulation.magnetic_field

Magnetic field models.

This subpackage provides an abstract interface for custom magnetic field implementations as well as several predefined magnetic field models, including a uniform magnetic field.

Classes

AbsBfield([use_tesla, use_meters])
Summed(models, **kwargs)
Uniform(B, **kwargs)

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

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.magnetic_field.Summed(models, **kwargs)

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

UpdateState(new_date: datetime)

to_string()

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

CalcBfield(*args, **kwargs)

UpdateState(new_date)

to_string()

Modules

galaxy
heliosphere
magnetosphere