fr.cnes.sirius.patrius.events.detectors

Class SurfaceDistanceDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

fr.cnes.sirius.patrius.events.detectors.DistanceDetector

fr.cnes.sirius.patrius.events.detectors.SurfaceDistanceDetector

All Implemented Interfaces:

EventDetector, Serializable

public class SurfaceDistanceDetector
extends DistanceDetector

Detects when the distance from the spacecraft to the surface of a given body reaches a predetermined value.

The default implementation behaviour is to stop propagation when the distance is reached. This can be changed by using provided constructors.

Since:

4.11

Author:

Florian Teilhard

See Also:

DistanceDetector}, 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	SurfaceDistanceDetector.BodyDistanceType Body distance type.

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

EventDetector.Action

Field Summary

Fields inherited from class fr.cnes.sirius.patrius.events.detectors.DistanceDetector

body, DECREASING, distance, INCREASING, INCREASING_DECREASING

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

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

Constructor Summary

Constructors

Constructor and Description
SurfaceDistanceDetector(CelestialBody bodyIn, double surfaceDistanceIn, SurfaceDistanceDetector.BodyDistanceType bodyDistanceTypeIn) Constructor for a DistanceDetector instance.
SurfaceDistanceDetector(CelestialBody bodyIn, double surfaceDistanceIn, SurfaceDistanceDetector.BodyDistanceType bodyDistanceTypeIn, double maxCheck, double threshold) Constructor for a DistanceDetector instance with additional maxCheck and threshold parameters
SurfaceDistanceDetector(CelestialBody bodyIn, double surfaceDistanceIn, SurfaceDistanceDetector.BodyDistanceType bodyDistanceTypeIn, double maxCheck, double threshold, EventDetector.Action actionIncreasing, EventDetector.Action actionDecreasing) Constructor for a DistanceDetector instance with complementary parameters.
SurfaceDistanceDetector(CelestialBody bodyIn, double surfaceDistanceIn, SurfaceDistanceDetector.BodyDistanceType bodyDistanceTypeIn, double maxCheck, double threshold, EventDetector.Action actionIncreasing, EventDetector.Action actionDecreasing, boolean removeIncreasing, boolean removeDecreasing) Constructor for a DistanceDetector instance with complementary parameters.
SurfaceDistanceDetector(CelestialBody bodyIn, double surfaceDistanceIn, SurfaceDistanceDetector.BodyDistanceType bodyDistanceTypeIn, int slopeSelection, double maxCheck, double threshold, EventDetector.Action action, boolean remove) Build a new altitude detector with slope selection.

Method Summary

Modifier and Type	Method and Description
EventDetector	copy() A copy of the detector.
double	g(SpacecraftState state) Compute the value of the switching function.
CelestialBody	getBody() Getter for the body.
SurfaceDistanceDetector.BodyDistanceType	getBodyDistanceType() Getter for the chosen body distance type for the detector.
Frame	getBodyFixedFrame() Getter for the body fixed frame.
BodyShape	getBodyShape() Getter for the body shape.

Methods inherited from class fr.cnes.sirius.patrius.events.detectors.DistanceDetector

eventOccurred, getDistance

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

filterEvent, getActionAtEntry, getActionAtExit, getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init, isRemoveAtEntry, isRemoveAtExit, logEventsOverTimeInterval, resetState, setMaxCheckInterval, setMaxIter, shouldBeRemoved

Methods inherited from class java.lang.Object

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

Constructor Detail

SurfaceDistanceDetector

public SurfaceDistanceDetector(CelestialBody bodyIn,
                               double surfaceDistanceIn,
                               SurfaceDistanceDetector.BodyDistanceType bodyDistanceTypeIn)

Constructor for a DistanceDetector instance.

This simple constructor takes default values for maximal checking interval (AbstractDetector.DEFAULT_MAXCHECK) and convergence threshold (AbstractDetector.DEFAULT_THRESHOLD).

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

The surfaceDistanceIn parameter must be positive.

Parameters:

bodyIn - The body whose distance is watched

surfaceDistanceIn - Distance triggering the event (m)

bodyDistanceTypeIn - Body distance type

Throws:

IllegalArgumentException - if the distance is negative

SurfaceDistanceDetector

