Package org.orekit.propagation.events
Class FieldEventDetectionSettings<T extends CalculusFieldElement<T>>
- java.lang.Object
-
- org.orekit.propagation.events.FieldEventDetectionSettings<T>
-
public class FieldEventDetectionSettings<T extends CalculusFieldElement<T>> extends Object
Class containing parameters for event detection.- Since:
- 12.2
- Author:
- Romain Serra.
- See Also:
EventDetectionSettings
,FieldEventDetector
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_MAX_ITER
Default maximum number of iterations in the event time search.static double
DEFAULT_MAXCHECK
Default maximum checking interval (s).static double
DEFAULT_THRESHOLD
Default convergence threshold (s).
-
Constructor Summary
Constructors Constructor Description FieldEventDetectionSettings(double maxCheck, T threshold, int maxIterationCount)
Constructor with maximum check as double.FieldEventDetectionSettings(Field<T> field, EventDetectionSettings eventDetectionSettings)
Constructor from non-Field settings.FieldEventDetectionSettings(FieldAdaptableInterval<T> maxCheckInterval, T threshold, int maxIterationCount)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FieldAdaptableInterval<T>
getMaxCheckInterval()
Getter for adaptable interval.int
getMaxIterationCount()
Getter for max iter.T
getThreshold()
Getter for threshold.EventDetectionSettings
toEventDetectionSettings()
Create a non-Field equivalent object.
-
-
-
Field Detail
-
DEFAULT_MAXCHECK
public static final double DEFAULT_MAXCHECK
Default maximum checking interval (s).- See Also:
- Constant Field Values
-
DEFAULT_THRESHOLD
public static final double DEFAULT_THRESHOLD
Default convergence threshold (s).- See Also:
- Constant Field Values
-
DEFAULT_MAX_ITER
public static final int DEFAULT_MAX_ITER
Default maximum number of iterations in the event time search.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
FieldEventDetectionSettings
public FieldEventDetectionSettings(FieldAdaptableInterval<T> maxCheckInterval, T threshold, int maxIterationCount)
Constructor.- Parameters:
maxCheckInterval
- adaptable intervalthreshold
- detection threshold on timemaxIterationCount
- 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 intervalthreshold
- detection threshold on timemaxIterationCount
- maximum iteration number
-
FieldEventDetectionSettings
public FieldEventDetectionSettings(Field<T> field, EventDetectionSettings eventDetectionSettings)
Constructor from non-Field settings.- Parameters:
field
- fieldeventDetectionSettings
- non-Field detection settings
-
-
Method Detail
-
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
-
toEventDetectionSettings
public EventDetectionSettings toEventDetectionSettings()
Create a non-Field equivalent object.- Returns:
- event detection settings
-
-