Aero.spacecraft.NumericalPropagatorOptions
Description
Options used by numerical orbit propagator in propagateOrbit.
Creation
Description
options = Aero.spacecraft.NumericalPropagatorOptions
creates an
Aero.spacecraft.NumericalPropagatorOptions
object, options
, using default
properties.
options = Aero.spacecraft.NumericalPropagatorOptions(Name=Value)
creates an Aero.spacecraft.NumericalPropagatorOptions
object using additional parameters specified by
one or more name-value arguments.
Properties
Specify these properties as name-value arguments.
Ordinary differential equation (ODE) solver used by the numerical orbit propagator,
specified as "ode45"
, "ode23"
,
"ode78"
, "ode89"
, "ode113"
,
"ode15s"
,
"ode23s"
,"ode23t"
, or
"ode23tb"
.
Options structure for ODE solver, specified as a structure returned by odeset
function.
Data Types: struct
Gravitational potential model of central body, specified as
"spherical-harmonics"
, "point-mass"
, or
"oblate-ellipsoid"
.
Default Values
The default value is
"spherical-harmonics"
when the CentralBody property ofAero.spacecraft.CentralBodyOptions
object set by the CentralBodyOptions property is set toEarth
,Moon
, orMars
.In all other cases, the default value is
"oblate-ellipsoid"
.
Dependencies
To set the value of GravitationalPotentialModel
to
"spherical-harmonics"
, ensure that the
CentralBody
property of Aero.spacecraft.CentralBodyOptions
object set by the CentralBodyOptions property is set to one of
Earth
, Moon
, or
Mars
.
Spherical harmonic model of gravitational potential of the central body, when
GravitationalPotentialModel is set to
"spherical-harmonics"
, specified as one of:
'EGM2008'
,'EGM96'
, or'EIGENGL04C'
when the CentralBody property ofAero.spacecraft.CentralBodyOptions
object set by the CentralBodyOptions property is set toEarth
.'LP100K'
and'LP165P'
when the CentralBody property ofAero.spacecraft.CentralBodyOptions
object set by the CentralBodyOptions property is set toMoon
.'GMM2B'
when the CentralBody property ofAero.spacecraft.CentralBodyOptions
object set by the CentralBodyOptions property is set toMars
.
Default Values
The default value is:
'EGM2008'
when the CentralBody property ofAero.spacecraft.CentralBodyOptions
object set by the CentralBodyOptions property is set toEarth
.'LP100K'
when the CentralBody property ofAero.spacecraft.CentralBodyOptions
object set by the CentralBodyOptions property is set toMoon
.'GMM2B'
when the CentralBody property ofAero.spacecraft.CentralBodyOptions
object set by the CentralBodyOptions property is set toMars
.When the CentralBody property of
Aero.spacecraft.CentralBodyOptions
object set by the CentralBodyOptions property is not set toEarth
,Moon
, orMars
, the value ofSphericalHarmonicModel
is " ", and you cannot modify the value.
Dependencies
To use this property, GravitationalPotentialModel must be set to
'spherical-harmonics'
.
Degree of the spherical harmonic gravitational potential model, when GravitationalPotentialModel is set to
"spherical-harmonics"
, specified as one of:
120 when SphericalHarmonicModel is set to
'EGM2008'
,'EGM96'
,'EIGENGL04C'
, or'LP165P'
.100 when SphericalHarmonicModel is set to
'LP100K'
.80 when SphericalHarmonicModel is set to
'GMM2B'
.
Dependencies
To use this property, SphericalHarmonicModel
must be set to
'spherical-harmonics'
.
Data Types: double
Option to indicate whether the numerical orbit propagator must account for atmospheric
drag, specified as false
or true
. When set to
true
, the propagator calculates atmospheric drag based on the
NRLMSISE-00 model for atmospheric density.
Dependencies
To set this property to true
, the Aero.spacecraft.CentralBodyOptions
object set by the CentralBodyOptions property must be set to Earth
.
Otherwise, this property is hidden, read-only, and set to false.
Option to use MAT file containing consolidated space weather data file in atmospheric density
calculation, specified as false
or true
. For more
information on how to generate this MAT file, see aeroReadSpaceWeatherData
.
Dependencies
To use this property, IncludeAtmosDrag
must be set to
true
.
MAT file containing consolidated space weather data file in atmospheric density
calculation, specified as a character vector or string. See aeroReadSpaceWeatherData
for more information on how to generate this
MAT file.
Dependencies
To use this property, IncludeAtmosDrag
and
UseSpaceWeatherDataFile
must be set to
true
.
Method used for extrapolating F10.7 solar flux for times outside range of space weather data file, specified as one of these values:
'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 theF107ExtrapValue
property.'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 property, IncludeAtmosDrag
and
UseSpaceWeatherDataFile
must be set to
true
.
Extrapolation value for the F10.7 solar flux for times outside the date range of the space weather data file, specified as a nonnegative scalar.
Dependencies
To use this property:
IncludeAtmosDrag
, andUseSpaceWeatherDataFile
must be set to true.'F107ExtrapMethod'
must be set to'constant'
.
Centered 81-day average value of the F10.7 solar flux, specified as a nonnegative scalar.
Dependencies
To use this property:
IncludeAtmosDrag
must be set totrue
.UseSpaceWeatherDataFile
must be set tofalse
.
Daily value of the F10.7 solar flux, specified as a nonnegative scalar.
Dependencies
To use this property:
IncludeAtmosDrag
must be set totrue
.UseSpaceWeatherDataFile
must be set tofalse
.
Method used for extrapolating magnetic index for times outside range of space weather data file, specified as one of these values:
'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 theMagneticIndexExtrapValue
property.'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.
Dependencies
To use this property, IncludeAtmosDrag
and
UseSpaceWeatherDataFile
must be set to
true
.
Extrapolation value for the magnetic index for times outside the date range in space weather data file, specified as a nonnegative scalar.
Dependencies
To use this property:
MagneticIndexExtrapMethod
is set to'constant'
.IncludeAtmosDrag
andUseSpaceWeatherDataFile
must be set totrue
.
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 three hours before the reference time, 3-hour AP for six hours before the reference time, 3-hour AP for nine 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 orbit propagation.
Dependencies
To use this property:
UseSpaceWeatherDataFile
must be set tofalse
.IncludeAtmosDrag
must betrue
.
Option to specify whether anomalous oxygen must be included in atmospheric mass
density calculation, specified as true
or
false
.
Dependencies
To use this property, IncludeAtmosDrag
must be set to
true
.
Option to activate or deactivate particular variations in atmospheric mass density calculation, specified as a double 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
To use this property, IncludeAtmosDrag
must be set to
true
.
Option to include third body gravity, specified as false
or
true
.The third body gravity sources are assumed to be point
masses.
Third body gravity source, specified as a string containing a combination of
'Sun'
, 'Moon'
,
'Mercury'
, 'Venus'
,
'Mars'
, 'Jupiter'
,
'Saturn'
, 'Uranus'
,
'Neptune'
, or 'Pluto'
.
Default Values
The default values are:
['Sun','Moon']
when the CentralBody property ofAero.spacecraft.CentralBodyOptions
is set toEarth
.['Sun','Earth']
when the CentralBody property ofAero.spacecraft.CentralBodyOptions
is set toMoon
.['Earth','Moon']
when the CentralBody property ofAero.spacecraft.CentralBodyOptions
is set toSun
.['Sun','Earth','Moon']
in all other cases.
Dependencies
To use this property, set the IncludeThirdBodyGravity property to true
.
Option to include solar radiation pressure, specified as false
(0
) or true
(1
).
Solar flux pressure acting on the satellite, specified as a nonnegative scalar, in W*s/m3.
Dependencies
To use this property, IncludeSRP must be set to true
.
Data Types: double
Eclipse model used in solar radiation pressure computation, specified as
'dual-cone'
or
'cylindrical'
.
Dependencies
To use this property, IncludeSRP
must be set to
true
and the CentralBody property of the Aero.spacecraft.CentralBodyOptions
object set by
the CentralBodyOptions property is not set to
Sun
.
Option to include lunar eclipse in solar radiation pressure calculation, specified as
false
or true
.
Dependencies
To use this property, IncludeSRP
must be set to
true
, and the CentralBody property of Aero.spacecraft.NumericalPropagatorOptions
object set by the CentralBodyOptions property is set to
Earth
.
Celestial body ephemeris model used in the computation of third body gravity and solar radiation pressure, specified as one of these ephemerides defined by the Jet Propulsion Laboratory:
'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).
Dependencies
To use this property, IncludeThirdBodyGravity
or
IncludeSRP
must be set to true
.
Data Types: string
Central body options used by the numerical orbit propagator, specified as an Aero.spacecraft.CentralBodyOptions
scalar object.
Default Values
The default value is
The object returned by
Aero.spacecraft.CentralBodyOptions
with the CentralBody property set toMoon
, when SphericalHarmonicModel set toLP100K
orLP165P
.The object returned by
Aero.spacecraft.CentralBodyOptions
with the CentralBody property set toMars
, when SphericalHarmonicModel set toGMM2B
.The object returned by
Aero.spacecraft.CentralBodyOptions
with the CentralBody property set toEarth
in all other cases.
Version History
Introduced in R2024b
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)