public SurfaceDistanceDetector(CelestialBody bodyIn,
                               double surfaceDistanceIn,
                               SurfaceDistanceDetector.BodyDistanceType bodyDistanceTypeIn,
                               double maxCheck,
                               double threshold)

Constructor for a DistanceDetector instance with additional maxCheck and threshold parameters

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

Parameters:

bodyIn - The body whose distance is watched

surfaceDistanceIn - Distance triggering the event (m)

bodyDistanceTypeIn - Body distance type

maxCheck - Maximal checking interval (s)

threshold - Convergence threshold (s)

Throws:

IllegalArgumentException - if the distance is negative

SurfaceDistanceDetector

public SurfaceDistanceDetector(CelestialBody bodyIn,
                               double surfaceDistanceIn,
                               SurfaceDistanceDetector.BodyDistanceType bodyDistanceTypeIn,
                               double maxCheck,
                               double threshold,
                               EventDetector.Action actionIncreasing,
                               EventDetector.Action actionDecreasing)

Constructor for a DistanceDetector instance with complementary parameters.

Parameters:

bodyIn - The body whose distance is watched

surfaceDistanceIn - Distance triggering the event (m)

bodyDistanceTypeIn - Body distance type

maxCheck - Maximal checking interval (s)

threshold - Convergence threshold (s)

actionIncreasing - Action performed at distance detection when distance is increasing

actionDecreasing - Action performed at distance detection when distance is decreasing

Throws:

IllegalArgumentException - if the distance is negative

SurfaceDistanceDetector

public SurfaceDistanceDetector(CelestialBody bodyIn,
                               double surfaceDistanceIn,
                               SurfaceDistanceDetector.BodyDistanceType bodyDistanceTypeIn,
                               double maxCheck,
                               double threshold,
                               EventDetector.Action actionIncreasing,
                               EventDetector.Action actionDecreasing,
                               boolean removeIncreasing,
                               boolean removeDecreasing)

Constructor for a DistanceDetector instance with complementary parameters.

Parameters:

bodyIn - The body whose distance is watched

surfaceDistanceIn - Distance triggering the event (m)

bodyDistanceTypeIn - Body distance type

maxCheck - Maximal checking interval (s)

threshold - Convergence threshold (s)

actionIncreasing - Action performed at distance detection when distance is increasing

actionDecreasing - Action performed at distance detection when distance is decreasing

removeIncreasing - True if detector should be removed at increasing distance detection

removeDecreasing - True if detector should be removed at decreasing distance detection

Throws:

IllegalArgumentException - if the distance is negative

SurfaceDistanceDetector

public SurfaceDistanceDetector(CelestialBody bodyIn,
                               double surfaceDistanceIn,
                               SurfaceDistanceDetector.BodyDistanceType bodyDistanceTypeIn,
                               int slopeSelection,
                               double maxCheck,
                               double threshold,
                               EventDetector.Action action,
                               boolean remove)

Build a new altitude detector with slope selection.

The maximal interval between altitude checks should be smaller than the half duration of the minimal pass to handle, otherwise some short passes could be missed.

Parameters:

bodyIn - The body whose distance is watched

surfaceDistanceIn - Distance triggering the event (m)

bodyDistanceTypeIn - Body distance type

slopeSelection - The g-function slope selection (0,1 or 2)

maxCheck - Maximal checking interval (s)

threshold - Convergence threshold (s)

action - Action performed at distance detection

remove - True if detector should be removed at distance detection

Method Detail

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

Overrides:

g in class DistanceDetector

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

See Also:

(fr.cnes.sirius.patrius.propagation.SpacecraftState)

getBody

public CelestialBody getBody()

Getter for the body.

Overrides:

getBody in class DistanceDetector

Returns:

the body

getBodyDistanceType

public SurfaceDistanceDetector.BodyDistanceType getBodyDistanceType()

Getter for the chosen body distance type for the detector.

Returns:

the chosen body distance type for the detector

getBodyShape

public BodyShape getBodyShape()

Getter for the body shape.

Returns:

the body shape

getBodyFixedFrame

public Frame getBodyFixedFrame()

Getter for the body fixed frame.

Returns:

the body fixed frame

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:

• body: PVCoordinatesProvider

The following attributes are not deeply copied:

• body: CelestialBody

Specified by:

copy in interface EventDetector

Overrides:

copy in class DistanceDetector

Returns:

a copy of the detector.