simSetPlanetEnvironment

simSetPlanetEnvironment.centeredDipoleMagField(magFieldModule, name)[source]

Sets the centered dipole magnetic field model parameters for a particular planet

Parameters:
  • magFieldModule – magnetic field environment module

  • name – planet name string

simSetPlanetEnvironment.convertToIgrfDipoleCoefficients(nominalField, tilt, longitudeOfTilt, magFieldModule)[source]

Converts the NASA Magnetosphere parameters from https://nssdc.gsfc.nasa.gov/planetary/planetfact.html to IGRF compatible dipole coefficients.

Parameters:
  • nominalField – nominal magnetic field parameter given in Tesla

  • tilt – Dipole tilt to rotational axis in radians

  • longitudeOfTilt – Longitude of tilt in radians

  • magFieldModule – magnetic field environment module

simSetPlanetEnvironment.exponentialAtmosphere(atmosModule, name)[source]

Sets the exponential atmosphere model parameters for a particular planet.

Parameters:
  • atmosModule – atmospheric environment module

  • name – planet name string