fr.cnes.sirius.patrius.propagation.events

Class ExtremaThreeBodiesAngleDetector

java.lang.Object

fr.cnes.sirius.patrius.propagation.events.AbstractDetector

fr.cnes.sirius.patrius.propagation.events.ExtremaThreeBodiesAngleDetector

All Implemented Interfaces:

EventDetector, MultiEventDetector, Serializable

public class ExtremaThreeBodiesAngleDetector
extends AbstractDetector
implements MultiEventDetector

Detects the maximal or minimal angle between three bodies is reached, the spacecraft eventually being one of the bodies. If body₁, body₂ and body₃ are the three bodies, the detector computes the angle between the two vectors v₂₁ (vector from body₂ to body₁) and v₂₃ (vector from body₂ to body₃). The local minimum or maximum is chosen through a constructor parameter, with values ExtremaLatitudeDetector.MIN, ExtremaLatitudeDetector.MAX and ExtremaLatitudeDetector.MIN_MAX for both.

The default implementation behavior is to stop propagation at minimum or/and maximum angle between three bodies depending on extremum type defined. This can be changed by overriding one of the following constructors :

• ExtremaThreeBodiesAngleDetector or ExtremaThreeBodiesAngleDetector: the defined action is performed at maximal OR/AND minimal angle depending on slope selection defined.
• ExtremaThreeBodiesAngleDetector or ExtremaThreeBodiesAngleDetector : the defined actions are performed at minimal AND maximal angle.

A multi spacecraft propagation could be performed using the following constructors :

• ExtremaThreeBodiesAngleDetector: the defined action is performed at maximal OR/AND minimal angle depending on slope selection defined.
• ExtremaThreeBodiesAngleDetector : the defined actions are performed at minimal AND maximal angle.

Since:

1.1

Version:

$Id: ExtremaThreeBodiesAngleDetector.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Thomas Trapier

See Also:

EventDetector, Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

attributes are mutable and related to propagation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExtremaThreeBodiesAngleDetector.BodyOrder Bodies order type.

Nested classes/interfaces inherited from class fr.cnes.sirius.patrius.propagation.events.AbstractDetector

AbstractDetector.PropagationDelayType

Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.propagation.events.EventDetector

EventDetector.Action

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX Flag for local maximum angle detection (g decreasing).
static int	MIN Flag for local minimum angle detection (g increasing).
static int	MIN_MAX Flag for both local minimum and maximum angle detection.

Fields inherited from class fr.cnes.sirius.patrius.propagation.events.AbstractDetector

actionAtEntry, actionAtExit, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD, removeAtEntry, removeAtExit, shouldBeRemovedFlag

Fields inherited from interface fr.cnes.sirius.patrius.propagation.events.multi.MultiEventDetector

DECREASING, INCREASING, INCREASING_DECREASING

