Package org.orekit.forces.radiation

Interface LightFluxModel

All Known Implementing Classes:

AbstractLightFluxModel, AbstractSolarLightFluxModel, ConicallyShadowedLightFluxModel, CylindricallyShadowedLightFluxModel

public interface LightFluxModel

Interface describing flux models from a light source, including shadowing effects from occulting bodies. Defines the flux vector itself as well as detectors for entry and exit of the different eclipse zones, if any.

Since:

12.1

Author:

Romain Serra

Method Summary

Modifier and Type	Method	Description
List<EventDetector>	getEclipseConditionsDetector()	Retrieve detectors finding entries and exits in different eclipse zones.
<T extends CalculusFieldElement<T>> List<FieldEventDetector<T>>	getFieldEclipseConditionsDetector(Field<T> field)	Retrieve Field detectors finding entries and exits in different eclipse zones.
<T extends CalculusFieldElement<T>> FieldVector3D<T>	getLightFluxVector(FieldSpacecraftState<T> state)	Get the light flux vector in the state's frame.
Vector3D	getLightFluxVector(SpacecraftState state)	Get the light flux vector in the state's frame.
default <T extends CalculusFieldElement<T>> void	init(FieldSpacecraftState<T> initialState, FieldAbsoluteDate<T> targetDate)	Perform initialization steps before starting propagation.
default void	init(SpacecraftState initialState, AbsoluteDate targetDate)	Perform initialization steps before starting propagation.

Method Detail

init

default void init(SpacecraftState initialState,
                  AbsoluteDate targetDate)

Perform initialization steps before starting propagation.

Parameters:

initialState - initial state

targetDate - target date for propagation

Since:

12.2

init

default <T extends CalculusFieldElement<T>> void init(FieldSpacecraftState<T> initialState,
                                                      FieldAbsoluteDate<T> targetDate)

Perform initialization steps before starting propagation.

Type Parameters:

T - field type

Parameters:

initialState - initial state

targetDate - target date for propagation

Since:

12.2

getLightFluxVector

Vector3D getLightFluxVector(SpacecraftState state)

Get the light flux vector in the state's frame.

Parameters:

state - state

Returns:

light flux

getLightFluxVector

<T extends CalculusFieldElement<T>> FieldVector3D<T> getLightFluxVector(FieldSpacecraftState<T> state)

Get the light flux vector in the state's frame. Field version.

Type Parameters:

T - field type

Parameters:

state - state

Returns:

light flux

getEclipseConditionsDetector

List<EventDetector> getEclipseConditionsDetector()

Retrieve detectors finding entries and exits in different eclipse zones.

Returns:

list of event detectors

getFieldEclipseConditionsDetector

<T extends CalculusFieldElement<T>> List<FieldEventDetector<T>> getFieldEclipseConditionsDetector(Field<T> field)

Retrieve Field detectors finding entries and exits in different eclipse zones.

Type Parameters:

T - field type

Parameters:

field - calculus field

Returns:

list of event detectors