SpaceEnvironmentMagneticField

class ansys.stk.core.stkobjects.SpaceEnvironmentMagneticField

Magnetic field settings.

Overview

Methods

compute_b_field_as_array	Compute geomagnetic field in Earth Fixed components, returned as the array (Bx, By, Bz), at the vehicle’s location location. Uses DateFormat and MagneticField Dimensions.
compute_dipole_l_shell	Compute dipole L-shell parameter at the vehicle’s location. Uses DateFormat Dimension.
compute_mcilwain_l_shell	Compute McIlwain L-shell parameter at the vehicle’s location. Uses DateFormat Dimension.
compute_b_over_beq	Compute B/Beq (i.e., the ratio of the magnetic field at the vehicle’s location to the minimum field intensity along the field line thru the location). Uses DateFormat Dimension.

Properties

main_field	Get or set the main magnetic field.
external_field	External magnetic field.
igrf_update_rate	Duration between updates of IGRF magnetic field model coefficients. Uses Time Dimension.

Import detail

from ansys.stk.core.stkobjects import SpaceEnvironmentMagneticField

Property detail

property SpaceEnvironmentMagneticField.main_field: SpaceEnvironmentMagneticMainField

Get or set the main magnetic field.

property SpaceEnvironmentMagneticField.external_field: SpaceEnvironmentMagneticExternalField

External magnetic field.

property SpaceEnvironmentMagneticField.igrf_update_rate: float

Duration between updates of IGRF magnetic field model coefficients. Uses Time Dimension.

Method detail

SpaceEnvironmentMagneticField.compute_b_field_as_array(self, time: Any) → list

Compute geomagnetic field in Earth Fixed components, returned as the array (Bx, By, Bz), at the vehicle’s location location. Uses DateFormat and MagneticField Dimensions.

Parameters:

time : Any

Returns:

list

SpaceEnvironmentMagneticField.compute_dipole_l_shell(self, time: Any) → float

Compute dipole L-shell parameter at the vehicle’s location. Uses DateFormat Dimension.

Parameters:

time : Any

Returns:

float

SpaceEnvironmentMagneticField.compute_mcilwain_l_shell(self, time: Any) → float

Compute McIlwain L-shell parameter at the vehicle’s location. Uses DateFormat Dimension.

Parameters:

time : Any

Returns:

float

SpaceEnvironmentMagneticField.compute_b_over_beq(self, time: Any) → float

Compute B/Beq (i.e., the ratio of the magnetic field at the vehicle’s location to the minimum field intensity along the field line thru the location). Uses DateFormat Dimension.

Parameters:

time : Any

Returns:

float