Package org.orekit.propagation.events

Interface EventDetectorsProvider

All Known Subinterfaces:

DSSTForceModel, ForceModel, ManeuverTriggers, PropulsionModel, ThrustPropulsionModel

All Known Implementing Classes:

AbstractConstantThrustPropulsionModel, AbstractDragForceModel, AbstractGaussianContribution, AbstractManeuverTriggers, AbstractRadiationForceModel, BasicConstantThrustPropulsionModel, ConfigurableLowThrustManeuver, ConstantThrustManeuver, CR3BPForceModel, DateBasedManeuverTriggers, DeSitterRelativity, DragForce, DSSTAtmosphericDrag, DSSTJ2SquaredClosedForm, DSSTNewtonianAttraction, DSSTSolarRadiationPressure, DSSTTesseral, DSSTThirdBody, DSSTZonal, ECOM2, HolmesFeatherstoneAttractionModel, InertialForces, IntervalEventTrigger, KnockeRediffusedForceModel, LenseThirringRelativity, Maneuver, NewtonianAttraction, OceanTides, ParametricAcceleration, ProfileThrustPropulsionModel, Relativity, ScaledConstantThrustPropulsionModel, SingleBodyAbsoluteAttraction, SingleBodyRelativeAttraction, SolarRadiationPressure, SolidTides, StartStopEventsTrigger, ThirdBodyAttraction, ThirdBodyAttractionEpoch, TimeSpanDragForce, TimeSpanParametricAcceleration

public interface EventDetectorsProvider

Interface for building event detectors for force models and maneuver parameters.

Objects implementing this interface are mainly ForceModel and DSSTForceModel.

Since:

12.0

Author:

Luc Maisonobe, Melina Vanel, Maxime Journot

Field Summary

Fields

Modifier and Type	Field	Description
static double	DATATION_ACCURACY	Accuracy of switching events dates (s).

Method Summary

Modifier and Type	Method	Description
Stream<EventDetector>	getEventDetectors()	Get the discrete events related to the model.
default Stream<EventDetector>	getEventDetectors(List<ParameterDriver> parameterDrivers)	Get the discrete events related to the model from a list of ParameterDriver
<T extends CalculusFieldElement<T>> Stream<FieldEventDetector<T>>	getFieldEventDetectors(Field<T> field)	Get the discrete events related to the model.
default <T extends CalculusFieldElement<T>> Stream<FieldEventDetector<T>>	getFieldEventDetectors(Field<T> field, List<ParameterDriver> parameterDrivers)	Get the discrete events related to the model from a list of ParameterDriver

Field Detail

DATATION_ACCURACY

static final double DATATION_ACCURACY

Accuracy of switching events dates (s).

See Also:

Constant Field Values

Method Detail

getEventDetectors

Stream<EventDetector> getEventDetectors()

Get the discrete events related to the model.

This method is not intended to be called several time, only once by a propagator, as it has the side effect of rebuilding the events detectors when called

Returns:

stream of event detectors

getFieldEventDetectors

<T extends CalculusFieldElement<T>> Stream<FieldEventDetector<T>> getFieldEventDetectors(Field<T> field)

Get the discrete events related to the model.

This method is not intended to be called several time, only once by a propagator, as it has the side effect of rebuilding the events detectors when called

Type Parameters:

T - extends CalculusFieldElement<T>

Parameters:

field - field to which the state belongs

Returns:

stream of event detectors

getEventDetectors

default Stream<EventDetector> getEventDetectors(List<ParameterDriver> parameterDrivers)

Get the discrete events related to the model from a list of ParameterDriver

Date detectors are used to cleanly stop the propagator and reset the state derivatives at transition dates (if any) of the parameter drivers.

This method is not intended to be called several times, only once by a propagator, as it has the side effect of rebuilding the events detectors when called.

Parameters:

parameterDrivers - list of parameter drivers

Returns:

stream of event detectors

getFieldEventDetectors

default <T extends CalculusFieldElement<T>> Stream<FieldEventDetector<T>> getFieldEventDetectors(Field<T> field,
                                                                                                 List<ParameterDriver> parameterDrivers)

Get the discrete events related to the model from a list of ParameterDriver

Date detectors are used to cleanly stop the propagator and reset the state derivatives at transition dates (if any) of the parameter drivers.

This method is not intended to be called several times, only once by a propagator, as it has the side effect of rebuilding the events detectors when called.

Type Parameters:

T - extends CalculusFieldElement<T>

Parameters:

parameterDrivers - list of parameter drivers

field - field to which the state belongs

Returns:

stream of event detectors