Fields inherited from interface fr.cnes.sirius.patrius.propagation.events.EventDetector

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider bodyA, PVCoordinatesProvider bodyB, ExtremaThreeBodiesAngleDetector.BodyOrder bodyC, double maxCheck, double threshold, EventDetector.Action actionMin, EventDetector.Action actionMax) Constructor for the min and max three bodies angle detector with specified action for both minimum and maximum.
ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider bodyA, PVCoordinatesProvider bodyB, ExtremaThreeBodiesAngleDetector.BodyOrder bodyC, double maxCheck, double threshold, EventDetector.Action actionMin, EventDetector.Action actionMax, boolean removeMin, boolean removeMax) Constructor for the min and max three bodies angle detector with specified action for both minimum and maximum.
ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider bodyA, PVCoordinatesProvider bodyB, ExtremaThreeBodiesAngleDetector.BodyOrder bodyC, int extremumType) Simple constructor for the min and max three bodies angle detector.
ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider bodyA, PVCoordinatesProvider bodyB, ExtremaThreeBodiesAngleDetector.BodyOrder bodyC, int extremumType, double maxCheck, double threshold) Constructor for the min and max three bodies angle detector with defined maximum check and convergence threshold.
ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider bodyA, PVCoordinatesProvider bodyB, ExtremaThreeBodiesAngleDetector.BodyOrder bodyC, int extremumType, double maxCheck, double threshold, EventDetector.Action action) Constructor for the min and max three bodies angle detector with specified action when extrema is detected.
ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider bodyA, PVCoordinatesProvider bodyB, ExtremaThreeBodiesAngleDetector.BodyOrder bodyC, int extremumType, double maxCheck, double threshold, EventDetector.Action action, boolean remove) Constructor for the min and max three bodies angle detector with specified action when extrema is detected.
ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider firstBody, PVCoordinatesProvider secondBody, PVCoordinatesProvider thirdBody, double maxCheck, double threshold, EventDetector.Action actionMin, EventDetector.Action actionMax) Constructor for the min and max three bodies angle detector with specified action for both minimum and maximum.
ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider firstBody, PVCoordinatesProvider secondBody, PVCoordinatesProvider thirdBody, double maxCheck, double threshold, EventDetector.Action actionMin, EventDetector.Action actionMax, boolean removeMin, boolean removeMax) Constructor for the min and max three bodies angle detector with specified action for both minimum and maximum.
ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider firstBody, PVCoordinatesProvider secondBody, PVCoordinatesProvider thirdBody, int extremumType) Constructor for the min and max three bodies angle detector.
ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider firstBody, PVCoordinatesProvider secondBody, PVCoordinatesProvider thirdBody, int extremumType, double maxCheck, double threshold) Constructor for the min and max three bodies angle detector.
ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider firstBody, PVCoordinatesProvider secondBody, PVCoordinatesProvider thirdBody, int extremumType, double maxCheck, double threshold, EventDetector.Action action) Constructor for the min and max three bodies angle detector with specified action when extrema is detected.
ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider firstBody, PVCoordinatesProvider secondBody, PVCoordinatesProvider thirdBody, int extremumType, double maxCheck, double threshold, EventDetector.Action action, boolean remove) Constructor for the min and max three bodies angle detector with specified action when extrema is detected.
ExtremaThreeBodiesAngleDetector(String firstBody, String secondBody, String thirdBody, double maxCheck, double threshold, EventDetector.Action actionMin, EventDetector.Action actionMax) Constructor for the min and max three bodies angle detector with specified action for both minimum and maximum.
ExtremaThreeBodiesAngleDetector(String firstBody, String secondBody, String thirdBody, double maxCheck, double threshold, EventDetector.Action actionMin, EventDetector.Action actionMax, boolean removeMin, boolean removeMax) Constructor for the min and max three bodies angle detector with specified action for both minimum and maximum.
ExtremaThreeBodiesAngleDetector(String firstBody, String secondBody, String thirdBody, int extremumType, double maxCheck, double threshold, EventDetector.Action action) Constructor for the min and max three bodies angle detector with specified action when extrema is detected.
ExtremaThreeBodiesAngleDetector(String firstBody, String secondBody, String thirdBody, int extremumType, double maxCheck, double threshold, EventDetector.Action action, boolean remove) Constructor for the min and max three bodies angle detector with specified action when extrema is detected.

Method Summary

Modifier and Type	Method and Description
EventDetector	copy() A copy of the detector.
EventDetector.Action	eventOccurred(Map<String,SpacecraftState> s, boolean increasing, boolean forward) Handle an event and choose what to do next.
EventDetector.Action	eventOccurred(SpacecraftState s, boolean increasing, boolean forward) Handle a min or max angle event and choose what to do next.
double	g(Map<String,SpacecraftState> s) Compute the value of the switching function.
double	g(SpacecraftState state) Compute the value of the switching function.
PVCoordinatesProvider	getFirstBody() Get 1st body
String	getInSpacecraftId1() Get the first spacecraft id
String	getInSpacecraftId2() Get the second spacecraft id
String	getInSpacecraftId3() Get the third spacecraft id
PVCoordinatesProvider	getSecondBody() Get 2nd body
PVCoordinatesProvider	getThirdBody() Get 3rd body
void	init(Map<String,SpacecraftState> s0, AbsoluteDate t) Initialize event handler at the start of a propagation.
void	init(SpacecraftState s0, AbsoluteDate t) Initialize event handler at the start of a propagation.
Map<String,SpacecraftState>	resetStates(Map<String,SpacecraftState> oldStates) Reset the states (including additional states) prior to continue propagation.

