org.orekit.propagation.analytical

Class FieldAbstractAnalyticalPropagator<T extends org.hipparchus.RealFieldElement<T>>

java.lang.Object

org.orekit.propagation.FieldAbstractPropagator<T>

org.orekit.propagation.analytical.FieldAbstractAnalyticalPropagator<T>

All Implemented Interfaces:

FieldPropagator<T>, FieldPVCoordinatesProvider<T>

Direct Known Subclasses:

FieldEcksteinHechlerPropagator, FieldIntegratedEphemeris, FieldKeplerianPropagator

public abstract class FieldAbstractAnalyticalPropagator<T extends org.hipparchus.RealFieldElement<T>>
extends FieldAbstractPropagator<T>

Common handling of FieldPropagator methods for analytical propagators.

This abstract class allows to provide easily the full set of FieldPropagator methods, including all propagation modes support and discrete events support for any simple propagation method. Only two methods must be implemented by derived classes: propagateOrbit(FieldAbsoluteDate) and getMass(FieldAbsoluteDate). The first method should perform straightforward propagation starting from some internally stored initial state up to the specified target date.

Author:

Luc Maisonobe

Field Summary

Fields inherited from interface org.orekit.propagation.FieldPropagator

DEFAULT_LAW, DEFAULT_MASS, EPHEMERIS_GENERATION_MODE, MASTER_MODE, SLAVE_MODE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FieldAbstractAnalyticalPropagator(org.hipparchus.Field<T> field, AttitudeProvider attitudeProvider) Build a new instance.

Method Summary

Modifier and Type	Method and Description
protected FieldSpacecraftState<T>	acceptStep(org.orekit.propagation.analytical.FieldAbstractAnalyticalPropagator.FieldBasicStepInterpolator interpolator, FieldAbsoluteDate<T> target, double epsilon) Accept a step, triggering events and step handlers.
<D extends FieldEventDetector<T>> void	addEventDetector(D detector) Add an event detector.
protected FieldSpacecraftState<T>	basicPropagate(FieldAbsoluteDate<T> date) Propagate an orbit without any fancy features.
void	clearEventsDetectors() Remove all events detectors.
Collection<FieldEventDetector<T>>	getEventsDetectors() Get all the events detectors that have been added.
FieldBoundedPropagator<T>	getGeneratedEphemeris() Get the ephemeris generated during propagation.
protected abstract T	getMass(FieldAbsoluteDate<T> date) Get the mass.
FieldPVCoordinatesProvider<T>	getPvProvider() Get PV coordinates provider.
FieldSpacecraftState<T>	propagate(FieldAbsoluteDate<T> start, FieldAbsoluteDate<T> target) Propagate from a start date towards a target date.
protected abstract FieldOrbit<T>	propagateOrbit(FieldAbsoluteDate<T> date) Extrapolate an orbit up to a specific target date.
protected abstract void	resetIntermediateState(FieldSpacecraftState<T> state, boolean forward) Reset an intermediate state.

Methods inherited from class org.orekit.propagation.FieldAbstractPropagator

addAdditionalStateProvider, getAdditionalStateProviders, getAttitudeProvider, getField, getFixedStepSize, getFrame, getInitialState, getManagedAdditionalStates, getMode, getPVCoordinates, getStartDate, getStepHandler, isAdditionalStateManaged, propagate, resetInitialState, setAttitudeProvider, setEphemerisMode, setMasterMode, setMasterMode, setSlaveMode, setStartDate, updateAdditionalStates

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FieldAbstractAnalyticalPropagator

protected FieldAbstractAnalyticalPropagator(org.hipparchus.Field<T> field,
                                            AttitudeProvider attitudeProvider)

Build a new instance.

Parameters:

attitudeProvider - provider for attitude computation

field - field used as default

Method Detail

getGeneratedEphemeris

public FieldBoundedPropagator<T> getGeneratedEphemeris()

Get the ephemeris generated during propagation.

Specified by:

getGeneratedEphemeris in interface FieldPropagator<T extends org.hipparchus.RealFieldElement<T>>

Specified by:

getGeneratedEphemeris in class FieldAbstractPropagator<T extends org.hipparchus.RealFieldElement<T>>

