impulsiveManeuver

R2026b

Add, replace, or remove impulsive maneuvers

Since R2026a

collapse all in page

    Syntax

    impulsiveManeuver(sat, DeltaV)
    impulsiveManeuver(sat, DeltaV, Name,Value)
    impulsiveManeuver(sat, Name,Value)
    maneuvers = impulsiveManeuver(sat, ___)

    Description

    impulsiveManeuver(sat, DeltaV) executes an impulsive maneuver at the current SimulationTime of the satellite scenario for each satellite in sat. This syntax can be used only when the AutoSimulate property of satelliteScenario is set to false, and the SimulationStatus property is set to In Progress.

    impulsiveManeuver(sat, DeltaV, Name,Value) executes an impulsive maneuver using DeltaV and specifies options using one or more name-value arguments. The valid name-value arguments for this syntax are Name, CoordinateFrame, and ReferenceCelestialBody.

    impulsiveManeuver(sat, Name,Value) specifies options using one or more name-value arguments.

    maneuvers = impulsiveManeuver(sat, ___) additionally returns the updated maneuver schedule in maneuvers.

    Input Arguments

    collapse all

    Satellite, specified as a row vector of Satellite objects.

    Change in velocity, specified as a 3-by-m array in meters/second. The rows represent the x, y and z components of delta-V.

    • When m = 1, the same delta-V is applied to all satellites in sat.

    • When m >1, each column represents the delta-V to be applied to the corresponding satellite in sat.

    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: Insert = timetable adds a timetable object as an impulsive maneuver to the existing schedule.

    Impulsive maneuvers to insert into the existing schedule, specified as a timetable object or a 1-by-m cell array of timetable objects. This input cannot be specified if the second input is DeltaV. You cannot specify any other name-value argument with Insert. If you specify this value, the AutoSimulate property is updated to NotStarted.

    • When specified as a timetable, the same maneuvers are inserted for all satellites.

    • When specified as a cell array, its size must match sat. Each cell contains a timetable for the corresponding satellite.

    The timetable has a column titled Delta-V corresponding to the row time. For each time, DeltaV is specified as a 3-element row vector. Optionally, the timetable can have these columns:

    • CoordinateFrame — Represents the coordinate frame in which the DeltaV is defined.

      CoordinateFrameDescription
      "inertial"

      The delta-V is represented in ICRF frame.

      "ecef"

      The delta-V is represented in the Earth ECEF frame.

      "fixed-frame"

      The delta-V is represented in the body-fixed frame of the reference celestial body.

      "ned"

      The delta-V is represented in the North-East-Down frame.

      "vnb"

      The delta-V is represented in the VNB frame, where the x-axis is the ICRF velocity direction, z-axis is the orbital angular momentum direction, and y-axis completes the triad.

      "lvlh"

      The delta-V is defined in the Local Vertical - Local Horizontal frame, where x-axis is along the position vector, z-axis is along the positive orbital angular momentum vector, and y-axis completes the triad.

      Note

      If the CoordinateFrame column is not included in the timetable, the coordinate frame defaults to inertial.

    • Name — Represents the name of the maneuver. If this column is not included in the timetable, the name defaults to "". Name must not equal "all" in any combination of uppercase or lowercase letters.

    • ReferenceCelestialBody — Reference celestial body for which CoordinateFrame is defined, specified as "Earth" or "Moon". This is applicable only when CoordinateFrame equals "fixed-frame", "ned", "vnb", or "lvlh". When CoordinateFrame equals "ecef", ReferenceCelestialBody is silently updated to "Earth". If this column is not included, the default is the CentralBody property of the satellite.

    Impulsive maneuvers that replace the existing schedule, specified as a timetable object or a 1-by-m cell array of timetable objects. This input cannot be specified if the second input is DeltaV. You cannot specify any other name-value argument with Replace. If you specify this value, the AutoSimulate property is updated to NotStarted.

    • When specified as a timetable, the same maneuvers are applied for all satellites, replacing their existing impulsive maneuver schedule.

    • When specified as a cell array, its size must match sat. Each cell contains a timetable for the corresponding satellite.

    The timetable has a column titled DeltaV corresponding to the row time. Optionally, the timetable can have these columns:

    • CoordinateFrame — Represents the coordinate frame in which the DeltaV is defined. For each time, DeltaV is specified as a 3-element row vector.

      CoordinateFrameDescription
      "inertial"

      The delta-V is represented in ICRF frame.

      "ecef"

      The delta-V is represented in the Earth ECEF frame.

      "fixed-frame"

      The delta-V is represented in the body-fixed frame of the reference celestial body.

      "ned"

      The delta-V is represented in the North-East-Down frame.

      "vnb"

      The delta-V is represented in the VNB frame, where the x-axis is the ICRF velocity direction, z-axis is the orbital angular momentum direction, and y-axis completes the triad.

      "lvlh"

      The delta-V is defined in the Local Vertical - Local Horizontal frame, where x-axis is along the position vector, z-axis is along the positive orbital angular momentum vector, and y-axis completes the triad.

      Note

      If the CoordinateFrame column is not included in the timetable, the coordinate frame defaults to inertial.

    • Name — Represents the name of the maneuver. If this column is not included in the timetable, the name defaults to "". Name must not equal "all" in any combination of uppercase or lowercase letters.

    • ReferenceCelestialBody — Reference celestial body for which CoordinateFrame is defined, specified as "Earth" or "Moon". This is applicable only when CoordinateFrame equals "fixed-frame", "ned", "vnb", or "lvlh". When CoordinateFrame equals "ecef", ReferenceCelestialBody is silently updated to "Earth". If this column is not included, the default is the CentralBody property of the satellite.

    Rows to remove from the impulsive maneuver schedule, specified as one of the following. This input cannot be specified if the second input is DeltaV. You cannot specify any other name-value argument with Remove. The AutoSimulate property is silently updated to NotStarted.

    • Vector of doubles — To indicate row indices of maneuvers to be removed from every satellite in sat.

    • String vector — To indicate names of maneuvers to be removed from every satellite in sat.

    • "all" — To remove all maneuvers from every satellite in sat.

    • Cell array — Each element represents the maneuvers that must be removed from the corresponding satellite in sat. A given cell array element can be a vector of doubles, string vector or the string "all".

    Coordinate frame for DeltaV, specified as a string scalar or 1-by-m vector.

    CoordinateFrameDescription
    "inertial"

    The delta-V is represented in ICRF frame.

    "ecef"

    The delta-V is represented in the Earth ECEF frame.

    "fixed-frame"

    The delta-V is represented in the body-fixed frame of the reference celestial body.

    "ned"

    The delta-V is represented in the North-East-Down frame.

    "vnb"

    The delta-V is represented in the VNB frame, where the x-axis is the ICRF velocity direction, z-axis is the orbital angular momentum direction, and y-axis completes the triad.

    "lvlh"

    The delta-V is defined in the Local Vertical - Local Horizontal frame, where x-axis is along the position vector, z-axis is along the positive orbital angular momentum vector, and y-axis completes the triad.

    Since R2026b

    Reference celestial body for delta‑V, specified as "Earth" or "Moon". The default value is the CentralBody setting of the satellite. This argument applies to both the DeltaV positional input and the timetable inputs specified by using Insert or Replace.

    Dependencies

    When CoordinateFrame equals "ecef", the ReferenceCelestialBody is ignored. This is equivalent to specifying ReferenceCelestialBody="Earth" with CoordinateFrame="fixed-frame".

    Data Types: string

    Output Arguments

    collapse all

    Updated maneuvers stored in the ImpulsiveManeuvers property of the satellites in sat.

    • When sat is scalar, maneuvers is a timetable equal to ImpulsiveManeuvers property of sat.

    • When sat is a 1-by-m cell array, each element contains a timetable equal to ImpulsiveManeuvers property of the corresponding satellite.

    Version History

    Introduced in R2026a

    expand all

    See Also

    Objects

    Functions