fr.cnes.sirius.patrius.propagation.events

Class NodeDetector

java.lang.Object

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

fr.cnes.sirius.patrius.propagation.events.NodeDetector

All Implemented Interfaces:

EventDetector, Serializable

public class NodeDetector
extends AbstractDetector

Finder for node crossing events.

This class finds equator crossing events (i.e. ascending and/or descending node crossing).

The default implementation behavior is to stop propagation at node crossing. This can be changed by overriding one of the following constructors :

• NodeDetector : the defined action is performed at ascending OR/AND descending node depending on slope selection defined.
• NodeDetector : the defined actions are performed at ascending AND descending node.

Beware that node detection will fail for almost equatorial orbits.

Author:

Luc Maisonobe

See Also:

Propagator.addEventDetector(EventDetector), Serialized Form

Nested Class Summary

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	ASCENDING Flag for ascending node detection (slopeSelection = 0).
static int	ASCENDING_DESCENDING Flag for both ascending and descending node detection (slopeSelection = 2).
static int	DESCENDING Flag for descending node detection (slopeSelection = 1).

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

DEFAULT_MAXCHECK

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

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
NodeDetector(Frame frameIn, double maxCheck, double threshold, EventDetector.Action ascendingNode, EventDetector.Action descendingNode) Build a new instance for both ascending and descending node detection.
NodeDetector(Frame frameIn, double maxCheckIn, double threshold, EventDetector.Action ascendingNode, EventDetector.Action descendingNode, boolean removeAscendingNode, boolean removeDescendingNode) Build a new instance for both ascending and descending node detection.
NodeDetector(Frame frameIn, int slopeSelection, double maxCheck, double threshold) Build a new instance.
NodeDetector(Frame frameIn, int slopeSelection, double maxCheck, double threshold, EventDetector.Action action) Build a new instance.
NodeDetector(Frame frameIn, int slopeSelection, double maxCheck, double threshold, EventDetector.Action action, boolean removeCrossingNode) Build a new instance.
NodeDetector(Orbit orbit, Frame frameIn, int slopeSelection) Build a new instance.
NodeDetector(Orbit orbit, Frame frameIn, int slopeSelection, double threshold) Build a new instance.

Method Summary

Modifier and Type	Method and Description
EventDetector	copy() A copy of the detector.
EventDetector.Action	eventOccurred(SpacecraftState s, boolean increasing, boolean forward) Handle a node crossing event and choose what to do next.
double	g(SpacecraftState s) Compute the value of the switching function.
EventDetector.Action	getActionAtAscending() Returns action at ascending node detection.
EventDetector.Action	getActionAtDescending() Returns action at descending node detection.
Frame	getFrame() Get the frame in which the equator is defined.
boolean	removeAtAscending() Returns true if detection is remove after ascending node detection.
boolean	removeAtDescending() Returns true if detection is remove after descending node detection.
boolean	shouldBeRemoved() This method is called after EventDetector.eventOccurred(fr.cnes.sirius.patrius.propagation.SpacecraftState, boolean, boolean) has been triggered.

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

getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init, resetState

Methods inherited from class java.lang.Object

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

Field Detail

ASCENDING

public static final int ASCENDING

Flag for ascending node detection (slopeSelection = 0).

See Also:

Constant Field Values

DESCENDING

public static final int DESCENDING

Flag for descending node detection (slopeSelection = 1).

See Also:

Constant Field Values

ASCENDING_DESCENDING

public static final int ASCENDING_DESCENDING

Flag for both ascending and descending node detection (slopeSelection = 2).

See Also:

Constant Field Values

Constructor Detail

NodeDetector

public NodeDetector(Orbit orbit,
                    Frame frameIn,
                    int slopeSelection)

Build a new instance.

The orbit is used only to set an upper bound for the max check interval to period/3 and to set the convergence threshold according to orbit size.

The default implementation behavior is to stop propagation at node crossing.

Parameters:

orbit - initial orbit

frameIn - frame in which the equator is defined (typical values are J2000 or ITRF 2005)

slopeSelection -
ASCENDING for ascending node detection,
DESCENDING for descending node detection,
ASCENDING_DESCENDING for both ascending and descending node detection.

NodeDetector

public NodeDetector(Orbit orbit,
                    Frame frameIn,
                    int slopeSelection,
                    double threshold)

Build a new instance.

The orbit is used only to set an upper bound for the max check interval to period/3.

The default implementation behavior is to stop propagation at node crossing.

Parameters:

orbit - initial orbit

frameIn - frame in which the equator is defined (typical values are J2000 or ITRF 2005)

slopeSelection -
ASCENDING for ascending node detection,
DESCENDING for descending node detection,
ASCENDING_DESCENDING for both ascending and descending node detection.

