fr.cnes.sirius.patrius.events.detectors

Class AbstractSolarIncidenceDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

fr.cnes.sirius.patrius.events.detectors.AbstractSignalPropagationDetector

fr.cnes.sirius.patrius.events.detectors.AbstractSolarIncidenceDetector

All Implemented Interfaces:

EventDetector, Serializable

Direct Known Subclasses:

BodyPointSolarIncidenceDetector, NadirSolarIncidenceDetector

public abstract class AbstractSolarIncidenceDetector
extends AbstractSignalPropagationDetector

Common parts shared by solar incidence detectors.

Since:

4.17

Author:

bonitt

See Also:

EventDetector, Serialized Form

Concurrency :

thread-hostile

Concurrency comment :

the celestial body is thread hostile itself

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.sirius.patrius.events.detectors.AbstractSignalPropagationDetector

AbstractSignalPropagationDetector.EventDatationType, AbstractSignalPropagationDetector.PropagationDelayType

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

EventDetector.Action

Field Summary

Fields

Modifier and Type	Field and Description
protected BodyShape	bodyShape The body shape.
protected double	incidenceRef The incidence to detect.
protected PVCoordinatesProvider	sun The sun.

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

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

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

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
AbstractSolarIncidenceDetector(double incidence, BodyShape bodyShape, double maxCheck, double threshold) Constructor for the nadir point solar incidence detector.
AbstractSolarIncidenceDetector(double incidence, BodyShape bodyShape, double maxCheck, double threshold, EventDetector.Action action) Constructor for the nadir point solar incidence detector.
AbstractSolarIncidenceDetector(double incidence, BodyShape bodyShape, double maxCheck, double threshold, EventDetector.Action action, boolean remove) Constructor for the nadir point solar incidence detector.
AbstractSolarIncidenceDetector(double incidence, BodyShape bodyShape, double maxCheck, double threshold, EventDetector.Action action, boolean remove, PVCoordinatesProvider sun) Constructor for the nadir point solar incidence detector with Sun choice.
AbstractSolarIncidenceDetector(int slopeSelectionIn, double incidence, BodyShape bodyShape, double maxCheck, double threshold, EventDetector.Action actionAtIncreasing, EventDetector.Action actionAtDecreasing, boolean removeAtIncreasing, boolean removeAtDecreasing, PVCoordinatesProvider sun) Constructor for the nadir point solar incidence detector with Sun choice.

Method Summary

Modifier and Type	Method and Description
EventDetector.Action	eventOccurred(SpacecraftState s, boolean increasing, boolean forward) Handle a solar incidence event and choose what to do next.
double	g(SpacecraftState state) Compute the value of the switching function.
BodyShape	getBodyShape() Getter for the body shape.
double	getIncidence() Getter for the incidence to detect.
abstract BodyPoint	getInterestPoint(SpacecraftState state) Define the interest point.
PVCoordinatesProvider	getSun() Getter for the sun.

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

getEmitter, getEpsilonSignalPropagation, getEventDatationType, getInertialFrame, getLinkTypeHandler, getMaxIterSignalPropagation, getOtherDate, getPropagationDelayType, getReceiver, getSignalEmissionDate, getSignalEmissionDate, getSignalReceptionDate, getSignalReceptionDate, setEpsilonSignalPropagation, setMaxIterSignalPropagation, setPropagationDelayType

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

Methods inherited from interface fr.cnes.sirius.patrius.events.EventDetector

copy

Field Detail

incidenceRef

protected final double incidenceRef

The incidence to detect.

bodyShape

protected final BodyShape bodyShape

The body shape.

sun

protected final PVCoordinatesProvider sun

The sun.

Constructor Detail

AbstractSolarIncidenceDetector

public AbstractSolarIncidenceDetector(double incidence,
                                      BodyShape bodyShape,
                                      double maxCheck,
                                      double threshold)
                               throws PatriusException

Constructor for the nadir point solar incidence detector.

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

Parameters:

incidence - The incidence to detect (set 0. to detect the terminator)

bodyShape - The body shape

