fr.cnes.sirius.patrius.events.detectors

Class AngularMomentumExcessDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

fr.cnes.sirius.patrius.events.detectors.AngularMomentumExcessDetector

All Implemented Interfaces:

EventDetector, Serializable

public final class AngularMomentumExcessDetector
extends AbstractDetector

Detector triggered when the angular momentum reaches a maximal threshold

Since:

4.11

See Also:

Serialized Form

Nested Class Summary

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
AngularMomentumExcessDetector(double momentum, Frame inertial, int slopeSelectionIn) Constructor for an AngularMomentumExcessDetector instance.
AngularMomentumExcessDetector(double momentum, Frame inertial, int slopeSelectionIn, double maxCheck, double threshold) Constructor for an AngularMomentumExcessDetector instance with complementary parameters.
AngularMomentumExcessDetector(double momentum, Frame inertial, int slopeSelectionIn, double maxCheck, double threshold, EventDetector.Action ascending, EventDetector.Action descending) Constructor for an AngularMomentumExcessDetector instance with complementary parameters.

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 an angular momentum excess event and choose what to do next.
double	g(SpacecraftState s) Compute the value of the switching function.
void	setAttitudeRepresentedFrame(Frame frame) Define the frame represented by the attitude law
void	setInertia(RealMatrix inertia, Frame frame) Define the inertia matrix (from CoM and in vehicle axis)

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

AngularMomentumExcessDetector

public AngularMomentumExcessDetector(double momentum,
                                     Frame inertial,
                                     int slopeSelectionIn)

Constructor for an AngularMomentumExcessDetector instance.

Parameters:

momentum - angular momentum value triggering the event.

inertial - frame with respect to which the w is to be computed

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

See Also:

PositionAngle

AngularMomentumExcessDetector

public AngularMomentumExcessDetector(double momentum,
                                     Frame inertial,
                                     int slopeSelectionIn,
                                     double maxCheck,
                                     double threshold)

Constructor for an AngularMomentumExcessDetector instance with complementary parameters.

Parameters:

momentum - AOL value triggering the event.

inertial - equator with respect to which the AOL is to be computed

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

maxCheck - maximum check (see AbstractDetector)

threshold - threshold (see AbstractDetector)

AngularMomentumExcessDetector

public AngularMomentumExcessDetector(double momentum,
                                     Frame inertial,
                                     int slopeSelectionIn,
                                     double maxCheck,
                                     double threshold,
                                     EventDetector.Action ascending,
                                     EventDetector.Action descending)

Constructor for an AngularMomentumExcessDetector instance with complementary parameters.

Parameters:

momentum - momentum excess value triggering the event.

inertial - inertial frame wrt the angular velocity is computed

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

maxCheck - maximum check (see AbstractDetector)

threshold - threshold (see AbstractDetector)

ascending - action performed when ascending

descending - action performed when descending

Method Detail

setInertia

public final void setInertia(RealMatrix inertia,
                             Frame frame)

Define the inertia matrix (from CoM and in vehicle axis)

Parameters:

inertia - the inertia 3x3 matrix expressed in CoM

frame - Frame

setAttitudeRepresentedFrame

public final void setAttitudeRepresentedFrame(Frame frame)

Define the frame represented by the attitude law

Parameters:

frame - the attitude represented law

eventOccurred

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

Handle an angular momentum excess 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 times increases around event

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

Returns:

the action performed when angular momentum excess is reached.

Throws:

PatriusException - if some specific error occurs

g

public final double g(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 EventDetector

Specified by:

g in class AbstractDetector

Parameters:

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

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.

Returns:

a copy of the detector.