NumericalPropagatorOptions

Numerical orbit propagator options

Since R2024a

Description

Options used by numerical orbit propagator

Creation

You can create NumericalPropagatorOptions objects using the numericalPropagator function of a satelliteScenario object.

Properties

ODESolver — ODE solver used by propagator

'ode45' (default) | 'ode23' | 'ode78' | 'ode89' | 'ode113' | 'ode15s' | 'ode23s' | 'ode23t' | 'ode23tb'

Ordinary differential equation solver (ODE) used by the numerical orbit propagator, specified as 'ode45', 'ode23', 'ode78', 'ode89', 'ode113', 'ode15s', 'ode23s','ode23t', or 'ode23tb'.

ODESet — Options structure for ODE solver

structure returned by odeset(RelTol=1e-8,AbsTol=1e-8) (default)

Structure defining options used by the ordinary differential equations solver, specified using odeset.

Data Types: struct

GravitationalPotentialModel — Gravitational potential model of Earth

'spherical-harmonics' (default) | 'point-mass' | 'oblate-ellipsoid'

Gravitational potential model of Earth, specified as 'spherical-harmonics', 'point-mass', or 'oblate-ellipsoid'.

SphericalHarmonicModel — Spherical harmonic model of gravitational potential of Earth

'EGM2008' (default) | 'EGM96' | 'EIGENGL04C'

Spherical harmonic model of gravitational potential of the Earth, specified as one of 'EGM2008', 'EGM96', or 'EIGENGL04C'.

Dependencies

To use this input, GravitationalPotentialModel must be set to 'spherical-harmonics'.

SphericalHarmonicDegree — Spherical harmonic degree of gravitational potential of Earth

120 (default) | scalar

Spherical harmonic degree of gravitational potential of the Earth, specified as a scalar.

Dependencies

To use this input, SphericalHarmonicModel must be set to 'spherical-harmonics'.

Data Types: double

IncludeAtmosDrag — Option to indicate whether propagator must account for atmospheric drag

false or 0 (default) | true or 1

Option to indicate whether propagator must account for atmospheric drag, specified as false (0) or true (1). When set to true, the propagator calculates atmospheric drag based on the NRLMSISE-00 model for atmospheric density.

UseSpaceWeatherDataFile — Option to use MAT file containing consolidated space weather data file in atmospheric density calculation

false or 0 (default) | true or 1

Option to use MAT file containing consolidated space weather data file in atmospheric density calculation, specified as false (0) or true (1). See aeroReadSpaceWeatherData for more information on how to generate this MAT file.

Dependencies

To use this input IncludeAtmosDrag must be set to true.

SpaceWeatherDataFile — MAT file containing consolidated space weather data file for atmospheric density calculation

"aeroSpaceWeatherData.mat" (default) | character vector | string

MAT file containing consolidated space weather data file in atmospheric density calculation, specified as a string or character vector.

Dependencies

To use this property IncludeAtmosDrag and UseSpaceWeatherDataFilemust be set to true or 1.

F107ExtrapMethod — Method used for extrapolating F10.7 solar flux for times outside range of space weather data file

'none-clip' (default) | 'constant' | 'least-squares-fit'

Method used for extrapolating F10.7 solar flux for times outside range of space weather data file, specified as one of:

• 'none-clip' — F10.7 value is set to the nearest data point available in the space weather data file.

• 'constant' — F10.7 value is set to a constant value specified by the F107ExtrapValue name-value argument.

• 'least-squares-fit' — F10.7 value is approximated using a least-squares fit of the space weather data from October 1, 1957, to December 1, 2040, using the trigonometric function a+bcos(ct + dsin(et)).

Dependencies

To use this input IncludeAtmosDrag and UseSpaceWeatherDataFile must be set to true or 1.

F107ExtrapValue — Extrapolation value for the F10.7 solar flux

150 (default) | nonnegative scalar

Extrapolation value for the F10.7 solar flux, specified as a nonnegative scalar.

Dependencies

To use this input 'F107ExtrapMethod' must be set to 'constant' and scenario simulation time must be outside the range of the data in the space weather data file.

F107Average — Centered 81-day average value of the F10.7 solar flux

150 (default) | nonnegative scalar

Centered 81-day average value of the F10.7 solar flux, specified as a nonnegative scalar.

Dependencies

To use this input UseSpaceWeatherDataFile must be set to false.

F107Daily — Daily value of the F10.7 solar flux

150 (default) | nonnegative scalar

Daily value of the F10.7 solar flux, specified as a nonnegative scalar.

Dependencies

To use this input UseSpaceWeatherDataFile must be set to false.

MagneticIndexExtrapMethod — Method used for extrapolating magnetic index for times outside range of space weather data file

'none-clip' (default) | 'constant' | 'least-squares-fit'

Method used for extrapolating magnetic index for times outside range of space weather data file, specified as one of:

• 'none-clip' — Magnetic index is set to the nearest data point available in the space weather data file.

• 'constant' — Magnetic index is set to a constant value specified by the MagneticIndexExtrapValue.

• 'igrf' — Magnetic index is calculated using International Geomagnetic Reference Field. Because this model is defined for times between January 1, 1900, 12:00 AM UTC and January 1, 2025, 12:00 AM UTC, the predictions for times outside this range are clipped to values at these time limits.

MagneticIndexExtrapValue — Extrapolation value for magnetic index

4 (default) | nonnegative scalar

Extrapolation value for the magnetic index, specified as a nonnegative scalar.