threshold - convergence threshold (s)

NodeDetector

public NodeDetector(Frame frameIn,
                    int slopeSelection,
                    double maxCheck,
                    double threshold)

Build a new instance.

The default implementation behavior is to stop propagation at node crossing.

Parameters:

frameIn - frame in which the equator is defined (typical values are J2000 or ITRF 2005)

slopeSelection -
ASCENDING for ascending node detection,
DESCENDING for descending node detection,
ASCENDING_DESCENDING for both ascending and descending node detection.

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

NodeDetector

public NodeDetector(Frame frameIn,
                    double maxCheck,
                    double threshold,
                    EventDetector.Action ascendingNode,
                    EventDetector.Action descendingNode)

Build a new instance for both ascending and descending node detection.

Parameters:

frameIn - frame in which the equator is defined (typical values are J2000 or ITRF 2005)

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

ascendingNode - action performed at ascending node crossing

descendingNode - action performed at descending node crossing

NodeDetector

public NodeDetector(Frame frameIn,
                    double maxCheckIn,
                    double threshold,
                    EventDetector.Action ascendingNode,
                    EventDetector.Action descendingNode,
                    boolean removeAscendingNode,
                    boolean removeDescendingNode)

Build a new instance for both ascending and descending node detection.

Parameters:

frameIn - frame in which the equator is defined (typical values are J2000 or ITRF 2005)

maxCheckIn - maximal checking interval (s)

threshold - convergence threshold (s)

ascendingNode - action performed at ascending node crossing

descendingNode - action performed at descending node crossing

removeAscendingNode - true if detector should be removed at ascending node crossing

removeDescendingNode - true if detector should be removed at descending node crossing

Since:

3.1

NodeDetector

public NodeDetector(Frame frameIn,
                    int slopeSelection,
                    double maxCheck,
                    double threshold,
                    EventDetector.Action action)

Build a new instance.

Parameters:

frameIn - frame in which the equator is defined (typical values are J2000 or ITRF 2005)

slopeSelection -
ASCENDING for ascending node detection,
DESCENDING for descending node detection,
ASCENDING_DESCENDING for both ascending and descending node detection.

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

action - action to be performed at node crossing

NodeDetector

public NodeDetector(Frame frameIn,
                    int slopeSelection,
                    double maxCheck,
                    double threshold,
                    EventDetector.Action action,
                    boolean removeCrossingNode)

Build a new instance.

Parameters:

frameIn - frame in which the equator is defined (typical values are J2000 or ITRF 2005)

slopeSelection -
ASCENDING for ascending node detection,
DESCENDING for descending node detection,
ASCENDING_DESCENDING for both ascending and descending node detection.

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

action - action to be performed at node crossing

removeCrossingNode - true if detector should be removed at node crossing

Since:

3.1

Method Detail

getFrame

public Frame getFrame()

Get the frame in which the equator is defined.

Returns:

the frame in which the equator is defined

getActionAtAscending

public EventDetector.Action getActionAtAscending()

Returns action at ascending node detection.

Returns:

action at ascending node detection

getActionAtDescending

public EventDetector.Action getActionAtDescending()

Returns action at descending node detection.

Returns:

action at descending node detection

removeAtAscending

public boolean removeAtAscending()

Returns true if detection is remove after ascending node detection.

Returns:

true if detection is remove after ascending node detection

removeAtDescending

public boolean removeAtDescending()

Returns true if detection is remove after descending node detection.

Returns:

true if detection is remove after descending node detection

eventOccurred

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

Handle a node crossing event and choose what to do next.

The default implementation behavior is to stop propagation at node crossing.

Specified by:

eventOccurred in interface EventDetector

Specified by:

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 ascending or/and descending node is reached.

Throws:

PatriusException - if some specific error occurs

shouldBeRemoved

public boolean shouldBeRemoved()

This method is called after EventDetector.eventOccurred(fr.cnes.sirius.patrius.propagation.SpacecraftState, boolean, boolean) has been triggered. It returns true if the current detector should be removed after first event detection. WARNING: this method can be called only once a event has been triggered. Before, the value is not available.

Specified by:

shouldBeRemoved in interface EventDetector

Specified by:

shouldBeRemoved in class AbstractDetector

Returns:

true if the current detector should be removed after first event detection

g

public double g(SpacecraftState s)
         throws PatriusException

Compute the value of the switching function. This function computes the Z position in the defined frame.

Specified by:

g in interface EventDetector

Specified by:

g in class AbstractDetector

Parameters:

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

Returns:

value of the switching function

Throws:

PatriusException - if some specific error occurs

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:

• frame: Frame

Returns:

a copy of the detector.