Package org.orekit.propagation.events

Class FieldSingleDateDetector<T extends CalculusFieldElement<T>>

java.lang.Object

org.orekit.propagation.events.FieldAbstractDetector<FieldSingleDateDetector<T>,T>

org.orekit.propagation.events.FieldSingleDateDetector<T>

All Implemented Interfaces:

FieldEventDetector<T>, TimeShiftable<FieldSingleDateDetector<T>>, TimeStamped

public class FieldSingleDateDetector<T extends CalculusFieldElement<T>>
extends FieldAbstractDetector<FieldSingleDateDetector<T>,T>
implements TimeStamped, TimeShiftable<FieldSingleDateDetector<T>>

Finder for single date detection. The event function is positive after, negative before.

Since:

14.0

Author:

Romain Serra

See Also:

SingleDateDetector, FieldDateDetector

Field Summary

Fields inherited from class org.orekit.propagation.events.FieldAbstractDetector

DEFAULT_MAX_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Constructor	Description
FieldSingleDateDetector(Field<T> field, AbsoluteDate date)	Build a new instance with default detection settings and handler (stop on event).
FieldSingleDateDetector(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> eventHandler, AbsoluteDate date)	Full constructor.

Method Summary

Modifier and Type	Method	Description
protected FieldSingleDateDetector<T>	create(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> newHandler)	Build a new instance.
boolean	dependsOnTimeOnly()	Method returning true if and only if the detection function g does not depend on dependent variables, just the independent one i.e. time.
T	g(FieldSpacecraftState<T> s)	Compute the value of the switching function.
AbsoluteDate	getDate()	Get the date.
FieldSingleDateDetector<T>	shiftedBy(double dt)	Get a time-shifted instance.
FieldSingleDateDetector<T>	withDate(AbsoluteDate newDate)	Create new instance with input date.

Methods inherited from class org.orekit.propagation.events.FieldAbstractDetector

checkIfForward, getDetectionSettings, getHandler, init, isForward, withDetectionSettings, withHandler, withMaxCheck, withMaxCheck, withMaxIter, withThreshold

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.propagation.events.FieldEventDetector

dependsOnMainVariablesOnly, finish, getMaxCheckInterval, getMaxIterationCount, getThreshold, reset

Methods inherited from interface org.orekit.time.TimeShiftable

shiftedBy

Methods inherited from interface org.orekit.time.TimeStamped

durationFrom

Constructor Detail

FieldSingleDateDetector

public FieldSingleDateDetector(FieldEventDetectionSettings<T> detectionSettings,
                               FieldEventHandler<T> eventHandler,
                               AbsoluteDate date)

Full constructor.

Parameters:

detectionSettings - event detection settings

eventHandler - event handler

date - event date

FieldSingleDateDetector

public FieldSingleDateDetector(Field<T> field,
                               AbsoluteDate date)

Build a new instance with default detection settings and handler (stop on event).

Parameters:

field - field type

date - event date

Method Detail

create

protected FieldSingleDateDetector<T> create(FieldEventDetectionSettings<T> detectionSettings,
                                            FieldEventHandler<T> newHandler)

Build a new instance.

Specified by:

create in class FieldAbstractDetector<FieldSingleDateDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>

Parameters:

detectionSettings - detection settings

newHandler - event handler to call at event occurrences

Returns:

a new instance of the appropriate sub-type

dependsOnTimeOnly

public boolean dependsOnTimeOnly()

Method returning true if and only if the detection function g does not depend on dependent variables, just the independent one i.e. time. This information is used for performance in propagation and derivatives correction with switches in the dynamics.

Specified by:

dependsOnTimeOnly in interface FieldEventDetector<T extends CalculusFieldElement<T>>

Returns:

flag

g

public T g(FieldSpacecraftState<T> s)

Compute the value of the switching function. This function must be continuous (at least in its roots neighborhood), as the integrator will need to find its roots to locate the events.

Specified by:

g in interface FieldEventDetector<T extends CalculusFieldElement<T>>

Parameters:

s - the current state information: date, kinematics, attitude

Returns:

value of the switching function

getDate

public AbsoluteDate getDate()

Get the date.

Specified by:

getDate in interface TimeStamped

Returns:

date attached to the object

shiftedBy

public FieldSingleDateDetector<T> shiftedBy(double dt)

Get a time-shifted instance.

Specified by:

shiftedBy in interface TimeShiftable<T extends CalculusFieldElement<T>>

Parameters:

dt - time shift in seconds

Returns:

a new instance, shifted with respect to instance (which is not changed)

withDate

public FieldSingleDateDetector<T> withDate(AbsoluteDate newDate)

Create new instance with input date.

Parameters:

newDate - new date to be detected

Returns:

new detector