Dependencies

This property is available when:

• MagneticIndexExtrapMethod is set to 'constant'.

• The scenario simulation time is outside the range of the data in the space weather data file.

• IncludeAtmosDrag and UseSpaceWeatherDataFile are set to true.

MagneticIndex — Magnetic index information

[4 4 4 4 4 4 4] | 7-element row vector

Magnetic index information, specified as a 7-element row vector. This value consists of magnetic index representing a daily value (AP), 3 hour AP for a reference time, 3 hour AP for 3 hours before the reference time, 3 hour AP for 6 hours before the reference time, 3 hour AP for 9 hours before the reference time, average of eight 3 hour AP indices from 12 to 33 hours prior to the reference time, and average of eight 3 hour AP indices from 36 to 57 hours prior to the reference time. This vector is constant for the entire scenario.

Dependencies

This property is used when UseSpaceWeatherDataFile is set to false and IncludeAtmosDrag is true.

IncludeAnomalousOxygen — Option to specify whether anomalous oxygen must be included in atmospheric mass density calculation

true or 1 (default) | false or 0

Option to specify whether anomalous oxygen must be included in atmospheric mass density calculation, specified as false (0) or true (1).

Dependencies

This property is available when IncludeAtmosDrag is set to true.

AtmosFlags — Option to activate or deactivate particular variations in atmospheric mass density calculation

int32(1,23) (default) | vector

Option to activate or deactivate particular variations in atmospheric mass density calculation, specified as an int32 vector of 23 elements. The elements are defined in this order:

AtmosFlags elements

Element	Value
1	F10.7 effect on mean
2	Independent of time
3	Symmetrical annual
4	Symmetrical semiannual
5	Asymmetrical annual
6	Asymmetrical semiannual
7	Diurnal
8	Semidiurnal
9	Daily AP. If you set this value to -1, the atmospheric mass density computation uses the entire magnetic index information that includes the 3-hour averages, as opposed to just the daily value.
10	All UT seconds, longitudinal effects
11	Longitudinal
12	UT seconds and mixed UT seconds, longitudinal
13	Mixed AP, UT seconds, longitudinal
14	Terdiurnal
15	Departures from diffusive equilibrium
16	All exospheric temperature variations
17	All variations from 120,000 meter temperature (TLB)
18	All lower thermosphere (TN1) temperature variations
19	All 120,000 meter gradient (S) variations
20	All upper stratosphere (TN2) temperature variations
21	All variations from 120,000 meter values (ZLB)
22	All lower mesosphere temperature (TN3) variations
23	Turbopause scale height variations

With the exception of element 9 (daily AP), the elements are specified as 0 or 1. Element 9 is specified as -1, 0 or 1.

Dependencies

This property is available when IncludeAtmosDrag is set to true

IncludeThirdBodyGravity — Option to specify whether third body gravity should be included

false or 0 (default) | true or 1

Option to specify whether third body gravity should be included, specified as false (0) or true (1).The third body gravity sources are assumed to be point masses.

ThirdBodyGravitySource — Third body gravity source

'sun' (default) | 'moon' | 'mercury' | 'venus' | 'mars' | 'jupiter' | 'saturn' | 'uranus' | 'neptune' | 'pluto'

Third body gravity source, specified as one of 'sun', 'moon', 'mercury', 'venus', 'mars', 'jupiter', 'saturn', 'uranus', 'neptune', or 'pluto'.

IncludeSRP — Option to indicate whether solar radiation pressure should be included

false or 0 (default) | true or 1

Option to indicate whether solar radiation pressure should be included, specified as false (0) or true (1).

SolarFluxPressure — Solar flux pressure acting on the satellite

4.5344321e-6 | nonnegative scalar

Solar flux pressure acting on the satellite, specified as a nonnegative scalar in W*s/m³.

Data Types: double

EclipseModel — Eclipse model used in the solar radiation pressure computation

'dual-cone' (default) | 'cylindrical'

Eclipse model used in the solar radiation pressure computation, specified as one of 'dual-cone' or 'cylindrical'.

IncludeLunarEclipse — Option to indicate whether lunar eclipse must be included in solar radiation pressure calculation

false or 0 (default) | true or 1

Option to indicate whether lunar eclipse must be included in solar radiation pressure calculation, specified as false (0) or true (1).

Data Types: logical

EphemerisModel — Celestial body ephemeris model used in computation of third body gravity and solar radiation pressure

'de405' (default) | 'de421' | 'de423' | 'de430' | 'de432t'

Celestial body ephemeris model used in the computation of third body gravity and solar radiation pressure, specified as one of:

• 'de405' — Released in 1998. This ephemerides takes into account the Julian date range 2305424.50 (December 9, 1599) to 2525008.50 (February 20, 2201).

• 'de421' — Released in 2008. This ephemerides takes into account the Julian date range 2414992.5 (December 4, 1899) to 2469808.5 (January 2, 2050).

• 'de423' — Released in 2010. This ephemerides takes into account the Julian date range 2378480.5 (December 16, 1799) to 2524624.5 (February 1, 2200).

• 'de430' — Released in 2013. This ephemerides takes into account the Julian date range 2287184.5 (December 21, 1549) to 2688976.5 (January 25, 2650).

• 'de432t' — Released in April 2014. This ephemerides takes into account the Julian date range 2287184.5, (December 21, 1549 ) to 2688976.5, (January 25, 2650).

Data Types: string

Version History

Introduced in R2024a