Package org.orekit.propagation.events

Class FieldNegateDetector<T extends CalculusFieldElement<T>>

java.lang.Object

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

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

Type Parameters:

T - type of the field element

All Implemented Interfaces:

FieldDetectorModifier<T>, FieldEventDetector<T>

public class FieldNegateDetector<T extends CalculusFieldElement<T>>
extends FieldAbstractDetector<FieldNegateDetector<T>,T>
implements FieldDetectorModifier<T>

An event detector that negates the sign on another event detector's g function.

Since:

12.0

Author:

Evan Ward, Luc Maisonobe

Field Summary

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

DEFAULT_MAX_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FieldNegateDetector(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> newHandler, FieldEventDetector<T> original)	Protected constructor.
	FieldNegateDetector(FieldEventDetector<T> original)	Create a new event detector that negates an existing event detector.

Method Summary

Modifier and Type	Method	Description
protected FieldNegateDetector<T>	create(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> newHandler)	Build a new instance.
T	g(FieldSpacecraftState<T> s)	Compute the value of the switching function.
FieldEventDetector<T>	getDetector()	Getter for wrapped detector.
FieldEventDetector<T>	getOriginal()	Get the delegate event detector.
void	init(FieldSpacecraftState<T> s0, FieldAbsoluteDate<T> t)	Initialize event detector at the start of a propagation.

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

checkIfForward, getDetectionSettings, getHandler, 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.FieldDetectorModifier

finish, getDetectionSettings, getHandler, reset

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

getMaxCheckInterval, getMaxIterationCount, getThreshold

Constructor Detail

FieldNegateDetector

public FieldNegateDetector(FieldEventDetector<T> original)

Create a new event detector that negates an existing event detector.

This detector will be initialized with the same FieldEventDetector.getMaxCheckInterval(), FieldEventDetector.getThreshold(), and FieldEventDetector.getMaxIterationCount() as original. Initially this detector will use the FieldContinueOnEvent event handler.

Parameters:

original - detector.

FieldNegateDetector

protected FieldNegateDetector(FieldEventDetectionSettings<T> detectionSettings,
                              FieldEventHandler<T> newHandler,
                              FieldEventDetector<T> original)

Protected constructor.

Parameters:

detectionSettings - event detection settings.

newHandler - event handler.

original - event detector.

Since:

13.0

Method Detail

getOriginal

public FieldEventDetector<T> getOriginal()

Get the delegate event detector.

Returns:

the delegate event detector

getDetector

public FieldEventDetector<T> getDetector()

Description copied from interface: FieldDetectorModifier

Getter for wrapped detector.

Specified by:

getDetector in interface FieldDetectorModifier<T extends CalculusFieldElement<T>>

Returns:

detector

init

public void init(FieldSpacecraftState<T> s0,
                 FieldAbsoluteDate<T> t)

Description copied from class: FieldAbstractDetector

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 FieldDetectorModifier<T extends CalculusFieldElement<T>>

Specified by:

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

Overrides:

init in class FieldAbstractDetector<FieldNegateDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>

Parameters:

s0 - initial state

t - target time for the integration

g

public T g(FieldSpacecraftState<T> s)

Description copied from interface: FieldDetectorModifier

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 FieldDetectorModifier<T extends CalculusFieldElement<T>>

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

create

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

Description copied from class: FieldAbstractDetector

Build a new instance.

Specified by:

create in class FieldAbstractDetector<FieldNegateDetector<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