Methods inherited from class fr.cnes.sirius.patrius.propagation.events.AbstractDetector

getActionAtEntry, getActionAtExit, getInertialFrame, getMaxCheckInterval, getMaxIterationCount, getPropagationDelayType, getSignalEmissionDate, getSignalReceptionDate, getSlopeSelection, getThreshold, isRemoveAtEntry, isRemoveAtExit, logEventsOverTimeInterval, resetState, setEpsilonSignalPropagation, setMaxCheckInterval, setMaxIterSignalPropagation, setPropagationDelayType, shouldBeRemoved

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.sirius.patrius.propagation.events.multi.MultiEventDetector

getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, shouldBeRemoved

Field Detail

MIN

public static final int MIN

Flag for local minimum angle detection (g increasing).

See Also:

Constant Field Values

MAX

public static final int MAX

Flag for local maximum angle detection (g decreasing).

See Also:

Constant Field Values

MIN_MAX

public static final int MIN_MAX

Flag for both local minimum and maximum angle detection.

See Also:

Constant Field Values

Constructor Detail

ExtremaThreeBodiesAngleDetector

public ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider firstBody,
                                       PVCoordinatesProvider secondBody,
                                       PVCoordinatesProvider thirdBody,
                                       int extremumType)

Constructor for the min and max three bodies angle detector.

If v₂₁ is the vector from the second body to the first body and v₂₃ is the vector from the second body to the third body, the detected angle will be the angle (in the range 0-Π) between v₂₁ and v₂₃.

The default implementation behavior is to stop propagation when the expected extrema is reached.

Parameters:

firstBody - the body "1"

secondBody - the body "2"

thirdBody - the body "3"

extremumType - MIN for minimal angle detection, MAX for maximal angle detection or MIN_MAX for both minimal and maximal angle detection

ExtremaThreeBodiesAngleDetector

public ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider firstBody,
                                       PVCoordinatesProvider secondBody,
                                       PVCoordinatesProvider thirdBody,
                                       int extremumType,
                                       double maxCheck,
                                       double threshold)

Constructor for the min and max three bodies angle detector.

If v₂₁ is the vector from the second body to the first body and v₂₃ is the vector from the second body to the third body, the detected angle will be the angle (in the range 0-Π) between v₂₁ and v₂₃.

The default implementation behavior is to stop propagation when the expected extrema is reached.

Parameters:

firstBody - the body "1"

secondBody - the body "2"

thirdBody - the body "3"

extremumType - MIN for minimal angle detection, MAX for maximal angle detection or MIN_MAX for both minimal and maximal angle detection

maxCheck - maximum check (see AbstractDetector)

threshold - convergence threshold (see AbstractDetector)

ExtremaThreeBodiesAngleDetector

public ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider firstBody,
                                       PVCoordinatesProvider secondBody,
                                       PVCoordinatesProvider thirdBody,
                                       double maxCheck,
                                       double threshold,
                                       EventDetector.Action actionMin,
                                       EventDetector.Action actionMax)

Constructor for the min and max three bodies angle detector with specified action for both minimum and maximum.

If v₂₁ is the vector from the second body to the first body and v₂₃ is the vector from the second body to the third body, the detected angle will be the angle (in the range 0-Π) between v₂₁ and v₂₃.

Parameters:

firstBody - the body "1"

secondBody - the body "2"

thirdBody - the body "3"

maxCheck - maximum check (see AbstractDetector)

threshold - convergence threshold (see AbstractDetector)

actionMin - action to be performed when the expected local minimum is reached

actionMax - action to be performed when the expected local maximum is reached

ExtremaThreeBodiesAngleDetector

public ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider firstBody,
                                       PVCoordinatesProvider secondBody,
                                       PVCoordinatesProvider thirdBody,
                                       double maxCheck,
                                       double threshold,
                                       EventDetector.Action actionMin,
                                       EventDetector.Action actionMax,
                                       boolean removeMin,
                                       boolean removeMax)

Constructor for the min and max three bodies angle detector with specified action for both minimum and maximum.

If v₂₁ is the vector from the second body to the first body and v₂₃ is the vector from the second body to the third body, the detected angle will be the angle (in the range 0-Π) between v₂₁ and v₂₃.

