Package org.orekit.propagation.events.functions

Class AltitudeEventFunction

java.lang.Object

org.orekit.propagation.events.functions.AbstractGeodeticEventFunction

org.orekit.propagation.events.functions.AltitudeEventFunction

All Implemented Interfaces:

EventFunction

public class AltitudeEventFunction
extends AbstractGeodeticEventFunction

Class for geodetic altitude value-crossing event function. It is negative under the critical value.

Since:

14.0

Author:

Romain Serra

Constructor Summary

Constructors

Constructor	Description
AltitudeEventFunction(BodyShape body, double criticalAltitude)	Constructor.

Method Summary

Modifier and Type	Method	Description
<T extends CalculusFieldElement<T>> T	value(FieldSpacecraftState<T> fieldState)	Evaluate Field function.
double	value(SpacecraftState state)	Evaluate function.

Methods inherited from class org.orekit.propagation.events.functions.AbstractGeodeticEventFunction

getBodyShape, transformToGeodeticPoint, transformToGeodeticPoint

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.propagation.events.functions.EventFunction

dependsOnMainVariablesOnly, dependsOnTimeOnly

Constructor Detail

AltitudeEventFunction

public AltitudeEventFunction(BodyShape body,
                             double criticalAltitude)

Constructor.

Parameters:

body - body

criticalAltitude - altitude for crossing

Method Detail

value

public double value(SpacecraftState state)

Description copied from interface: EventFunction

Evaluate function.

Parameters:

state - spacecraft state

Returns:

value

value

public <T extends CalculusFieldElement<T>> T value(FieldSpacecraftState<T> fieldState)

Description copied from interface: EventFunction

Evaluate Field function. By default, calls the non-Field version. This is suitable for detection but not be for applications like automatic differentiation, where a proper implementation should be used instead.

Type Parameters:

T - field type

Parameters:

fieldState - spacecraft state

Returns:

value