Spacecraft.ParticleFlux(Variable, Variable, Variable) Method

Top

Description

The ParticleFlux method uses the NASA AP-8 and AE-8 particle flux maps to calculate the omnidirectional flux of the specified particle type with the energy level specified by minimumEnergy. The AP/AE maps contain collected data of proton and electron fluxes in the Earth's radiation belt with energy ranges from 0.04 MeV to 7 MeV for electrons and from 0.1 MeV to 400 MeV for protons. See the help file for links to more detailed documentation on the AP/AE maps. The user has the option to specify epoch and longitude offsets to include in the flux calculation.

For more detailed information on the particle flux models, please see the Goddard Space Flight Center's description here: http://ccmc.gsfc.nasa.gov/modelweb/magnetos/aeap.html

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Method Signature

Spacecraft.ParticleFlux(	Variable minimumEnergy,
	Variable particleType,
	Variable solarActivity)

Arguments

minimumEnergy
Description:	Minimum energy of particles contributing to the flux. Energy values for electrons range from 0.1 to 7.0 MeV; for protons from 0.1 to 400.0 MeV.
Units:	MeV
Valid Range:	minimumEnergy > 0

particleType

Description:

The type of particle for which flux will be computed.

Valid Values:

Value	Label
0	electrons
1	protons

solarActivity

Description:

The solar activity level of the flux model. The AP-8/AE-8 flux maps use the 1964 IGRF Magnetic Field model when modeling solar minimum, and the 1970 IGRF Magnetic Field model when modeling solar maximum.

Valid Values:

Value	Label
0	solar minimum
1	solar maximum

Return Value

Type:	number
Units:	particles/(cm^2 s)

Returns the particle flux evaluated at the Spacecraft's Earth-relative position using the magnetic field model at the epoch of the flux model specified by particleType and solarActivity.

Syntax

myVariable1 = mySpacecraft1.ParticleFlux(myVariable2, myVariable3, myVariable4);