Class ImpulseManeuver
- java.lang.Object
-
- org.orekit.propagation.events.AbstractDetector<ImpulseManeuver>
-
- org.orekit.forces.maneuvers.ImpulseManeuver
-
- All Implemented Interfaces:
EventDetector
public class ImpulseManeuver extends AbstractDetector<ImpulseManeuver>
Impulse maneuver model.This class implements an impulse maneuver as a discrete event that can be provided to any
Propagator
.The maneuver is triggered when an underlying event generates a
STOP
event, in which case this class will generate aRESET_STATE
event (the stop event from the underlying object is therefore filtered out). In the simple cases, the underlying event detector may be a basicdate event
, but it can also be a more elaborateapside event
for apogee maneuvers for example.The maneuver is defined by a single velocity increment. If no AttitudeProvider is given, the current attitude of the spacecraft, defined by the current spacecraft state, will be used as the
AttitudeProvider
so the velocity increment should be given in the same pseudoinertial frame as theSpacecraftState
used to construct the propagator that will handle the maneuver. If an AttitudeProvider is given, the velocity increment given should be defined appropriately in consideration of that provider. So, a typical case for tangential maneuvers is to provide aLOF aligned
attitude provider along with a velocity increment defined in accordance with that LOF aligned attitude provider; e.g. if the LOF aligned attitude provider was constructed using LOFType.VNC the velocity increment should be provided in VNC coordinates.The norm through which the delta-V maps to the mass consumption is chosen via the enum
Control3DVectorCostType
. Default is Euclidean.Beware that the triggering event detector must behave properly both before and after maneuver. If for example a node detector is used to trigger an inclination maneuver and the maneuver change the orbit to an equatorial one, the node detector will fail just after the maneuver, being unable to find a node on an equatorial orbit! This is a real case that has been encountered during validation ...
- Author:
- Luc Maisonobe
- See Also:
Propagator.addEventDetector(EventDetector)
-
-
Field Summary
-
Fields inherited from class org.orekit.propagation.events.AbstractDetector
DEFAULT_MAX_ITER, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ImpulseManeuver(AdaptableInterval maxCheck, double threshold, int maxIter, EventHandler handler, EventDetector trigger, AttitudeProvider attitudeOverride, Vector3D deltaVSat, double isp, Control3DVectorCostType control3DVectorCostType)
Protected constructor with full parameters.ImpulseManeuver(EventDetector trigger, Vector3D deltaVSat, double isp)
Build a new instance.ImpulseManeuver(EventDetector trigger, AttitudeProvider attitudeOverride, Vector3D deltaVSat, double isp)
Build a new instance.ImpulseManeuver(EventDetector trigger, AttitudeProvider attitudeOverride, Vector3D deltaVSat, double isp, Control3DVectorCostType control3DVectorCostType)
Build a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ImpulseManeuver
create(AdaptableInterval newMaxCheck, double newThreshold, int newMaxIter, EventHandler newHandler)
Build a new instance.double
g(SpacecraftState s)
Compute the value of the switching function.AttitudeProvider
getAttitudeOverride()
Get the Attitude Provider to use during maneuver.Control3DVectorCostType
getControl3DVectorCostType()
Get the control vector's cost type.Vector3D
getDeltaVSat()
Get the velocity increment in satellite frame.double
getIsp()
Get the specific impulse.EventDetector
getTrigger()
Get the triggering event.void
init(SpacecraftState s0, AbsoluteDate t)
Initialize event handler at the start of a propagation.-
Methods inherited from class org.orekit.propagation.events.AbstractDetector
getHandler, getMaxCheckInterval, getMaxIterationCount, getThreshold, isForward, withHandler, withMaxCheck, withMaxCheck, withMaxIter, withThreshold
-
-
-
-
Constructor Detail
-
ImpulseManeuver
public ImpulseManeuver(EventDetector trigger, Vector3D deltaVSat, double isp)
Build a new instance.- Parameters:
trigger
- triggering eventdeltaVSat
- velocity increment in satellite frameisp
- engine specific impulse (s)
-
ImpulseManeuver
public ImpulseManeuver(EventDetector trigger, AttitudeProvider attitudeOverride, Vector3D deltaVSat, double isp)
Build a new instance.- Parameters:
trigger
- triggering eventattitudeOverride
- the attitude provider to use for the maneuverdeltaVSat
- velocity increment in satellite frameisp
- engine specific impulse (s)
-
ImpulseManeuver
public ImpulseManeuver(EventDetector trigger, AttitudeProvider attitudeOverride, Vector3D deltaVSat, double isp, Control3DVectorCostType control3DVectorCostType)
Build a new instance.- Parameters:
trigger
- triggering eventattitudeOverride
- the attitude provider to use for the maneuverdeltaVSat
- velocity increment in satellite frameisp
- engine specific impulse (s)control3DVectorCostType
- increment's norm for mass consumption
-
ImpulseManeuver
protected ImpulseManeuver(AdaptableInterval maxCheck, double threshold, int maxIter, EventHandler handler, EventDetector trigger, AttitudeProvider attitudeOverride, Vector3D deltaVSat, double isp, Control3DVectorCostType control3DVectorCostType)
Protected constructor with full parameters.This constructor is not public as users are expected to use the builder API with the various
withXxx()
methods to set up the instance in a readable manner without using a huge amount of parameters.- Parameters:
maxCheck
- maximum checking intervalthreshold
- convergence threshold (s)maxIter
- maximum number of iterations in the event time searchhandler
- event handler to call at event occurrencestrigger
- triggering eventattitudeOverride
- the attitude provider to use for the maneuverdeltaVSat
- velocity increment in satellite frameisp
- engine specific impulse (s)control3DVectorCostType
- increment's norm for mass consumption- Since:
- 6.1
-
-
Method Detail
-
create
protected ImpulseManeuver create(AdaptableInterval newMaxCheck, double newThreshold, int newMaxIter, EventHandler newHandler)
Build a new instance.- Specified by:
create
in classAbstractDetector<ImpulseManeuver>
- Parameters:
newMaxCheck
- maximum checking interval (s)newThreshold
- convergence threshold (s)newMaxIter
- maximum number of iterations in the event time searchnewHandler
- event handler to call at event occurrences- Returns:
- a new instance of the appropriate sub-type
-
init
public void init(SpacecraftState s0, AbsoluteDate t)
Initialize event handler at the start of a propagation.This method is called once at the start of the propagation. It may be used by the event handler to initialize some internal data if needed.
The default implementation does nothing
This implementation sets the direction of propagation and initializes the event handler. If a subclass overrides this method it should call
super.init(s0, t)
.- Specified by:
init
in interfaceEventDetector
- Overrides:
init
in classAbstractDetector<ImpulseManeuver>
- Parameters:
s0
- initial statet
- target time for the integration
-
g
public double g(SpacecraftState s)
Compute the value of the switching function. This function must be continuous (at least in its roots neighborhood), as the integrator will need to find its roots to locate the events.- Specified by:
g
in interfaceEventDetector
- Specified by:
g
in classAbstractDetector<ImpulseManeuver>
- Parameters:
s
- the current state information: date, kinematics, attitude- Returns:
- value of the switching function
-
getAttitudeOverride
public AttitudeProvider getAttitudeOverride()
Get the Attitude Provider to use during maneuver.- Returns:
- the attitude provider
-
getTrigger
public EventDetector getTrigger()
Get the triggering event.- Returns:
- triggering event
-
getDeltaVSat
public Vector3D getDeltaVSat()
Get the velocity increment in satellite frame.- Returns:
- velocity increment in satellite frame
-
getIsp
public double getIsp()
Get the specific impulse.- Returns:
- specific impulse
-
getControl3DVectorCostType
public Control3DVectorCostType getControl3DVectorCostType()
Get the control vector's cost type.- Returns:
- control cost type
- Since:
- 12.0
-
-