Package org.orekit.propagation.events.functions

Class UmbraEventFunction

java.lang.Object

org.orekit.propagation.events.functions.UmbraEventFunction

All Implemented Interfaces:

EventFunction

public class UmbraEventFunction
extends Object
implements EventFunction

Class for umbra event with conical shadows from ellipsoidal occulting bodies. It is negative in umbra, positive otherwise.

Since:

14.0

Author:

Romain Serra

See Also:

OccultationEngine

Constructor Summary

Constructors

Constructor	Description
UmbraEventFunction(OccultationEngine occultationEngine)	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 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

UmbraEventFunction

public UmbraEventFunction(OccultationEngine occultationEngine)

Constructor.

Parameters:

occultationEngine - occultation engine

Method Detail

value

public double value(SpacecraftState state)

Description copied from interface: EventFunction

Evaluate function.

Specified by:

value in interface EventFunction

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.

Specified by:

value in interface EventFunction

Type Parameters:

T - field type

Parameters:

fieldState - spacecraft state

Returns:

value