fr.cnes.sirius.patrius.propagation.analytical.twod

Class Analytical2DPropagator

java.lang.Object

fr.cnes.sirius.patrius.propagation.AbstractPropagator

fr.cnes.sirius.patrius.propagation.analytical.twod.Analytical2DPropagator

All Implemented Interfaces:

PVCoordinatesProvider, MeanOsculatingElementsProvider, Propagator, SpacecraftStateProvider, Serializable

public class Analytical2DPropagator
extends AbstractPropagator
implements MeanOsculatingElementsProvider

This class propagates an analytical 2D orbit model and extends the AbstractPropagator class. Thus, this propagator can handle events and all functionalities of the AbstractPropagator.

Since:

1.3

Version:

$Id: Analytical2DPropagator.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Rami Houdroge

See Also:

Analytical2DOrbitModel, Analytical2DParameterModel, Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

extends the AbstractPropagator class

Field Summary

Fields inherited from class fr.cnes.sirius.patrius.propagation.AbstractPropagator

MASS

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

EPHEMERIS_GENERATION_MODE, MASTER_MODE, SLAVE_MODE

Constructor Summary

Constructors

Constructor and Description
Analytical2DPropagator(Analytical2DOrbitModel model, AbsoluteDate initialDate) Create an instance of a 2D propagator with default EME2000 aligned attitude.
Analytical2DPropagator(Analytical2DOrbitModel model, AbsoluteDate initialDate, int[] orders) Create an instance of a 2D propagator with default EME2000 aligned attitude.
Analytical2DPropagator(AttitudeProvider attitudeProvider, Analytical2DOrbitModel model, AbsoluteDate initialDate) Create an instance of a 2D propagator.
Analytical2DPropagator(AttitudeProvider attitudeProvider, Analytical2DOrbitModel model, AbsoluteDate initialDate, int[] orders) Create an instance of a 2D propagator.

Method Summary

Modifier and Type	Method and Description
Orbit	mean2osc(Orbit orbit) Convert provided mean orbit into osculating elements.
Orbit	osc2mean(Orbit orbit) Convert provided osculating orbit into mean elements.
Orbit	propagateMeanOrbit(AbsoluteDate date) Propagate mean orbit until provided date.
protected Orbit	propagateOrbit(AbsoluteDate date) Extrapolate an orbit up to a specific target date.
void	setThreshold(double newThreshold) Setter for relative convergence threshold for osculating to mean conversion used by method osc2mean(Orbit).

Methods inherited from class fr.cnes.sirius.patrius.propagation.AbstractPropagator

acceptStep, addAdditionalStateProvider, addAdditionalStateProvider, addEventDetector, basicPropagate, clearEventsDetectors, getAttitudeProvider, getAttitudeProviderEvents, getAttitudeProviderForces, getEventsDetectors, getFrame, getGeneratedEphemeris, getInitialState, getMode, getPVCoordinates, getPvProvider, getSpacecraftState, manageStateFrame, propagate, propagate, resetInitialState, setAttitudeProvider, setAttitudeProviderEvents, setAttitudeProviderForces, setEphemerisMode, setMasterMode, setMasterMode, setOrbitFrame, setSlaveMode, setStartDate

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.Propagator

getNativeFrame

Constructor Detail

Analytical2DPropagator

public Analytical2DPropagator(Analytical2DOrbitModel model,
                              AbsoluteDate initialDate)

Create an instance of a 2D propagator with default EME2000 aligned attitude.

Parameters:

model - analytical 2D orbit model

initialDate - initial date

Analytical2DPropagator

public Analytical2DPropagator(Analytical2DOrbitModel model,
                              AbsoluteDate initialDate,
                              int[] orders)

Create an instance of a 2D propagator with default EME2000 aligned attitude.

Parameters:

model - analytical 2D orbit model

initialDate - initial date

orders - orders of trigonometric developments. [sma, ex, ey, inc, lna, aol]

Analytical2DPropagator

public Analytical2DPropagator(AttitudeProvider attitudeProvider,
                              Analytical2DOrbitModel model,
                              AbsoluteDate initialDate)

Create an instance of a 2D propagator.

Parameters:

attitudeProvider - spacecraft attitude provider

model - analytical 2D orbit model

initialDate - initial date

Analytical2DPropagator

public Analytical2DPropagator(AttitudeProvider attitudeProvider,
                              Analytical2DOrbitModel model,
                              AbsoluteDate initialDate,
                              int[] orders)

Create an instance of a 2D propagator.

Parameters:

attitudeProvider - spacecraft attitude provider

model - analytical 2D orbit model

initialDate - initial date

orders - orders of trigonometric developments. [sma, ex, ey, inc, lna, aol]

Method Detail

propagateOrbit

protected Orbit propagateOrbit(AbsoluteDate date)
                        throws PropagationException

Extrapolate an orbit up to a specific target date.

Specified by:

propagateOrbit in class AbstractPropagator

Parameters:

date - target date for the orbit

Returns:

extrapolated parameters

Throws:

PropagationException - if some parameters are out of bounds

osc2mean

public Orbit osc2mean(Orbit orbit)
               throws PatriusException

Convert provided osculating orbit into mean elements.

Warning: Used algorithm often consists in an iterative algorithm with a convergence criterion. As a result convergence is not always ensured, depending on the underlying theory.

Specified by:

osc2mean in interface MeanOsculatingElementsProvider

Parameters:

orbit - an orbit (osculating elements)

Returns:

mean elements of provided orbit

Throws:

PatriusException - if conversion fails

mean2osc

public Orbit mean2osc(Orbit orbit)
               throws PatriusException

Convert provided mean orbit into osculating elements.

Specified by:

mean2osc in interface MeanOsculatingElementsProvider

Parameters:

orbit - an orbit (mean elements)

Returns:

osculating elements of provided orbit

Throws:

PatriusException - if conversion fails

propagateMeanOrbit

public Orbit propagateMeanOrbit(AbsoluteDate date)
                         throws PatriusException

Propagate mean orbit until provided date.

Specified by:

propagateMeanOrbit in interface MeanOsculatingElementsProvider

Parameters:

date - a date

Returns:

mean orbit at provided date

Throws:

PatriusException - thrown if computation failed

setThreshold

public void setThreshold(double newThreshold)

Setter for relative convergence threshold for osculating to mean conversion used by method osc2mean(Orbit).

Parameters:

newThreshold - new relative threshold