Parameters:

firstBody - the body "1"

secondBody - the body "2"

thirdBody - the body "3"

maxCheck - maximum check (see AbstractDetector)

threshold - convergence threshold (see AbstractDetector)

actionMin - action to be performed when the expected local minimum is reached

actionMax - action to be performed when the expected local maximum is reached

removeMin - true if detector should be removed when the expected local minimum is reached

removeMax - true if detector should be removed when the expected local maximum is reached

Since:

3.1

ExtremaThreeBodiesAngleDetector

public ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider firstBody,
                                       PVCoordinatesProvider secondBody,
                                       PVCoordinatesProvider thirdBody,
                                       int extremumType,
                                       double maxCheck,
                                       double threshold,
                                       EventDetector.Action action)

Constructor for the min and max three bodies angle detector with specified action when extrema is detected.

If v₂₁ is the vector from the second body to the first body and v₂₃ is the vector from the second body to the third body, the detected angle will be the angle (in the range 0-Π) between v₂₁ and v₂₃.

Parameters:

firstBody - the body "1"

secondBody - the body "2"

thirdBody - the body "3"

extremumType - MIN for minimal angle detection, MAX for maximal angle detection or MIN_MAX for both minimal and maximal angle detection

maxCheck - maximum check (see AbstractDetector)

threshold - convergence threshold (see AbstractDetector)

action - action to be performed when the expected extrema is reached.

ExtremaThreeBodiesAngleDetector

public ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider firstBody,
                                       PVCoordinatesProvider secondBody,
                                       PVCoordinatesProvider thirdBody,
                                       int extremumType,
                                       double maxCheck,
                                       double threshold,
                                       EventDetector.Action action,
                                       boolean remove)

Constructor for the min and max three bodies angle detector with specified action when extrema is detected.

If v₂₁ is the vector from the second body to the first body and v₂₃ is the vector from the second body to the third body, the detected angle will be the angle (in the range 0-Π) between v₂₁ and v₂₃.

Parameters:

firstBody - the body "1"

secondBody - the body "2"

thirdBody - the body "3"

extremumType - MIN for minimal angle detection, MAX for maximal angle detection or MIN_MAX for both minimal and maximal angle detection

maxCheck - maximum check (see AbstractDetector)

threshold - convergence threshold (see AbstractDetector)

action - action to be performed when the expected extrema is reached.

remove - true if detector should be removed when the expected extrema is reached. NB : If remove is true, it means detector should be removed at detection, so the value of attributes removeMIN and removeMAX must be decided according extremumType. Doing it, we ensure that detector will be removed well at propagation when calling method eventOccured (in which the value of attribute shouldBeRemoved is decided). In this case, users should better create an ExtremaThreeBodiesAngleDetector with constructor ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider, PVCoordinatesProvider, PVCoordinatesProvider, double, double, EventDetector.Action, EventDetector.Action, boolean, boolean)

Since:

3.1

ExtremaThreeBodiesAngleDetector

public ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider bodyA,
                                       PVCoordinatesProvider bodyB,
                                       ExtremaThreeBodiesAngleDetector.BodyOrder bodyC,
                                       int extremumType)

Simple constructor for the min and max three bodies angle detector. The orbit of one of the three bodies is implicitly the one which is propagated by the propagator associated to this event detector.

The default implementation behavior is to stop propagation when the expected extrema is reached.

If v₂₁ is the vector from the second body to the first body and v₂₃ is the vector from the second body to the third body, the detected angle will be the angle (in the range 0-Π) between v₂₁ and v₂₃.

Parameters:

bodyA - first body (if the body C is the second or third body), second body otherwise.

bodyB - third body (if the body C is the first or second body), second body otherwise.

bodyC - position within the constellation of the body whose orbit will be propagated by the propagator associated to this event detector.

extremumType - MIN for minimal angle detection, MAX for maximal angle detection or MIN_MAX for both minimal and maximal angle detection.

ExtremaThreeBodiesAngleDetector

public ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider bodyA,
                                       PVCoordinatesProvider bodyB,
                                       ExtremaThreeBodiesAngleDetector.BodyOrder bodyC,
                                       int extremumType,
                                       double maxCheck,
                                       double threshold)

