Package org.orekit.propagation.events

Class FieldEventDetectionSettings<T extends CalculusFieldElement<T>>

java.lang.Object
org.orekit.propagation.events.FieldEventDetectionSettings<T>
Type Parameters:
T - type of the field elements
public class FieldEventDetectionSettings<T extends CalculusFieldElement<T>> extends Object
Class containing parameters for event detection.
Since:
12.2
Author:
Romain Serra.
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

    • FieldEventDetectionSettings

      public FieldEventDetectionSettings(FieldAdaptableInterval<T> maxCheckInterval, T threshold, int maxIterationCount)
      Constructor.
      Parameters:
      maxCheckInterval - adaptable interval
      threshold - detection threshold on time
      maxIterationCount - maximum iteration number

    • FieldEventDetectionSettings

      public FieldEventDetectionSettings(double maxCheck, T threshold, int maxIterationCount)
      Constructor with maximum check as double.
      Parameters:
      maxCheck - constant maximum check for adaptable interval
      threshold - detection threshold on time
      maxIterationCount - maximum iteration number

    • FieldEventDetectionSettings

      public FieldEventDetectionSettings(Field<T> field, EventDetectionSettings eventDetectionSettings)
      Constructor from non-Field settings.
      Parameters:
      field - field
      eventDetectionSettings - non-Field detection settings

  • Method Details

    • getMaxCheckInterval

      public FieldAdaptableInterval<T> getMaxCheckInterval()
      Getter for adaptable interval.
      Returns:
      adaptable interval

    • getThreshold

      public T getThreshold()
      Getter for threshold.
      Returns:
      threshold

    • getMaxIterationCount

      public int getMaxIterationCount()
      Getter for max iter.
      Returns:
      max iter

    • withMaxCheckInterval

      public FieldEventDetectionSettings<T> withMaxCheckInterval(FieldAdaptableInterval<T> newMaxCheckInterval)
      Builds a new instance with a new max. check interval.
      Parameters:
      newMaxCheckInterval - new max. check.
      Returns:
      new object
      Since:
      13.0

    • withThreshold

      public FieldEventDetectionSettings<T> withThreshold(T newThreshold)
      Builds a new instance with a new threshold value.
      Parameters:
      newThreshold - detection threshold in seconds
      Returns:
      new object
      Since:
      13.0

    • withMaxIter

      public FieldEventDetectionSettings<T> withMaxIter(int newMaxIterationCount)
      Builds a new instance with a new max. iteration count.
      Parameters:
      newMaxIterationCount - new max iteration count.
      Returns:
      new object
      Since:
      13.0

    • getDefaultEventDetectionSettings

      public static <T extends CalculusFieldElement<T>> FieldEventDetectionSettings<T> getDefaultEventDetectionSettings(Field<T> field)
      Returns default settings for event detections.
      Type Parameters:
      T - field type
      Parameters:
      field - field
      Returns:
      default settings
      Since:
      13.0

    • toEventDetectionSettings

      public EventDetectionSettings toEventDetectionSettings()
      Create a non-Field equivalent object.
      Returns:
      event detection settings