thirdBodyOptions

Modify third body options

Since R2026a

collapse all in page

    Syntax

    opt = thirdBodyOptions(options)
    opt = thirdBodyOptions(___, Name=Value)

    Description

    opt = thirdBodyOptions(options) returns the Aero.spacecraft.ThirdBodyOptions object opt with the current settings stored in the ThirdBodyOptions property of the Aero.spcecraft.NumericalpropagatorOptions object.

    opt = thirdBodyOptions(___, Name=Value) updates theAero.spacecraft.ThirdBodyOptions object opt using additional parameters specified by one or more name-value arguments..

    Input Arguments

    collapse all

    Third body options used in numerical propagation, specified as a scalar Aero.spcecraft.NumericalpropagatorOptions object.

    Name-Value Arguments

    collapse all

    Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

    Example: IncludeThirdBodyGravity = true sets option to include third body gravity to true.

    Option to include third body gravity, specified as false or true.

    Default Value

    The default value is the current value of ThirdBodyGravitySource property of the ThirdBodyOptions property held by opt.

    Third body gravity source, specified as a string containing one or a combination of "Sun", "Moon", "Earth", "Mercury", "Venus", "Mars", "Jupiter", "Saturn", "Uranus", "Neptune", and "Pluto".

    Default Value

    The default value is the current value of the ThirdBodyGravitySource property within the ThirdBodyOptions property of options.

    Dependencies

    • To use this input, set the IncludeThirdBodyGravity property to true.

    • If you specify the CentralBody property in CentralBodyOptions as a third body gravity source, the corresponding element in ThirdBodyGravitySource is omitted.

    Gravitational potential model of Sun, specified as "point-mass" or "oblate-ellipsoid".

    Default Value

    The default value is the current value of the GravitationalPotentialModel property of the Aero.spacecraft.ThirdBodyProperties object, held by the Sun property of the ThirdBodyOptions property in options.

    Dependencies

    This input is available when IncudeThirdBodyGravity is set to true and "Sun" is an element in ThirdBodyGravitySource.

    Gravitational potential model of Mercury, specified as "point-mass" or "oblate-ellipsoid".

    Default Value

    The default value is the current value of the GravitationalPotentialModel property of the Aero.spacecraft.ThirdBodyProperties object, held by the Mercury property of the ThirdBodyOptions property in options.

    Dependencies

    This input is available when IncudeThirdBodyGravity is set to true and "Mercury" is an element in ThirdBodyGravitySource.

    Gravitational potential model of Venus, specified as "point-mass" or "oblate-ellipsoid".

    Default Value

    The default value is the current value of the GravitationalPotentialModel property of the Aero.spacecraft.ThirdBodyParameters object, held by the Venus property of the ThirdBodyOptions property in options.

    Dependencies

    This input is available when IncudeThirdBodyGravity is set to true and "Venus" is an element in ThirdBodyGravitySource.

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

    Default Value

    The default value is the current value of the GravitationalPotentialModel property of the Aero.spacecraft.ThirdBodyProperties object, held by the Earth property of the ThirdBodyOptions property in options.

    Spherical harmonic model of Earth, specified as "EGM2008", "EGM96", or "EIGENGL04C".

    Default Value

    The default value is the current value of the SphericalHarmonicModel property of the Aero.spacecraft.ThirdBodyProperties object, held by the Earth property of the Earth property in options.

    Dependencies

    This input is use when the EarthGravitationalPotentialModel input is set to "spherical-harmonics".

    Degree of spherical harmonic gravitational potential of Earth, specified as a positive integer scalar. The maximum values are 2159 for "EGM2008" and 360 for "EGM96" and "EIGENGL04C".

    Default Value

    The default value is the current value of the SphericalHarmonicDegree property of the Aero.spacecraft.ThirdBodyProperties object, held by the Earth property of the Earth property in options.

    Dependencies

    This input is used when IncludeThirdBodyGravity is set to true, "Earth" is specified as an element in ThirdBodyGravitySource, the EarthGravitationalPotentialModel input is set to "spherical-harmonics".

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

    Default Value

    The default value is the current value of the GravitationalPotentialModel property of the Aero.spacecraft.ThirdBodyProperties object, held by the Moon property of the ThirdBodyOptions property in options.

    Dependencies

    This input is used when IncludeThirdBodyGravity is set to true and "Moon" is an element in ThirdBodyGravitySource.

    Degree of spherical harmonic gravitational potential model of Moon, specified as a positive integer scalar. The maximum value is 100 for LP100K and 165 for LP165P.

    Default Value

    The default value is the current value of the SphericalHarmonicDegree property of the Aero.spacecraft.ThirdBodyProperties object, held by the Moon property of the ThirdBodyOptions property in options.

    Dependencies

    This input is available when the MoonGravitationalPotentialModel input is set to "spherical-harmonics".

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

    When the input is "spherical-harmonics", the GMM2B spherical harmonic model is used.

    Default Value

    The default value is the current value of the GravitationalPotentialModel property of the Aero.spacecraft.ThirdBodyProperties object, held by the Mars property of the ThirdBodyOptions property in options.

    Spherical harmonic gravitational potential model of Mars, specified as a positive integer scalar. The maximum value is 100 for LP100K and 165 for LP165P.

    Default Value

    The default value is the current value of the SphericalHarmonicDegree property of the Aero.spacecraft.ThirdBodyProperties object, held by the Mars property of the ThirdBodyOptions property in options.

    Dependencies

    This input is used when IncludeThirdBodyGravity is set to true, "Mars" is an element in ThirdBodyGravitySource and MarsGravitationalPotentialModel input is set to "spherical-harmonics".

    Gravitational potential model of Jupiter, specified as "point-mass" or "oblate-ellipsoid".

    Default Value

    The default value is the current value of the GravitationalPotentialModel property of the Aero.spacecraft.ThirdBodyProperties object, held by the Jupiter property of the ThirdBodyOptions property in options.

    Dependencies

    This input is used when IncludeThirdBodyGravity is set to true and "Jupiter" is an element in ThirdBodyGravitySource.

    Gravitational potential model of Saturn, specified as "point-mass" or "oblate-ellipsoid".

    Default Value

    The default value is the current value of the GravitationalPotentialModel property of the Aero.spacecraft.ThirdBodyProperties object, held by the Saturn property of the ThirdBodyOptions property in options.

    Dependencies

    This input is used when IncludeThirdBodyGravity is set to true and "saturn" is an element in ThirdBodyGravitySource.

    Gravitational potential model of Uranus, specified as "point-mass" or "oblate-ellipsoid".

    Default Value

    The default value is the current value of the GravitationalPotentialModel property of the Aero.spacecraft.ThirdBodyProperties object, held by the Uranus property of the ThirdBodyOptions property in options.

    Dependencies

    This input is used when IncludeThirdBodyGravity is set to true and "Uranus" is an element in ThirdBodyGravitySource.

    Gravitational potential model of Neptune, specified as "point-mass" or "oblate-ellipsoid".

    Default Value

    The default value is the current value of the GravitationalPotentialModel property of the Aero.spacecraft.ThirdBodyProperties object, held by the Uranus property of the ThirdBodyOptions property in options.

    Dependencies

    This input is used when IncludeThirdBodyGravity is set to true and "Neptune" is an element in ThirdBodyGravitySource.

    Gravitational potential model of Pluto, specified as "point-mass" or "oblate-ellipsoid".

    Default Value

    The default value is the current value of the GravitationalPotentialModel property of the Aero.spacecraft.ThirdBodyProperties object, held by the Pluto property of the ThirdBodyOptions property in options.

    Dependencies

    This input is used when IncludeThirdBodyGravity is set to true and "Pluto" is an element in ThirdBodyGravitySource.

    Output Arguments

    collapse all

    Third body options, specified as an Aero.spacecraft.ThirdBodyOptions object.

    Version History

    Introduced in R2026a

    See Also

    Objects

    Functions

    Topics