Constructor for the min and max three bodies angle detector with defined maximum check and convergence threshold. The orbit of one of the three bodies is implicitly the one which is propagated by the propagator associated to this event detector.

The default implementation behavior is to stop propagation when the expected extrema is reached.

If v₂₁ is the vector from the second body to the first body and v₂₃ is the vector from the second body to the third body, the detected angle will be the angle (in the range 0-Π) between v₂₁ and v₂₃.

Parameters:

bodyA - first body (if the body C is the second or third body), second body otherwise

bodyB - third body (if the body C is the first or second body), second body otherwise

bodyC - position within the constellation of the body whose orbit will be propagated by the propagator associated to this event detector

extremumType - MIN for minimal angle detection, MAX for maximal angle detection or MIN_MAX for both minimal and maximal angle detection

maxCheck - maximum check (see AbstractDetector)

threshold - convergence threshold (see AbstractDetector)

ExtremaThreeBodiesAngleDetector

public ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider bodyA,
                                       PVCoordinatesProvider bodyB,
                                       ExtremaThreeBodiesAngleDetector.BodyOrder bodyC,
                                       double maxCheck,
                                       double threshold,
                                       EventDetector.Action actionMin,
                                       EventDetector.Action actionMax)

Constructor for the min and max three bodies angle detector with specified action for both minimum and maximum. The orbit of one of the three bodies is implicitly the one which is propagated by the propagator associated to this event detector.

If v₂₁ is the vector from the second body to the first body and v₂₃ is the vector from the second body to the third body, the detected angle will be the angle (in the range 0-Π) between v₂₁ and v₂₃.

Parameters:

bodyA - first body (if the body C is the second or third body), second body otherwise.

bodyB - third body (if the body C is the first or second body), second body otherwise.

bodyC - position within the constellation of the body whose orbit will be propagated by the propagator associated to this event detector.

maxCheck - maximum check (see AbstractDetector)

threshold - convergence threshold (see AbstractDetector)

actionMin - action to be perform when the expected local minimum is reached.

actionMax - action to be perform when the expected local maximum is reached.

ExtremaThreeBodiesAngleDetector

public ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider bodyA,
                                       PVCoordinatesProvider bodyB,
                                       ExtremaThreeBodiesAngleDetector.BodyOrder bodyC,
                                       double maxCheck,
                                       double threshold,
                                       EventDetector.Action actionMin,
                                       EventDetector.Action actionMax,
                                       boolean removeMin,
                                       boolean removeMax)

Constructor for the min and max three bodies angle detector with specified action for both minimum and maximum. The orbit of one of the three bodies is implicitly the one which is propagated by the propagator associated to this event detector.

If v₂₁ is the vector from the second body to the first body and v₂₃ is the vector from the second body to the third body, the detected angle will be the angle (in the range 0-Π) between v₂₁ and v₂₃.

Parameters:

bodyA - first body (if the body C is the second or third body), second body otherwise.

bodyB - third body (if the body C is the first or second body), second body otherwise.

bodyC - position within the constellation of the body whose orbit will be propagated by the propagator associated to this event detector.

maxCheck - maximum check (see AbstractDetector)

threshold - convergence threshold (see AbstractDetector)

actionMin - action to be perform when the expected local minimum is reached

actionMax - action to be perform when the expected local maximum is reached

removeMin - true if detector should be removed when the expected local minimum is reached

removeMax - true if detector should be removed when the expected local maximum is reached

Since:

3.1

ExtremaThreeBodiesAngleDetector

public ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider bodyA,
                                       PVCoordinatesProvider bodyB,
                                       ExtremaThreeBodiesAngleDetector.BodyOrder bodyC,
                                       int extremumType,
                                       double maxCheck,
                                       double threshold,
                                       EventDetector.Action action)

Constructor for the min and max three bodies angle detector with specified action when extrema is detected. The orbit of one of the three bodies is implicitly the one which is propagated by the propagator associated to this event detector.

If v₂₁ is the vector from the second body to the first body and v₂₃ is the vector from the second body to the third body, the detected angle will be the angle (in the range 0-Π) between v₂₁ and v₂₃.

