Package org.orekit.propagation.events

Class FieldAbstractDetector<D extends FieldAbstractDetector<D,T>,T extends CalculusFieldElement<T>>

java.lang.Object
org.orekit.propagation.events.FieldAbstractDetector<D,T>
Type Parameters:
D - type of the detector
T - type of the field element
All Implemented Interfaces:
FieldEventDetector<T>
Direct Known Subclasses:
FieldAbstractGeographicalDetector, FieldAbstractTopocentricDetector, FieldAngularSeparationDetector, FieldApsideDetector, FieldBetaAngleDetector, FieldBooleanDetector, FieldCylindricalShadowEclipseDetector, FieldDateDetector, FieldEclipseDetector, FieldExtremumAngularSeparationDetector, FieldExtremumApproachDetector, FieldFunctionalDetector, FieldNegateDetector, FieldNodeDetector, FieldParameterDrivenDateIntervalDetector, FieldPlaneCrossingDetector, FieldRelativeDistanceDetector, FieldSingleDateDetector, FieldTimeIntervalDetector
public abstract class FieldAbstractDetector<D extends FieldAbstractDetector<D,T>,T extends CalculusFieldElement<T>> extends Object implements FieldEventDetector<T>
Common parts shared by several events finders. It should only be implemented by detectors able to accept any handler.
Author:
Luc Maisonobe
See Also:

  • Field Details

    • DEFAULT_MAX_CHECK

      public static final double DEFAULT_MAX_CHECK
      Default maximum checking interval (s).
      See Also:

    • DEFAULT_THRESHOLD

      public static final double DEFAULT_THRESHOLD
      Default convergence threshold (s).
      See Also:

    • DEFAULT_MAX_ITER

      public static final int DEFAULT_MAX_ITER
      Default maximum number of iterations in the event time search.
      See Also:

  • Constructor Details

    • FieldAbstractDetector

      protected FieldAbstractDetector(EventFunction eventFunction, FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> handler)
      Build a new instance with an event function.
      Parameters:
      eventFunction - event function
      detectionSettings - event detection settings
      handler - event handler to call at event occurrences
      Since:
      14.0

    • FieldAbstractDetector

      protected FieldAbstractDetector(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> handler)
      Build a new instance.
      Parameters:
      detectionSettings - event detection settings
      handler - event handler to call at event occurrences
      Since:
      12.2

  • Method Details

    • checkIfForward

      public static <W extends CalculusFieldElement<W>> boolean checkIfForward(FieldSpacecraftState<W> state, FieldAbsoluteDate<W> targetDate)
      Check if propagation is forward or not.
      Type Parameters:
      W - field type
      Parameters:
      state - initial state
      targetDate - target propagation date
      Returns:
      forward flag
      Since:
      13.0

    • getEventFunction

      public EventFunction getEventFunction()
      Description copied from interface: FieldEventDetector
      Get the event function. It defines g both for double and Field.
      Specified by:
      getEventFunction in interface FieldEventDetector<D extends FieldAbstractDetector<D,T>>
      Returns:
      event function

    • init

      public void init(FieldSpacecraftState<T> s0, FieldAbsoluteDate<T> t)
      Initialize event detector at the start of a propagation.

      This method is called once at the start of the propagation. It may be used by the event detector to initialize some internal data if needed.

      The default implementation initializes the handler.

      Specified by:
      init in interface FieldEventDetector<D extends FieldAbstractDetector<D,T>>
      Parameters:
      s0 - initial state
      t - target time for the integration

    • getDetectionSettings

      public FieldEventDetectionSettings<T> getDetectionSettings()
      Getter for the settings.
      Specified by:
      getDetectionSettings in interface FieldEventDetector<D extends FieldAbstractDetector<D,T>>
      Returns:
      detection settings

    • withMaxCheck

      public D withMaxCheck(double newMaxCheck)
      Set up the maximum checking interval.

      This will override a maximum checking interval if it has been configured previously.

      Parameters:
      newMaxCheck - maximum checking interval (s)
      Returns:
      a new detector with updated configuration (the instance is not changed)
      Since:
      12.0

    • withMaxCheck

      public D withMaxCheck(FieldAdaptableInterval<T> newMaxCheck)
      Set up the maximum checking interval.

      This will override a maximum checking interval if it has been configured previously.

      Parameters:
      newMaxCheck - maximum checking interval (s)
      Returns:
      a new detector with updated configuration (the instance is not changed)
      Since:
      12.0

    • withMaxIter

      public D withMaxIter(int newMaxIter)
      Set up the maximum number of iterations in the event time search.

      This will override a number of iterations if it has been configured previously.

      Parameters:
      newMaxIter - maximum number of iterations in the event time search
      Returns:
      a new detector with updated configuration (the instance is not changed)
      Since:
      6.1

    • withThreshold

      public D withThreshold(T newThreshold)
      Set up the convergence threshold.

      This will override a convergence threshold if it has been configured previously.

      Parameters:
      newThreshold - convergence threshold (s)
      Returns:
      a new detector with updated configuration (the instance is not changed)
      Since:
      6.1

    • withDetectionSettings

      public D withDetectionSettings(FieldEventDetectionSettings<T> newSettings)
      Set up the event detection settings.

      This will override settings previously configured.

      Parameters:
      newSettings - new event detection settings
      Returns:
      a new detector with updated configuration (the instance is not changed)
      Since:
      12.2

    • withHandler

      public D withHandler(FieldEventHandler<T> newHandler)
      Set up the event handler to call at event occurrences.

      This will override a handler if it has been configured previously.

      Parameters:
      newHandler - event handler to call at event occurrences
      Returns:
      a new detector with updated configuration (the instance is not changed)
      Since:
      6.1

    • getHandler

      public FieldEventHandler<T> getHandler()
      Get the handler.
      Specified by:
      getHandler in interface FieldEventDetector<D extends FieldAbstractDetector<D,T>>
      Returns:
      event handler to call at event occurrences

    • create

      protected abstract D create(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> newHandler)
      Build a new instance.
      Parameters:
      detectionSettings - detection settings
      newHandler - event handler to call at event occurrences
      Returns:
      a new instance of the appropriate sub-type
      Since:
      12.2

    • isForward

      public boolean isForward()
      Check if the current propagation is forward or backward.
      Returns:
      true if the current propagation is forward
      Since:
      7.2

    • toEventDetector

      public EventDetector toEventDetector(EventHandler eventHandler)
      Build non-Field instance.
      Parameters:
      eventHandler - event handler
      Returns:
      event detector
      Since:
      14.0