fr.cnes.sirius.patrius.events.detectors

Class NadirSolarIncidenceDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

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

fr.cnes.sirius.patrius.events.detectors.NadirSolarIncidenceDetector

All Implemented Interfaces:

EventDetector, Serializable

public class NadirSolarIncidenceDetector
extends AbstractSignalPropagationDetector

Spacecraft's nadir point solar incidence detector.

The solar incidence is the angle between the nadir-satellite vector and the nadir-sun vector.
This detector discriminates among increasing g events and decreasing g events.
The default implementation is to stop propagation when the reference solar incidence is reached. This can be changed by using provided constructors.

This detector can take into account signal propagation duration through AbstractSignalPropagationDetector.setPropagationDelayType(PropagationDelayType, Frame) (default is signal being instantaneous).

Since:

1.1

Version:

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

Author:

Thomas Trapier

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 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
NadirSolarIncidenceDetector(double incidence, BodyShape bodyShape, double maxCheck, double threshold) Constructor for the nadir point solar incidence detector.
NadirSolarIncidenceDetector(double incidence, BodyShape bodyShape, double maxCheck, double threshold, EventDetector.Action action) Constructor for the nadir point solar incidence detector.
NadirSolarIncidenceDetector(double incidence, BodyShape bodyShape, double maxCheck, double threshold, EventDetector.Action action, boolean remove) Constructor for the nadir point solar incidence detector.
NadirSolarIncidenceDetector(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.
NadirSolarIncidenceDetector(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	copy() A copy of the detector.
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.
PVCoordinatesProvider	getSun() Getter for the Sun.
void	init(SpacecraftState s0, AbsoluteDate t) Initialize event handler at the start of a propagation.
void	setSun(PVCoordinatesProvider sun) Setter for the sun PVCoordinatesProvider

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, 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

NadirSolarIncidenceDetector

public NadirSolarIncidenceDetector(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

NadirSolarIncidenceDetector

public NadirSolarIncidenceDetector(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

NadirSolarIncidenceDetector

public NadirSolarIncidenceDetector(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

Since:

3.1

NadirSolarIncidenceDetector

public NadirSolarIncidenceDetector(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 - Sun

Since:

4.5

NadirSolarIncidenceDetector

public NadirSolarIncidenceDetector(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 - Sun

Since:

4.11.1

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

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

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

setSun

public void setSun(PVCoordinatesProvider sun)

Setter for the sun PVCoordinatesProvider

Parameters:

sun - the sun

getSun

public PVCoordinatesProvider getSun()

Getter for the Sun.

Returns:

the Sun

getBodyShape

public BodyShape getBodyShape()

Getter for the body shape.

Returns:

the body shape

getIncidence

public double getIncidence()

Getter for the incidence.

Returns:

incidence to detect

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:

• inbodyShape: PVCoordinatesProvider

Returns:

a copy of the detector.