Parameters:

bodyA - first body (if the body C is the second or third body), second body otherwise.

bodyB - third body (if the body C is the first or second body), second body otherwise.

bodyC - position within the constellation of the body whose orbit will be propagated by the propagator associated to this event detector.

extremumType - the extremum type : MIN for minimal angle detection, MAX for maximal angle detection or MIN_MAX for both minimal and maximal angle detection

maxCheck - maximum check (see AbstractDetector)

threshold - convergence threshold (see AbstractDetector)

action - action to be perform when the expected local maximum is reached

ExtremaThreeBodiesAngleDetector

public ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider bodyA,
                                       PVCoordinatesProvider bodyB,
                                       ExtremaThreeBodiesAngleDetector.BodyOrder bodyC,
                                       int extremumType,
                                       double maxCheck,
                                       double threshold,
                                       EventDetector.Action action,
                                       boolean remove)

Constructor for the min and max three bodies angle detector with specified action when extrema is detected. The orbit of one of the three bodies is implicitly the one which is propagated by the propagator associated to this event detector.

If v₂₁ is the vector from the second body to the first body and v₂₃ is the vector from the second body to the third body, the detected angle will be the angle (in the range 0-Π) between v₂₁ and v₂₃.

Parameters:

bodyA - first body (if the body C is the second or third body), second body otherwise

bodyB - third body (if the body C is the first or second body), second body otherwise

bodyC - position within the constellation of the body whose orbit will be propagated by the propagator associated to this event detector

extremumType - the extremum type : MIN for minimal angle detection, MAX for maximal angle detection or MIN_MAX for both minimal and maximal angle detection

maxCheck - maximum check (see AbstractDetector)

threshold - convergence threshold (see AbstractDetector)

action - action to be perform when the expected local maximum is reached

remove - true if detector should be removed when the expected extrema is reached. NB : If remove is true, it means detector should be removed at detection, so the value of attributes removeMIN and removeMAX must be decided according extremumType. Doing it, we ensure that detector will be removed well at propagation when calling method eventOccured (in which the value of attribute shouldBeRemoved is decided). In this case, users should better create an ExtremaThreeBodiesAngleDetector with constructor ExtremaThreeBodiesAngleDetector(PVCoordinatesProvider, PVCoordinatesProvider, BodyOrder, double, double, EventDetector.Action, EventDetector.Action, boolean, boolean) .

ExtremaThreeBodiesAngleDetector

public ExtremaThreeBodiesAngleDetector(String firstBody,
                                       String secondBody,
                                       String thirdBody,
                                       double maxCheck,
                                       double threshold,
                                       EventDetector.Action actionMin,
                                       EventDetector.Action actionMax)

Constructor for the min and max three bodies angle detector with specified action for both minimum and maximum. Constructor to be used for multi spacecraft propagation only.

If v₂₁ is the vector from the second body to the first body and v₂₃ is the vector from the second body to the third body, the detected angle will be the angle (in the range 0-Π) between v₂₁ and v₂₃.

Parameters:

firstBody - the body "1" id

secondBody - the body "2" id

thirdBody - the body "3" id

maxCheck - maximum check (see AbstractDetector)

threshold - convergence threshold (see AbstractDetector)

actionMin - action to be performed when the expected local minimum is reached

actionMax - action to be performed when the expected local maximum is reached

ExtremaThreeBodiesAngleDetector

public ExtremaThreeBodiesAngleDetector(String firstBody,
                                       String secondBody,
                                       String thirdBody,
                                       double maxCheck,
                                       double threshold,
                                       EventDetector.Action actionMin,
                                       EventDetector.Action actionMax,
                                       boolean removeMin,
                                       boolean removeMax)

Constructor for the min and max three bodies angle detector with specified action for both minimum and maximum. Constructor to be used for multi-spacecraft propagation only.

If v₂₁ is the vector from the second body to the first body and v₂₃ is the vector from the second body to the third body, the detected angle will be the angle (in the range 0-Π) between v₂₁ and v₂₃.

Parameters:

firstBody - the body "1" id

secondBody - the body "2" id

thirdBody - the body "3" id

maxCheck - maximum check (see AbstractDetector)

