org.orekit.forces.radiation

Class AbstractRadiationForceModel

java.lang.Object

org.orekit.forces.radiation.AbstractRadiationForceModel

All Implemented Interfaces:

ForceModel, EventDetectorsProvider, ParameterDriversProvider

Direct Known Subclasses:

ECOM2, SolarRadiationPressure

public abstract class AbstractRadiationForceModel
extends Object
implements ForceModel

Base class for radiation force models.

Since:

10.2

See Also:

SolarRadiationPressure, ECOM2

Field Summary

Fields inherited from interface org.orekit.propagation.events.EventDetectorsProvider

DATATION_ACCURACY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRadiationForceModel(ExtendedPVCoordinatesProvider sun, OneAxisEllipsoid centralBody) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addOccultingBody(ExtendedPVCoordinatesProvider provider, double radius) Add a new occulting body.
void	addOccultingBody(OneAxisEllipsoid occulting) Add a new occulting body.
boolean	dependsOnPositionOnly() Check if force models depends on position only.
Stream<EventDetector>	getEventDetectors() Get the discrete events related to the model.
<T extends org.hipparchus.CalculusFieldElement<T>> Stream<FieldEventDetector<T>>	getFieldEventDetectors(org.hipparchus.Field<T> field) Get the discrete events related to the model.
protected <T extends org.hipparchus.CalculusFieldElement<T>> T[]	getGeneralEclipseAngles(org.hipparchus.geometry.euclidean.threed.FieldVector3D<T> position, org.hipparchus.geometry.euclidean.threed.FieldVector3D<T> occultingPosition, T occultingRadius, org.hipparchus.geometry.euclidean.threed.FieldVector3D<T> occultedPosition, T occultedRadius) Get the useful angles for eclipse computation.
protected double[]	getGeneralEclipseAngles(org.hipparchus.geometry.euclidean.threed.Vector3D position, org.hipparchus.geometry.euclidean.threed.Vector3D occultingPosition, double occultingRadius, org.hipparchus.geometry.euclidean.threed.Vector3D occultedPosition, double occultedRadius) Get the useful angles for eclipse computation.
List<OccultationEngine>	getOccultingBodies() Get all occulting bodies to consider.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.forces.ForceModel

acceleration, acceleration, addContribution, addContribution, init, init

Methods inherited from interface org.orekit.utils.ParameterDriversProvider

getNbParametersDriversValue, getParameterDriver, getParameters, getParameters, getParameters, getParameters, getParametersAllValues, getParametersAllValues, getParametersDrivers, isSupported

Methods inherited from interface org.orekit.propagation.events.EventDetectorsProvider

getEventDetectors, getFieldEventDetectors

Constructor Detail

AbstractRadiationForceModel

protected AbstractRadiationForceModel(ExtendedPVCoordinatesProvider sun,
                                      OneAxisEllipsoid centralBody)

Default constructor. Only central body is considered.

Parameters:

sun - Sun model

centralBody - central body shape model (for umbra/penumbra computation)

Since:

12.0

Method Detail

dependsOnPositionOnly

public boolean dependsOnPositionOnly()

Check if force models depends on position only.

Specified by:

dependsOnPositionOnly in interface ForceModel

Returns:

true if force model depends on position only, false if it depends on velocity, either directly or due to a dependency on attitude

getEventDetectors

public Stream<EventDetector> getEventDetectors()

Get the discrete events related to the model.

This method is not intended to be called several time, only once by a propagator, as it has the side effect of rebuilding the events detectors when called.

Specified by:

getEventDetectors in interface ForceModel

Specified by:

getEventDetectors in interface EventDetectorsProvider

Returns:

stream of event detectors

getFieldEventDetectors

public <T extends org.hipparchus.CalculusFieldElement<T>> Stream<FieldEventDetector<T>> getFieldEventDetectors(org.hipparchus.Field<T> field)

Get the discrete events related to the model.

This method is not intended to be called several time, only once by a propagator, as it has the side effect of rebuilding the events detectors when called.

Specified by:

getFieldEventDetectors in interface ForceModel

Specified by:

getFieldEventDetectors in interface EventDetectorsProvider

Type Parameters:

T - extends CalculusFieldElement<T>

Parameters:

field - field to which the state belongs

Returns:

stream of event detectors

getGeneralEclipseAngles

protected double[] getGeneralEclipseAngles(org.hipparchus.geometry.euclidean.threed.Vector3D position,
                                           org.hipparchus.geometry.euclidean.threed.Vector3D occultingPosition,
                                           double occultingRadius,
                                           org.hipparchus.geometry.euclidean.threed.Vector3D occultedPosition,
                                           double occultedRadius)

Get the useful angles for eclipse computation.

Parameters:

position - the satellite's position in the selected frame

occultingPosition - Oculting body position in the selected frame

occultingRadius - Occulting body mean radius

occultedPosition - Occulted body position in the selected frame

occultedRadius - Occulted body mean radius

Returns:

the 3 angles {(satOcculting, satOcculted), Occulting body apparent radius, Occulted body apparent radius}

getGeneralEclipseAngles

protected <T extends org.hipparchus.CalculusFieldElement<T>> T[] getGeneralEclipseAngles(org.hipparchus.geometry.euclidean.threed.FieldVector3D<T> position,
                                                                                         org.hipparchus.geometry.euclidean.threed.FieldVector3D<T> occultingPosition,
                                                                                         T occultingRadius,
                                                                                         org.hipparchus.geometry.euclidean.threed.FieldVector3D<T> occultedPosition,
                                                                                         T occultedRadius)

Get the useful angles for eclipse computation.

Type Parameters:

T - extends RealFieldElement

Parameters:

occultingPosition - Oculting body position in the selected frame

occultingRadius - Occulting body mean radius

occultedPosition - Occulted body position in the selected frame

occultedRadius - Occulted body mean radius

position - the satellite's position in the selected frame

Returns:

the 3 angles {(satOcculting, satOcculted), Occulting body apparent radius, Occulted body apparent radius}

addOccultingBody

public void addOccultingBody(ExtendedPVCoordinatesProvider provider,
                             double radius)

Add a new occulting body.

Central body is already considered, it shall not be added this way.

Parameters:

provider - body PV provider

radius - body mean radius

See Also:

addOccultingBody(OneAxisEllipsoid)

addOccultingBody

public void addOccultingBody(OneAxisEllipsoid occulting)

Add a new occulting body.

Central body is already considered, it shall not be added this way.

Parameters:

occulting - occulting body to add

Since:

12.0

See Also:

addOccultingBody(ExtendedPVCoordinatesProvider, double)

getOccultingBodies

public List<OccultationEngine> getOccultingBodies()

Get all occulting bodies to consider.

The list always contains at least one element: the central body which is always the first one in the list.

Returns:

immutable list of all occulting bodies to consider, including the central body

Since:

12.0