maxCheck - Maximum check (see AbstractDetector)

threshold - Threshold (see AbstractDetector)

Throws:

PatriusException - if there is an error when loading the ephemeris files

AbstractSolarIncidenceDetector

public AbstractSolarIncidenceDetector(double incidence,
                                      BodyShape bodyShape,
                                      double maxCheck,
                                      double threshold,
                                      EventDetector.Action action)
                               throws PatriusException

Constructor for the nadir point solar incidence detector.

Parameters:

incidence - The incidence to detect (set 0. to detect the terminator)

bodyShape - The body shape

maxCheck - Maximum check (see AbstractDetector)

threshold - Threshold (see AbstractDetector)

action - Action performed at nadir point solar incidence detection

Throws:

PatriusException - if there is an error when loading the ephemeris files

AbstractSolarIncidenceDetector

public AbstractSolarIncidenceDetector(double incidence,
                                      BodyShape bodyShape,
                                      double maxCheck,
                                      double threshold,
                                      EventDetector.Action action,
                                      boolean remove)
                               throws PatriusException

Constructor for the nadir point solar incidence detector.

Parameters:

incidence - The incidence to detect (set 0. to detect the terminator)

bodyShape - The body shape

maxCheck - Maximum check (see AbstractDetector)

threshold - Threshold (see AbstractDetector)

action - Action performed at nadir point solar incidence detection

remove - True if detector should be removed at nadir point solar incidence detection

Throws:

PatriusException - if there is an error when loading the ephemeris files

AbstractSolarIncidenceDetector

public AbstractSolarIncidenceDetector(double incidence,
                                      BodyShape bodyShape,
                                      double maxCheck,
                                      double threshold,
                                      EventDetector.Action action,
                                      boolean remove,
                                      PVCoordinatesProvider sun)

Constructor for the nadir point solar incidence detector with Sun choice.

Parameters:

incidence - The incidence to detect (set 0. to detect the terminator)

bodyShape - The body shape

maxCheck - Maximum check (see AbstractDetector)

threshold - Threshold (see AbstractDetector)

action - Action performed at nadir point solar incidence detection

remove - True if detector should be removed at nadir point solar incidence detection

sun - The sun

AbstractSolarIncidenceDetector

public AbstractSolarIncidenceDetector(int slopeSelectionIn,
                                      double incidence,
                                      BodyShape bodyShape,
                                      double maxCheck,
                                      double threshold,
                                      EventDetector.Action actionAtIncreasing,
                                      EventDetector.Action actionAtDecreasing,
                                      boolean removeAtIncreasing,
                                      boolean removeAtDecreasing,
                                      PVCoordinatesProvider sun)

Constructor for the nadir point solar incidence detector with Sun choice.

Parameters:

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

incidence - The incidence to detect (set 0. to detect the terminator)

bodyShape - The body shape

maxCheck - Maximum check (see AbstractDetector)

threshold - Threshold (see AbstractDetector)

actionAtIncreasing - Action performed at nadir point solar incidence detection at increasing g event

actionAtDecreasing - Action performed at nadir point solar incidence detection at decreasing g event

removeAtIncreasing - True if detector should be removed at nadir point solar incidence detection at increasing g event

removeAtDecreasing - True if detector should be removed at nadir point solar incidence detection at decreasing g event

sun - The sun

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

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

getInterestPoint

public abstract BodyPoint getInterestPoint(SpacecraftState state)
                                    throws PatriusException

Define the interest point.

Parameters:

state - the current state information

Returns:

the interest point

Throws:

PatriusException - if some specific error occurs

eventOccurred

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

Handle a solar incidence event and choose what to do next.

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 time increases around event

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

Returns:

the action performed when the expected nadir point solar incidence is detected

Throws:

PatriusException - if some specific error occurs

getIncidence

public double getIncidence()

Getter for the incidence to detect.

Returns:

the incidence to detect

getBodyShape

public BodyShape getBodyShape()

Getter for the body shape.

Returns:

the body shape

getSun

public PVCoordinatesProvider getSun()

Getter for the sun.

Returns:

the sun