MultiNumericalPropagator (patrimoine de base SIRIUS 4.16 API)

java.lang.Object
- fr.cnes.sirius.patrius.propagation.numerical.multi.MultiNumericalPropagator

All Implemented Interfaces:

MultiPropagator, Serializable, Observer
```
public class MultiNumericalPropagator
extends Object
implements MultiPropagator, Observer, Serializable
```
This class is copied from NumericalPropagator and adapted to multi propagation.

This class propagates N SpacecraftState using numerical integration. Each state is identified with an ID of type String. As of version 4.14, this class also handles hybrid propagation, meaning that analytical propagation can be performed at the same time. See the end of this Javadoc presentation for further details.

Multi spacecraft numerical propagation requires steps to set up the propagator to be used properly.
At least one satellite should be added to the propagator using addInitialState(SpacecraftState, String). Then, the following configuration parameters can be set for each state:
- the central attraction coefficient (#setMu(double, String))
- the various force models (addForceModel(ForceModel, String), removeForceModels())
- whether additional equations (for example Jacobians) should be propagated along with orbital state ( addAdditionalEquations(AdditionalEquations, String)),
- the discrete events that should be triggered during propagation ( addEventDetector(EventDetector, String), clearEventsDetectors())
The following general parameters can also be set :
- the type of orbital parameters to be used for propagation ( #setOrbitType(OrbitType)),
- the type of position angle to be used in orbital parameters to be used for propagation where it is relevant (#setPositionAngleType(PositionAngle)),
- the discrete events that should be triggered during propagation ( addEventDetector(MultiEventDetector), clearEventsDetectors())
- the binding logic with the rest of the application (setSlaveMode(), setMasterMode(double, MultiPatriusFixedStepHandler), setMasterMode(MultiPatriusStepHandler), setEphemerisMode(), getGeneratedEphemeris(String))
From these configuration parameters, only the initial state is mandatory. The default propagation settings are in equinoctial parameters with true longitude argument. If the central attraction coefficient is not explicitly specified, the one used to define the initial orbit will be used.

The underlying numerical integrator set up in the constructor may also have its own configuration parameters. Typical configuration parameters for adaptive stepsize integrators are the min, max and perhaps start step size as well as the absolute and/or relative errors thresholds.

A state that is seen by the integrator is a simple six elements double array. The six first elements are either:
- the equinoctial orbit parameters (a, e_x, e_y, h_x, h_y, λ_M or λ_E or λ_v) in meters and radians,
- the Keplerian orbit parameters (a, e, i, ω, Ω, M or E or v) in meters and radians,
- the circular orbit parameters (a, e_x, e_y, i, Ω, α_M or α_E or α_v) in meters and rad,
- the Cartesian orbit parameters (x, y, z, v_x, v_y, v_z) in meters and meters per seconds.
The following code snippet shows a typical setting for Low Earth Orbit propagation in equinoctial parameters and true longitude argument:
```
 final double dP = 0.001;
 final double minStep = 0.001;
 final double maxStep = 500;
 final double initStep = 60;
 AdaptiveStepsizeIntegrator integrator = new DormandPrince853Integrator(minStep, maxStep,
     AbsTolerance, RelTolerance);
 integrator.setInitialStepSize(initStep);
 propagator = new MultiNumericalPropagator(integrator);
 
```
As mentioned at the beginning of this description it is now possible to perform hybrid propagation with this multi-numerical propagator. A few constraints and information are useful to be known:
- hybrid propagation means that analytical propagation is performed at the same time as numerical propagation thanks to additional SpacecraftStateProviders,
- at least one numerical propagation shall be performed, pure analytical propagation is not authorized. If needed, use MultiAnalyticalPropagator instead,
- any SpacecraftStateProvider is handled, therefore Ephemeris propagator is handled as well as any other implementation of SpacecraftStateProvider. It is not forbidden however strongly discouraged to add a NumericalPropagator at this point, add initial states thanks to dedicated method addInitialState(SpacecraftState, String) for numerical propagation instead,
- note that any provider added thanks to addStateProvider(SpacecraftStateProvider, String), if implementing the interface Propagator, is automatically set to slave mode and its events detectors list is cleared so as not to interfere with multi-propagation detectors,
- all propagation modes are handled: mode handlers compute step dates which are then provided to SpacecraftStateProviders to compute the SpacecraftState at input dates. As an example it is possible to add an Ephemeris mono-propagator to the map of providers and use ephemeris mode at multi-propagator level: the added mono-propagator Ephemeris is set to slave mode but handlers of the multi-propagator (which is set to ephemeris mode in our example) compute ephemeris dates that are provided to the Ephemeris.getSpacecraftState(AbsoluteDate) method.
The same instance cannot be used simultaneously by different threads, the class is not thread-safe.
Since:

3.0

Version:

$Id$

Author:

maggioranic

See Also:

SpacecraftState, ForceModel, MultiPatriusStepHandler, MultiPatriusFixedStepHandler, MultiIntegratedEphemeris, TimeDerivativesEquations, Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

attributes are mutable and related to propagation.

Field Summary
- Fields inherited from interface fr.cnes.sirius.patrius.propagation.MultiPropagator
  EPHEMERIS_GENERATION_MODE, MASTER_MODE, SLAVE_MODE

Constructor Summary

Constructors
Constructor and Description
`MultiNumericalPropagator(FirstOrderIntegrator integratorIn)` Create a new instance of MultiNumericalPropagator.
`MultiNumericalPropagator(FirstOrderIntegrator integratorIn, Map<String,Frame> propagationFrameMapIn)` Create a new instance of MultiNumericalPropagator.
`MultiNumericalPropagator(FirstOrderIntegrator integratorIn, Map<String,Frame> propagationFrameMapIn, OrbitType orbitTypeIn, PositionAngle angleTypeIn)` Create a new instance of MultiNumericalPropagator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAdditionalEquations(AdditionalEquations addEqu, String satId)` Add a set of user-specified equations to be integrated along with the orbit propagation.
`void`	`addAttitudeEquation(AttitudeEquation addEqu, String satId)` Add a set of user-specified attitude equations to be integrated along with the orbit propagation.
`void`	`addEventDetector(EventDetector detector, String satId)` Add an event detector to a specific spacecraft.
`void`	`addEventDetector(MultiEventDetector detector)` Add a multi spacecraft event detector.
`protected void`	`addEventHandlers(boolean activateHandlers, Map<String,MultiAttitudeProvider> localAttProvForces, Map<String,MultiAttitudeProvider> localAttProvEvents)` Add event handlers to integrator.
`void`	`addForceModel(ForceModel model, String satId)` Add a force model to the global model of a specific spacecraft.
`void`	`addInitialState(SpacecraftState initialState, String satId)` Add a new spacecraft state to be propagated.
`void`	`addStateProvider(SpacecraftStateProvider provider, String satId)` Add an additional spacecraft state provider to the propagator.
`void`	`clearEventsDetectors()` Remove all events detectors.
`MultiAttitudeProvider`	`getAttitudeProvider(String satId)` Get the default attitude provider.
`MultiAttitudeProvider`	`getAttitudeProviderEvents(String satId)` Get the attitude provider for events computation.
`MultiAttitudeProvider`	`getAttitudeProviderForces(String satId)` Get the attitude provider for forces computation.
`int`	`getCalls()` Get the number of calls to the differential equations computation method.
`Collection<MultiEventDetector>`	`getEventsDetectors()` Get all the events `detectors` that have been added.
`List<ForceModel>`	`getForceModels(String satId)` Get force models list.
`Frame`	`getFrame(String satId)` Get the frame in which the orbit is propagated.
`BoundedPropagator`	`getGeneratedEphemeris(String satId)` Get the ephemeris generated during propagation for a defined spacecraft.
`Map<String,SpacecraftState>`	`getInitialStates()` Get the propagator initial states.
`int`	`getMode()` Get the current operating mode of the propagator.
`double`	`getMu(String satId)` Get the central attraction coefficient μ.
`OrbitType`	`getOrbitType()` Get propagation parameter type.
`PositionAngle`	`getPositionAngleType()` Get propagation parameter type.
`PVCoordinates`	`getPVCoordinates(AbsoluteDate date, Frame frame, String satId)` Get the `PVCoordinates` of the body in the selected frame.
`Map<String,SpacecraftStateProvider>`	`getStateProviders()` Get the map of additional spacecraft state providers
`Map<String,SpacecraftState>`	`propagate(AbsoluteDate target)` Propagate towards a target date.
`Map<String,SpacecraftState>`	`propagate(AbsoluteDate start, AbsoluteDate target)` Propagate from a start date towards a target date.
`void`	`removeForceModels()` Remove all force models from the global model.
`void`	`removeInitialState(String satId)` Remove the initial state with the given satId from the map of the initial states.
`void`	`setAdditionalStateTolerance(String name, double[] absTol, double[] relTol, String satId)` Add additional state tolerances.
`void`	`setAttitudeProvider(AttitudeProvider attitudeProvider, String satId)` Set attitude provider for defined spacecraft.
`void`	`setAttitudeProvider(MultiAttitudeProvider attitudeProvider, String satId)` Set attitude provider.
`void`	`setAttitudeProviderEvents(AttitudeProvider attitudeProviderEvents, String satId)` Set attitude provider for events computation.
`void`	`setAttitudeProviderEvents(MultiAttitudeProvider attitudeProviderEvents, String satId)` Set attitude provider for events.
`void`	`setAttitudeProviderForces(AttitudeProvider attitudeProviderForces, String satId)` Set attitude provider for forces computation.
`void`	`setAttitudeProviderForces(MultiAttitudeProvider attitudeProviderForces, String satId)` Set attitude provider for forces.
`void`	`setEphemerisMode()` Set the propagator to ephemeris generation mode.
`void`	`setMassProviderEquation(MassProvider massProvider, String satId)` Add additional equations associated with the mass provider.
`void`	`setMasterMode(double h, MultiPatriusFixedStepHandler handler)` Set the propagator to master mode with fixed steps.
`void`	`setMasterMode(MultiPatriusStepHandler handler)` Set the propagator to master mode with variable steps.
`void`	`setOrbitTolerance(double[] absoluteTolerance, double[] relativeTolerance, String satId)` Set the orbit tolerance of a defined state.
`void`	`setSlaveMode()` Set the propagator to slave mode.
`protected void`	`setUpEventDetector(EventDetector osf, Map<String,MultiAttitudeProvider> localAttProvForces, Map<String,MultiAttitudeProvider> localAttProvEvents, String satId)` Wrap an Orekit event detector and register it to the integrator.
`protected void`	`setUpEventDetector(MultiEventDetector osf, Map<String,MultiAttitudeProvider> localAttProvForces, Map<String,MultiAttitudeProvider> localAttProvEvents)` Wrap an Orekit multi-sat event detector and register it to the integrator.
`void`	`update(Observable o, Object eventHandlerIn)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface fr.cnes.sirius.patrius.propagation.MultiPropagator
getSpacecraftState

- Constructor Detail
  - MultiNumericalPropagator
```
public MultiNumericalPropagator(FirstOrderIntegrator integratorIn)
                         throws PatriusException
```
    Create a new instance of MultiNumericalPropagator. After creation, the instance is empty, i.e. there are no forces at all, not even the Newtonian gravitational one. The defaults are OrbitType.EQUINOCTIAL for propagation orbit type and PositionAngle.TRUE for position angle type.
    The new instance of MultiNumericalPropagator is declared as an observer of the contained integrator. As observer, it gets notified if a detector is deleted in the integrator sub-layer, to update its own detectors list.
    
    Parameters:
    
    integratorIn - numerical integrator to use for propagation
    
    Throws:
    
    PatriusException - thrown if the given propagation frames are not all pseudo-inertial
  - MultiNumericalPropagator
```
public MultiNumericalPropagator(FirstOrderIntegrator integratorIn,
                                Map<String,Frame> propagationFrameMapIn)
                         throws PatriusException
```
    Create a new instance of MultiNumericalPropagator. After creation, the instance is empty, i.e. there are no forces at all, not even the Newtonian gravitational one. The defaults are OrbitType.EQUINOCTIAL for propagation orbit type and PositionAngle.TRUE for position angle type.
    The new instance of MultiNumericalPropagator is declared as an observer of the contained integrator. As observer, it gets notified if a detector is deleted in the integrator sub-layer, to update its own detectors list.
    
    Parameters:
    
    integratorIn - numerical integrator to use for propagation
    
    propagationFrameMapIn - the map of the frames used for the propagation for each spacecraft
    
    Throws:
    
    PatriusException - thrown if the given propagation frames are not all pseudo-inertial
  - MultiNumericalPropagator
```
public MultiNumericalPropagator(FirstOrderIntegrator integratorIn,
                                Map<String,Frame> propagationFrameMapIn,
                                OrbitType orbitTypeIn,
                                PositionAngle angleTypeIn)
                         throws PatriusException
```
    Create a new instance of MultiNumericalPropagator. After creation, the instance is empty, i.e. there are no forces at all, not even the Newtonian gravitational one.
    The new instance of MultiNumericalPropagator is declared as an observer of the contained integrator. As observer, it gets notified if a detector is deleted in the integrator sub-layer, to update its own detectors list.
    
    Parameters:
    
    integratorIn - numerical integrator to use for propagation
    
    propagationFrameMapIn - the map of the frames used for the propagation for each spacecraft
    
    orbitTypeIn - the orbital parameters type
    
    angleTypeIn - the position angle type
    
    Throws:
    
    PatriusException - thrown if the given propagation frames are not all not pseudo-inertial
- Method Detail
  - setOrbitTolerance
```
public void setOrbitTolerance(double[] absoluteTolerance,
                              double[] relativeTolerance,
                              String satId)
                       throws PatriusException
```
    Set the orbit tolerance of a defined state.
    
    Parameters:
    
    absoluteTolerance - the orbit absolute tolerance of the specified spacecraft.
    
    relativeTolerance - the orbit relative tolerance of the specified spacecraft.
    
    satId - the spacecraft ID.
    
    Throws:
    
    PatriusException - The length of the input orbit tolerance is different from 6
  - getMu
```
public double getMu(String satId)
```
    Get the central attraction coefficient μ.
    
    Parameters:
    
    satId - the spacecraft ID.
    
    Returns:
    
    mu central attraction coefficient (m³/s²)
  - getAttitudeProvider
```
public MultiAttitudeProvider getAttitudeProvider(String satId)
```
    Get the default attitude provider.
    
    The unique attitude provider given by default is returned. If null, the attitude provider for forces computation, and then the attitude provider for events computation is returned.
    
    Warning: if you provided an AttitudeProvider then to get back your AttitudeProvider, the returned MultiAttitudeProvider should be cast to MultiAttitudeProviderWrapper and method MultiAttitudeProviderWrapper.getAttitudeProvider() should be used.
    
    Specified by:
    
    getAttitudeProvider in interface MultiPropagator
    
    Parameters:
    
    satId - the spacecraft ID
    
    Returns:
    
    attitude provider for forces computation (by default)
  - getAttitudeProviderForces
```
public MultiAttitudeProvider getAttitudeProviderForces(String satId)
```
    Get the attitude provider for forces computation.
    
    Warning: if you provided an AttitudeProvider then to get back your AttitudeProvider, the returned MultiAttitudeProvider should be cast to MultiAttitudeProviderWrapper and method MultiAttitudeProviderWrapper.getAttitudeProvider() should be used.
    
    Specified by:
    
    getAttitudeProviderForces in interface MultiPropagator
    
    Parameters:
    
    satId - the spacecraft ID
    
    Returns:
    
    attitude provider for forces computation, return null if not defined.
  - getAttitudeProviderEvents
```
public MultiAttitudeProvider getAttitudeProviderEvents(String satId)
```
    Get the attitude provider for events computation.
    
    Warning: if you provided an AttitudeProvider then to get back your AttitudeProvider, the returned MultiAttitudeProvider should be cast to MultiAttitudeProviderWrapper and method MultiAttitudeProviderWrapper.getAttitudeProvider() should be used.
    
    Specified by:
    
    getAttitudeProviderEvents in interface MultiPropagator
    
    Parameters:
    
    satId - the spacecraft ID
    
    Returns:
    
    attitude provider for events computation, return null if not defined.
  - setAttitudeProvider
```
public void setAttitudeProvider(AttitudeProvider attitudeProvider,
                                String satId)
```
    Set attitude provider for defined spacecraft.
    
    A default attitude provider is available in ConstantAttitudeLaw.
    
    The spacecraft defined by the input ID should already be added using MultiPropagator.addInitialState(SpacecraftState, String).
    
    Specified by:
    
    setAttitudeProvider in interface MultiPropagator
    
    Parameters:
    
    attitudeProvider - attitude provider
    
    satId - the spacecraft ID
  - setAttitudeProvider
```
public void setAttitudeProvider(MultiAttitudeProvider attitudeProvider,
                                String satId)
```
    Set attitude provider.
    
    Parameters:
    
    attitudeProvider - attitude provider
    
    satId - satellite ID for attitude provider
  - setAttitudeProviderForces
```
public void setAttitudeProviderForces(AttitudeProvider attitudeProviderForces,
                                      String satId)
```
    Set attitude provider for forces computation.
    
    A default attitude provider is available in ConstantAttitudeLaw.
    
    The spacecraft defined by the input ID should already be added using MultiPropagator.addInitialState(SpacecraftState, String).
    
    Specified by:
    
    setAttitudeProviderForces in interface MultiPropagator
    
    Parameters:
    
    attitudeProviderForces - attitude provider for forces computation
    
    satId - the spacecraft ID
  - setAttitudeProviderForces
```
public void setAttitudeProviderForces(MultiAttitudeProvider attitudeProviderForces,
                                      String satId)
```
    Set attitude provider for forces.
    
    Parameters:
    
    attitudeProviderForces - attitude provider for forces
    
    satId - satellite ID for attitude provider
  - setAttitudeProviderEvents
```
public void setAttitudeProviderEvents(AttitudeProvider attitudeProviderEvents,
                                      String satId)
```
    Set attitude provider for events computation.
    
    A default attitude provider is available in ConstantAttitudeLaw.
    
    The spacecraft defined by the input ID should already be added using MultiPropagator.addInitialState(SpacecraftState, String).
    
    Specified by:
    
    setAttitudeProviderEvents in interface MultiPropagator
    
    Parameters:
    
    attitudeProviderEvents - attitude provider for events computation
    
    satId - the spacecraft ID
  - setAttitudeProviderEvents
```
public void setAttitudeProviderEvents(MultiAttitudeProvider attitudeProviderEvents,
                                      String satId)
```
    Set attitude provider for events.
    
    Parameters:
    
    attitudeProviderEvents - attitude provider for events
    
    satId - satellite ID for attitude provider
  - addEventDetector
```
public void addEventDetector(MultiEventDetector detector)
```
    Add a multi spacecraft event detector.
    
    Specified by:
    
    addEventDetector in interface MultiPropagator
    
    Parameters:
    
    detector - event detector to add
    
    See Also:
    
    MultiPropagator.clearEventsDetectors(), MultiPropagator.getEventsDetectors()
  - addEventDetector
```
public void addEventDetector(EventDetector detector,
                             String satId)
```
    Add an event detector to a specific spacecraft. The spacecraft defined by the input ID should already be added using MultiPropagator.addInitialState(SpacecraftState, String).
    
    Specified by:
    
    addEventDetector in interface MultiPropagator
    
    Parameters:
    
    detector - event detector to add
    
    satId - the spacecraft ID
    
    See Also:
    
    MultiPropagator.clearEventsDetectors(), MultiPropagator.getEventsDetectors()
  - getEventsDetectors
```
public Collection<MultiEventDetector> getEventsDetectors()
```
    Get all the events detectors that have been added.
    
    Specified by:
    
    getEventsDetectors in interface MultiPropagator
    
    Returns:
    
    an unmodifiable collection of the added detectors
    
    See Also:
    
    MultiPropagator.addEventDetector(MultiEventDetector), MultiPropagator.addEventDetector(EventDetector, String), MultiPropagator.clearEventsDetectors()
  - clearEventsDetectors
```
public void clearEventsDetectors()
```
    Remove all events detectors.
    
    Specified by:
    
    clearEventsDetectors in interface MultiPropagator
    
    See Also:
    
    MultiPropagator.addEventDetector(MultiEventDetector), MultiPropagator.addEventDetector(EventDetector, String), MultiPropagator.getEventsDetectors()
  - addForceModel
```
public void addForceModel(ForceModel model,
                          String satId)
```
    Add a force model to the global model of a specific spacecraft.
    
    Parameters:
    
    model - ForceModel to add
    
    satId - the spacecraft ID.
    
    See Also:
    
    removeForceModels(), #setMu(double, String)
  - removeForceModels
```
public void removeForceModels()
```
    Remove all force models from the global model.
    
    See Also:
    
    addForceModel(ForceModel, String)
  - getForceModels
```
public List<ForceModel> getForceModels(String satId)
```
    Get force models list.
    
    Parameters:
    
    satId - the spacecraft ID.
    
    Returns:
    
    list of force models
    
    See Also:
    
    addForceModel(ForceModel, String)
  - getMode
```
public int getMode()
```
    Get the current operating mode of the propagator.
    
    Specified by:
    
    getMode in interface MultiPropagator
    
    Returns:
    
    one of MultiPropagator.SLAVE_MODE, MultiPropagator.MASTER_MODE, MultiPropagator.EPHEMERIS_GENERATION_MODE
    
    See Also:
    
    MultiPropagator.setSlaveMode(), MultiPropagator.setMasterMode(double, MultiPatriusFixedStepHandler), MultiPropagator.setMasterMode(MultiPatriusStepHandler), MultiPropagator.setEphemerisMode()
  - getFrame
```
public Frame getFrame(String satId)
```
    Get the frame in which the orbit is propagated.
    The propagation frame is the definition frame of the initial state, so this method should be called after this state has been set.
    
    The spacecraft defined by the input ID should already be added using MultiPropagator.addInitialState(SpacecraftState, String).
    
    Specified by:
    
    getFrame in interface MultiPropagator
    
    Parameters:
    
    satId - the spacecraft ID
    
    Returns:
    
    frame in which the orbit is propagated
    
    See Also:
    
    MultiPropagator.addInitialState(SpacecraftState, String)
  - setSlaveMode
```
public void setSlaveMode()
```
    Set the propagator to slave mode.
    This mode is used when the user needs only the final orbit at the target time. The (slave) propagator computes this result and return it to the calling (master) application, without any intermediate feedback.
    
    This is the default mode.
    
    Note that this method has the side effect of replacing the step handlers of the underlying integrator set up in the constructor or the setIntegrator method. So if a specific step handler is needed, it should be added after this method has been called.
    
    Specified by:
    
    setSlaveMode in interface MultiPropagator
    
    See Also:
    
    MultiPropagator.setSlaveMode()
  - setMasterMode
```
public void setMasterMode(double h,
                          MultiPatriusFixedStepHandler handler)
```
    Set the propagator to master mode with fixed steps.
    This mode is used when the user needs to have some custom function called at the end of each finalized step during integration. The (master) propagator integration loop calls the (slave) application callback methods at each finalized step.
    
    Note that this method has the side effect of replacing the step handlers of the underlying integrator set up in the constructor or the setIntegrator method. So if a specific step handler is needed, it should be added after this method has been called.
    
    Specified by:
    
    setMasterMode in interface MultiPropagator
    
    Parameters:
    
    h - fixed stepsize (s)
    
    handler - handler called at the end of each finalized step
    
    See Also:
    
    setMasterMode(double, MultiPatriusFixedStepHandler)
  - setMasterMode
```
public void setMasterMode(MultiPatriusStepHandler handler)
```
    Set the propagator to master mode with variable steps.
    This mode is used when the user needs to have some custom function called at the end of each finalized step during integration. The (master) propagator integration loop calls the (slave) application callback methods at each finalized step.
    
    Note that this method has the side effect of replacing the step handlers of the underlying integrator set up in the constructor or the setIntegrator method. So if a specific step handler is needed, it should be added after this method has been called.
    
    Specified by:
    
    setMasterMode in interface MultiPropagator
    
    Parameters:
    
    handler - handler called at the end of each finalized step
    
    See Also:
    
    #setMasterMode(MultiPatriusStepHandler)
  - setEphemerisMode
```
public void setEphemerisMode()
```
    Set the propagator to ephemeris generation mode.
    This mode is used when the user needs random access to the orbit state at any time between the initial and target times, and in no sequential order. A typical example is the implementation of search and iterative algorithms that may navigate forward and backward inside the propagation range before finding their result.
    
    Beware that since this mode stores all intermediate results, it may be memory intensive for long integration ranges and high precision/short time steps.
    
    Note that this method has the side effect of replacing the step handlers of the underlying integrator set up in the constructor or the setIntegrator method. So if a specific step handler is needed, it should be added after this method has been called.
    
    Specified by:
    
    setEphemerisMode in interface MultiPropagator
    
    See Also:
    
    MultiPropagator.setEphemerisMode()
  - getOrbitType
```
public OrbitType getOrbitType()
```
    Get propagation parameter type.
    
    Returns:
    
    orbit type used for propagation
  - getPositionAngleType
```
public PositionAngle getPositionAngleType()
```
    Get propagation parameter type.
    
    Returns:
    
    angle type to use for propagation
  - getGeneratedEphemeris
```
public BoundedPropagator getGeneratedEphemeris(String satId)
```
    Get the ephemeris generated during propagation for a defined spacecraft.
    
    Specified by:
    
    getGeneratedEphemeris in interface MultiPropagator
    
    Parameters:
    
    satId - the spacecraft ID
    
    Returns:
    
    generated ephemeris
    
    See Also:
    
    MultiPropagator.setEphemerisMode()
  - getInitialStates
```
public Map<String,SpacecraftState> getInitialStates()
```
    Get the propagator initial states.
    
    Specified by:
    
    getInitialStates in interface MultiPropagator
    
    Returns:
    
    initial states
  - removeInitialState
```
public void removeInitialState(String satId)
```
    Remove the initial state with the given satId from the map of the initial states.
    
    Parameters:
    
    satId - satellite ID of the initial state to remove
  - addInitialState
```
public void addInitialState(SpacecraftState initialState,
                            String satId)
                     throws PatriusException
```
    Add a new spacecraft state to be propagated.
    
    Specified by:
    
    addInitialState in interface MultiPropagator
    
    Parameters:
    
    initialState - the new spacecraft state
    
    satId - the spacecraft ID
    
    Throws:
    
    PatriusException - if an initial state is already defined with this ID. if the input ID is null. if the date of the initial state is different from the initial states already defined in the propagator.
  - getStateProviders
```
public Map<String,SpacecraftStateProvider> getStateProviders()
```
    Get the map of additional spacecraft state providers
    
    Returns:
    
    the map of additional spacecraft state providers
  - addStateProvider
```
public void addStateProvider(SpacecraftStateProvider provider,
                             String satId)
                      throws PatriusException
```
    Add an additional spacecraft state provider to the propagator. At each propagation step, the additional states will be retrieved and added to the map of states along with the propagated states. This allows to pass additional states to the step handler and event detectors during propagation.
    Note: the provider, if it is a Propagator, shall not contain event detectors nor handlers that could disturb the multi propagation. As a result the input propagator is set to slave mode and its list of detectors is cleared. Detectors shall be added in multi propagator.
    
    Parameters:
    
    provider - the spacecraft state provider
    
    satId - the spacecraft ID
    
    Throws:
    
    PatriusException - if an initial state is already defined with this ID.if the input ID is null.
  - addAdditionalEquations
```
public void addAdditionalEquations(AdditionalEquations addEqu,
                                   String satId)
```
    Add a set of user-specified equations to be integrated along with the orbit propagation.
    
    Parameters:
    
    addEqu - additional equations
    
    satId - the spacecraft ID.
    
    See Also:
    
    SpacecraftState.addAdditionalState(String, double[])
  - addAttitudeEquation
```
public void addAttitudeEquation(AttitudeEquation addEqu,
                                String satId)
```
    Add a set of user-specified attitude equations to be integrated along with the orbit propagation. If the set of attitude equations is already registered for the current attitude, it is replaced by the new one.
    
    Parameters:
    
    addEqu - attitude additional equations
    
    satId - the spacecraft ID.
  - setMassProviderEquation
```
public void setMassProviderEquation(MassProvider massProvider,
                                    String satId)
```
    Add additional equations associated with the mass provider. A null-mass detector associated with the input mass provider is automatically added.
    Note that this method should be called after setSlaveMode() or setMasterMode(MultiPatriusStepHandler) or setEphemerisMode() since this method reset the integrator step handlers list.
    
    WARNING: This method should be called only once and provided mass provider should be the same used for force models.
    
    Parameters:
    
    massProvider - the mass provider
    
    satId - the spacecraft ID.
  - setAdditionalStateTolerance
```
public void setAdditionalStateTolerance(String name,
                                        double[] absTol,
                                        double[] relTol,
                                        String satId)
                                 throws PatriusException
```
    Add additional state tolerances.
    
    Parameters:
    
    name - the additional state name
    
    absTol - absolute tolerances
    
    relTol - relative tolerances
    
    satId - the spacecraft ID.
    
    Throws:
    
    PatriusException - if additional equation associated with the input additional state name is unknown
  - propagate
```
public Map<String,SpacecraftState> propagate(AbsoluteDate target)
                                      throws PropagationException
```
    Propagate towards a target date.
    Simple propagators use only the target date as the specification for computing the propagated state. More feature rich propagators can consider other information and provide different operating modes or G-stop facilities to stop at pinpointed events occurrences. In these cases, the target date is only a hint, not a mandatory objective.
    
    Specified by:
    
    propagate in interface MultiPropagator
    
    Parameters:
    
    target - target date towards which orbit state should be propagated
    
    Returns:
    
    propagated state
    
    Throws:
    
    PropagationException - if state cannot be propagated
  - propagate
```
public Map<String,SpacecraftState> propagate(AbsoluteDate start,
                                             AbsoluteDate target)
                                      throws PropagationException
```
    Propagate from a start date towards a target date.
    Those propagators use a start date and a target date to compute the propagated state. For propagators using event detection mechanism, if the provided start date is different from the initial state date, a first, simple propagation is performed, without processing any event computation. Then complete propagation is performed from start date to target date.
    
    Specified by:
    
    propagate in interface MultiPropagator
    
    Parameters:
    
    start - start date from which orbit state should be propagated
    
    target - target date to which orbit state should be propagated
    
    Returns:
    
    propagated state
    
    Throws:
    
    PropagationException - if state cannot be propagated
  - addEventHandlers
```
protected void addEventHandlers(boolean activateHandlers,
                                Map<String,MultiAttitudeProvider> localAttProvForces,
                                Map<String,MultiAttitudeProvider> localAttProvEvents)
```
    Add event handlers to integrator. Wrap all Orekit event detector and register it to the integrator.
    
    Parameters:
    
    activateHandlers - if true, step and event handlers should be activated
    
    localAttProvForces - attitude providers for forces computation
    
    localAttProvEvents - attitude providers for events computation.
  - setUpEventDetector
```
protected void setUpEventDetector(EventDetector osf,
                                  Map<String,MultiAttitudeProvider> localAttProvForces,
                                  Map<String,MultiAttitudeProvider> localAttProvEvents,
                                  String satId)
```
    Wrap an Orekit event detector and register it to the integrator.
    
    Parameters:
    
    osf - event handler to wrap
    
    localAttProvForces - attitude providers for forces computation
    
    localAttProvEvents - attitude providers for events computation.
    
    satId - spacecraft id
  - setUpEventDetector
```
protected void setUpEventDetector(MultiEventDetector osf,
                                  Map<String,MultiAttitudeProvider> localAttProvForces,
                                  Map<String,MultiAttitudeProvider> localAttProvEvents)
```
    Wrap an Orekit multi-sat event detector and register it to the integrator.
    
    Parameters:
    
    osf - event handler to wrap
    
    localAttProvForces - attitude providers for forces computation
    
    localAttProvEvents - attitude providers for events computation
  - getPVCoordinates
```
public PVCoordinates getPVCoordinates(AbsoluteDate date,
                                      Frame frame,
                                      String satId)
                               throws PatriusException
```
    Get the PVCoordinates of the body in the selected frame.
    
    Parameters:
    
    date - current date
    
    frame - the frame where to define the position
    
    satId - spacecraft id
    
    Returns:
    
    position/velocity of the body (m and m/s)
    
    Throws:
    
    PatriusException - if position/velocity cannot be computed in given frame
  - getCalls
```
public int getCalls()
```
    Get the number of calls to the differential equations computation method.
    The number of calls is reset each time the propagate(AbsoluteDate) method is called.
    
    Returns:
    
    number of calls to the differential equations computation method
  - update
```
public void update(Observable o,
                   Object eventHandlerIn)
```
    Specified by:
    
    update in interface Observer

Class MultiNumericalPropagator

Field Summary

Fields inherited from interface fr.cnes.sirius.patrius.propagation.MultiPropagator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface fr.cnes.sirius.patrius.propagation.MultiPropagator

Constructor Detail

MultiNumericalPropagator

MultiNumericalPropagator

MultiNumericalPropagator

Method Detail

setOrbitTolerance

getMu

getAttitudeProvider

getAttitudeProviderForces

getAttitudeProviderEvents

setAttitudeProvider

setAttitudeProvider

setAttitudeProviderForces

setAttitudeProviderForces

setAttitudeProviderEvents

setAttitudeProviderEvents

addEventDetector

addEventDetector

getEventsDetectors

clearEventsDetectors

addForceModel

removeForceModels

getForceModels

getMode

getFrame

setSlaveMode

setMasterMode

setMasterMode

setEphemerisMode

getOrbitType

getPositionAngleType

getGeneratedEphemeris

getInitialStates

removeInitialState

addInitialState

getStateProviders

addStateProvider

addAdditionalEquations

addAttitudeEquation

setMassProviderEquation

setAdditionalStateTolerance

propagate

propagate

addEventHandlers

setUpEventDetector

setUpEventDetector

getPVCoordinates

getCalls

update