threshold - convergence threshold (see AbstractDetector)

actionMin - action to be performed when the expected local minimum is reached

actionMax - action to be performed when the expected local maximum is reached

removeMin - true if detector should be removed when the expected local minimum is reached.

removeMax - true if detector should be removed when the expected local maximum is reached.

ExtremaThreeBodiesAngleDetector

public ExtremaThreeBodiesAngleDetector(String firstBody,
                                       String secondBody,
                                       String thirdBody,
                                       int extremumType,
                                       double maxCheck,
                                       double threshold,
                                       EventDetector.Action action)

Constructor for the min and max three bodies angle detector with specified action when extrema is detected.

If v₂₁ is the vector from the second body to the first body and v₂₃ is the vector from the second body to the third body, the detected angle will be the angle (in the range 0-Π) between v₂₁ and v₂₃.

Parameters:

firstBody - the body "1" id

secondBody - the body "2" id

thirdBody - the body "3" id

extremumType - MIN for minimal angle detection, MAX for maximal angle detection or MIN_MAX for both minimal and maximal angle detection

maxCheck - maximum check (see AbstractDetector)

threshold - convergence threshold (see AbstractDetector)

action - action to be performed when the expected extrema is reached.

ExtremaThreeBodiesAngleDetector

public ExtremaThreeBodiesAngleDetector(String firstBody,
                                       String secondBody,
                                       String thirdBody,
                                       int extremumType,
                                       double maxCheck,
                                       double threshold,
                                       EventDetector.Action action,
                                       boolean remove)

Constructor for the min and max three bodies angle detector with specified action when extrema is detected.

If v₂₁ is the vector from the second body to the first body and v₂₃ is the vector from the second body to the third body, the detected angle will be the angle (in the range 0-Π) between v₂₁ and v₂₃.

Parameters:

firstBody - the body "1" id

secondBody - the body "2" id

thirdBody - the body "3" id

extremumType - MIN for minimal angle detection, MAX for maximal angle detection or MIN_MAX for both minimal and maximal angle detection

maxCheck - maximum check (see AbstractDetector)

threshold - convergence threshold (see AbstractDetector)

action - action to be performed when the expected extrema is reached.

remove - true if detector should be removed when the expected extrema is reached. NB : If remove is true, it means detector should be removed at detection, so the value of attributes removeMIN and removeMAX must be decided according extremumType. Doing it, we ensure that detector will be removed well at propagation when calling method eventOccured (in which the value of attribute shouldBeRemoved is decided). In this case, users should better create an ExtremaThreeBodiesAngleDetector with constructor ExtremaThreeBodiesAngleDetector(String, String, String, double, double, EventDetector.Action, EventDetector.Action, boolean, boolean)

Method Detail

init

public void init(SpacecraftState s0,
                 AbsoluteDate t)

Initialize event handler at the start of a propagation.

This method is called once at the start of the propagation. It may be used by the event handler to initialize some internal data if needed.

Specified by:

init in interface EventDetector

Overrides:

init in class AbstractDetector

Parameters:

s0 - initial state

t - target time for the integration

eventOccurred

public EventDetector.Action eventOccurred(SpacecraftState s,
                                          boolean increasing,
                                          boolean forward)
                                   throws PatriusException

Handle a min or max angle event and choose what to do next.

The default implementation behavior is to stop propagation when the angle is reached.

Specified by:

eventOccurred in interface EventDetector

Overrides:

eventOccurred in class AbstractDetector

Parameters:

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

increasing - if true, the value of the switching function increases when times increases around event

forward - if true, the integration variable (time) increases during integration.

Returns:

the action performed when the expected angle is reached.

Throws:

PatriusException - if some specific error occurs

g

public double g(SpacecraftState state)
         throws PatriusException

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 EventDetector

Specified by:

g in class AbstractDetector

Parameters:

state - the current state information: date, kinematics, attitude for forces and events computation, mass provider, and additional states

Returns:

value of the switching function

Throws:

PatriusException - if some specific error occurs

getFirstBody

public PVCoordinatesProvider getFirstBody()

Get 1st body

Returns:

the 1st body

getSecondBody

public PVCoordinatesProvider getSecondBody()

Get 2nd body

Returns:

