Package org.orekit.control.indirect.adjoint.cost

Class FieldControlSwitchDetector<T extends CalculusFieldElement<T>>

java.lang.Object

org.orekit.control.indirect.adjoint.cost.FieldControlSwitchDetector<T>

All Implemented Interfaces:

FieldEventDetector<T>

public abstract class FieldControlSwitchDetector<T extends CalculusFieldElement<T>>
extends Object
implements FieldEventDetector<T>

Abstract event detector for singularities in adjoint dynamics.

Since:

13.0

Author:

Romain Serra

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FieldControlSwitchDetector(FieldEventDetectionSettings<T> detectionSettings)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	dependsOnMainVariablesOnly()	Method returning true if and only if the detection function g does not depend on dependent variables, other than the Cartesian coordinates (or equivalent), mass and attitude (excepts for its rates).
FieldEventDetectionSettings<T>	getDetectionSettings()	Getter for the settings.
FieldEventHandler<T>	getHandler()	Get the handler.

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

dependsOnTimeOnly, finish, g, getMaxCheckInterval, getMaxIterationCount, getThreshold, init, reset

Constructor Detail

FieldControlSwitchDetector

protected FieldControlSwitchDetector(FieldEventDetectionSettings<T> detectionSettings)

Constructor.

Parameters:

detectionSettings - detection settings

Method Detail

dependsOnMainVariablesOnly

public boolean dependsOnMainVariablesOnly()

Description copied from interface: FieldEventDetector

Method returning true if and only if the detection function g does not depend on dependent variables, other than the Cartesian coordinates (or equivalent), mass and attitude (excepts for its rates). It should thus return false if the STM is needed to evaluate the event. This information is used for performance in propagation.

Specified by:

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

Returns:

flag

getDetectionSettings

public FieldEventDetectionSettings<T> getDetectionSettings()

Description copied from interface: FieldEventDetector

Getter for the settings.

Specified by:

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

Returns:

detection settings

getHandler

public FieldEventHandler<T> getHandler()

Description copied from interface: FieldEventDetector

Get the handler.

Specified by:

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

Returns:

event handler to call at event occurrences