Aero.satellitescenario.NumericalPropagatorOptions

R2026b

Numerical orbit propagator options

Since R2024a

expand all in page

    Description

    Options used by numerical orbit propagator

    Creation

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

    Properties

    expand all

    Since R2026b

    Central body for numerical propagation, specified as "Earth" or "Moon". This property is read-only after creation.

    Data Types: string

    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 the central body, specified as "spherical-harmonics", "point-mass", or "oblate-ellipsoid".

    Spherical harmonic model of gravitational potential of the central body, specified as a string scalar. The values are:

    • 'EGM2008' (default), 'EGM96', or 'EIGENGL04C' when CentralBody is set to "Earth".

    • 'LP100K' (default) or 'LP165P' when CentralBody is set to "Moon".

    Dependencies

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

    Spherical harmonic degree of gravitational potential of the central body, specified as a scalar. The default value is 100 when SphericalHarmonicModel equals "LP100K", and 120 otherwise. The maximum degree depends on the SphericalHarmonicModel:

    • 'EGM2008' — Maximum degree 2159

    • 'EGM96' — Maximum degree 360

    • 'EIGENGL04C' — Maximum degree 360

    • 'LP100K' — Maximum degree 100

    • 'LP165P' — Maximum degree 165

    Dependencies

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

    Data Types: double

    Option to indicate whether 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.

    When CentralBody is set to "Moon", this property is hidden, read-only, and set to false. Setting this property to true when CentralBody equals "Moon" results in an error because atmospheric drag is not supported for the Moon.

    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 the F107ExtrapValue 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, specified as a nonnegative scalar.

    Dependencies

    To use this property:

    • IncludeAtmosDrag, and UseSpaceWeatherDataFile must be set to true.

    • 'F107ExtrapMethod' must be set to 'constant'.

    • scenario simulation time must be outside the range of the data in the space weather data file.

    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 to true

    • UseSpaceWeatherDataFile must be set to false.

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

    Dependencies

    To use this property:

    • IncludeAtmosDrag must be set to true

    • UseSpaceWeatherDataFile must be set to false

    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 the MagneticIndexExtrapValue 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 must be set to true.

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

    Dependencies

    To use this property:

    • MagneticIndexExtrapMethod is set to 'constant'.

    • IncludeAtmosDrag and UseSpaceWeatherDataFile must be set to true.

    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 to false.

    • IncludeAtmosDrag must be true.

    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

    ElementValue
    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", "Earth", "Mars", "Jupiter", "Saturn", "Uranus", "Neptune", or "Pluto".

    The default value depends on CentralBody:

    • ["Sun", "Moon"] when CentralBody is set to "Earth".

    • ["Sun", "Earth"] when CentralBody is set to "Moon".

    Dependencies

    To use this property, IncludeThirdBodyGravity must be set to true.

    Option to include solar radiation pressure, specified as false (0) or true (1).

    When IncludeSRP is set to true, the eclipse modeling properties behave as follows:

    • When CentralBody is set to "Earth", IncludeEarthEclipse is hidden and ignored.

    • When CentralBody is set to "Moon", IncludeLunarEclipse is hidden and ignored.

    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.

    Since R2026b

    Option to include Earth eclipse in solar radiation pressure calculation, specified as false or true. When CentralBody is set to "Earth", this property is hidden and ignored because occultation by Earth is always included.

    Dependencies

    To use this property, IncludeSRP must be set to true, and CentralBody must be set to "Moon".

    Option to include lunar eclipse in solar radiation pressure calculation, specified as false or true. When CentralBody is set to "Moon", this property is hidden and ignored because occultation by Moon is always included.

    Dependencies

    To use this property, IncludeSRP must be set to true, and CentralBody must be set to "Earth".

    Version History

    Introduced in R2024a

    See Also

    Objects

    Functions

    Topics