Returns:

generated ephemeris

See Also:

FieldPropagator.setEphemerisMode()

getEventsDetectors

public Collection<FieldEventDetector<T>> getEventsDetectors()

Get all the events detectors that have been added.

Specified by:

getEventsDetectors in interface FieldPropagator<T extends org.hipparchus.RealFieldElement<T>>

Specified by:

getEventsDetectors in class FieldAbstractPropagator<T extends org.hipparchus.RealFieldElement<T>>

Returns:

an unmodifiable collection of the added detectors

See Also:

FieldPropagator.addEventDetector(FieldEventDetector), FieldPropagator.clearEventsDetectors()

clearEventsDetectors

public void clearEventsDetectors()

Remove all events detectors.

Specified by:

clearEventsDetectors in interface FieldPropagator<T extends org.hipparchus.RealFieldElement<T>>

Specified by:

clearEventsDetectors in class FieldAbstractPropagator<T extends org.hipparchus.RealFieldElement<T>>

See Also:

FieldPropagator.addEventDetector(FieldEventDetector), FieldPropagator.getEventsDetectors()

propagate

public FieldSpacecraftState<T> propagate(FieldAbsoluteDate<T> start,
                                         FieldAbsoluteDate<T> target)
                                  throws OrekitException

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.

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:

OrekitException - if state cannot be propagated

acceptStep

protected FieldSpacecraftState<T> acceptStep(org.orekit.propagation.analytical.FieldAbstractAnalyticalPropagator.FieldBasicStepInterpolator interpolator,
                                             FieldAbsoluteDate<T> target,
                                             double epsilon)
                                      throws OrekitException,
                                             org.hipparchus.exception.MathRuntimeException

Accept a step, triggering events and step handlers.

Parameters:

interpolator - interpolator for the current step

target - final propagation time

epsilon - threshold for end date detection

Returns:

state at the end of the step

Throws:

OrekitException - if the switching function cannot be evaluated

org.hipparchus.exception.MathRuntimeException - if an event cannot be located

getMass

protected abstract T getMass(FieldAbsoluteDate<T> date)
                      throws OrekitException

Get the mass.

Parameters:

date - target date for the orbit

Returns:

mass mass

Throws:

OrekitException - if some parameters are out of bounds

getPvProvider

public FieldPVCoordinatesProvider<T> getPvProvider()

Get PV coordinates provider.

Returns:

PV coordinates provider

addEventDetector

public <D extends FieldEventDetector<T>> void addEventDetector(D detector)

Add an event detector.

Specified by:

addEventDetector in interface FieldPropagator<T extends org.hipparchus.RealFieldElement<T>>

Specified by:

addEventDetector in class FieldAbstractPropagator<T extends org.hipparchus.RealFieldElement<T>>

Type Parameters:

D - class type for the generic version

Parameters:

detector - event detector to add

See Also:

FieldPropagator.clearEventsDetectors(), FieldPropagator.getEventsDetectors()

resetIntermediateState

protected abstract void resetIntermediateState(FieldSpacecraftState<T> state,
                                               boolean forward)
                                        throws OrekitException

Reset an intermediate state.

Parameters:

state - new intermediate state to consider

forward - if true, the intermediate state is valid for propagations after itself

Throws:

OrekitException - if initial state cannot be reset

propagateOrbit

protected abstract FieldOrbit<T> propagateOrbit(FieldAbsoluteDate<T> date)
                                         throws OrekitException

Extrapolate an orbit up to a specific target date.

Parameters:

date - target date for the orbit

Returns:

extrapolated parameters

Throws:

OrekitException - if some parameters are out of bounds

basicPropagate

protected FieldSpacecraftState<T> basicPropagate(FieldAbsoluteDate<T> date)
                                          throws OrekitException

Propagate an orbit without any fancy features.

This method is similar in spirit to the propagate(org.orekit.time.FieldAbsoluteDate<T>, org.orekit.time.FieldAbsoluteDate<T>) method, except that it does not call any handler during propagation, nor any discrete events, not additional states. It always stop exactly at the specified date.

Parameters:

date - target date for propagation

Returns:

state at specified date

Throws:

OrekitException - if propagation cannot reach specified date