the 2nd body

getThirdBody

public PVCoordinatesProvider getThirdBody()

Get 3rd body

Returns:

the 3rd body

init

public void init(Map<String,SpacecraftState> s0,
                 AbsoluteDate t)

Initialize event handler at the start of a propagation.

This method is called once at the start of the propagation. It may be used by the event handler to initialize some internal data if needed.

Specified by:

init in interface MultiEventDetector

Parameters:

s0 - map of initial states

t - target time for the integration

g

public double g(Map<String,SpacecraftState> s)
         throws PatriusException

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 MultiEventDetector

Parameters:

s - the current states information: date, kinematics, attitudes for forces and events computation, and additional states for each states

Returns:

value of the switching function

Throws:

PatriusException - if some specific error occurs

eventOccurred

public EventDetector.Action eventOccurred(Map<String,SpacecraftState> s,
                                          boolean increasing,
                                          boolean forward)
                                   throws PatriusException

Handle an event and choose what to do next.

The scheduling between this method and the MultiOrekitStepHandler method handleStep is to call this method first and handleStep afterwards. This scheduling allows the propagator to pass true as the isLast parameter to the step handler to make it aware the step will be the last one if this method returns EventDetector.Action.STOP. As the interpolator may be used to navigate back throughout the last step MultiOrekitStepNormalizer does for example), user code called by this method and user code called by step handlers may experience apparently out of order values of the independent time variable. As an example, if the same user object implements both this MultiEventDetector interface and the MultiOrekitFixedStepHandler interface, a forward integration may call its eventOccurred method with a state at 2000-01-01T00:00:10 first and call its handleStep method with a state at 2000-01-01T00:00:09 afterwards. Such out of order calls are limited to the size of the integration step for MultiOrekitStepHandler and to the size of the fixed step for MultiOrekitFixedStepHandler.

Specified by:

eventOccurred in interface MultiEventDetector

Parameters:

s - the current states information: date, kinematics, attitude for forces and events computation, and additional states for each states

increasing - if true, the value of the switching function increases when times increases around event (note that increase is measured with respect to physical time, not with respect to propagation which may go backward in time)

forward - if true, the integration variable (time) increases during integration.

Returns:

one of EventDetector.Action.STOP, EventDetector.Action.RESET_STATE, EventDetector.Action.RESET_DERIVATIVES, EventDetector.Action.CONTINUE

Throws:

PatriusException - if some specific error occurs

resetStates

public Map<String,SpacecraftState> resetStates(Map<String,SpacecraftState> oldStates)
                                        throws PatriusException

Reset the states (including additional states) prior to continue propagation.

This method is called after the step handler has returned and before the next step is started, but only when MultiEventDetector.eventOccurred(java.util.Map<java.lang.String, fr.cnes.sirius.patrius.propagation.SpacecraftState>, boolean, boolean) has itself returned the EventDetector.Action.RESET_STATE indicator. It allows the user to reset the state for the next step, without perturbing the step handler of the finishing step. If the MultiEventDetector.eventOccurred(java.util.Map<java.lang.String, fr.cnes.sirius.patrius.propagation.SpacecraftState>, boolean, boolean) never returns the EventDetector.Action.RESET_STATE indicator, this function will never be called, and it is safe to simply return null.

Specified by:

resetStates in interface MultiEventDetector

Parameters:

oldStates - old states

Returns:

new states

Throws:

PatriusException - if the states cannot be reseted

getInSpacecraftId1

public String getInSpacecraftId1()

Get the first spacecraft id

Returns:

the first spacecraft id

getInSpacecraftId2

public String getInSpacecraftId2()

Get the second spacecraft id

Returns:

the second spacecraft id

getInSpacecraftId3

public String getInSpacecraftId3()

Get the third spacecraft id

Returns:

the third spacecraft id

copy

public EventDetector copy()

A copy of the detector. By default copy is deep. If not, detector javadoc will specify which attribute is not fully copied. In that case, the attribute reference is passed.

The following attributes are not deeply copied:

• body1: PVCoordinatesProvider
• body2: PVCoordinatesProvider
• body3: PVCoordinatesProvider

Specified by:

copy in interface EventDetector

Returns:

a copy of the detector.