Package org.orekit.forces.empirical

Class AbstractParametricAcceleration

java.lang.Object

org.orekit.forces.empirical.AbstractParametricAcceleration

All Implemented Interfaces:

ForceModel, EventDetectorsProvider, ParameterDriversProvider

Direct Known Subclasses:

ParametricAcceleration, TimeSpanParametricAcceleration

public abstract class AbstractParametricAcceleration
extends Object
implements ForceModel

Abstract class for parametric acceleration.

Since:

13.0

Author:

Romain Serra

Field Summary

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

DATATION_ACCURACY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractParametricAcceleration(Vector3D direction, boolean isInertial, AttitudeProvider attitudeOverride)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	dependsOnPositionOnly()	Check if force model depends on position only at a given, fixed date.
protected <T extends CalculusFieldElement<T>> FieldVector3D<T>	getAccelerationDirection(FieldSpacecraftState<T> state)	Computes the acceleration's direction in the propagation frame.
protected Vector3D	getAccelerationDirection(SpacecraftState state)	Computes the acceleration's direction in the propagation frame.
AttitudeProvider	getAttitudeOverride()	Getter for attitude override.
Stream<EventDetector>	getEventDetectors()	Get the discrete events related to the model.
<T extends CalculusFieldElement<T>> Stream<FieldEventDetector<T>>	getFieldEventDetectors(Field<T> field)	Get the discrete events related to the model.

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.EventDetectorsProvider

getDateDetector, getEventDetectors, getFieldDateDetector, getFieldEventDetectors

Methods inherited from interface org.orekit.forces.ForceModel

acceleration, acceleration, addContribution, addContribution, dependsOnAttitudeRate, getMassDerivative, getMassDerivative, getParametersDrivers, init, init

Methods inherited from interface org.orekit.utils.drivers.ParameterDriversProvider

getParameterDriver, getParameterDriverWithSubstring, getParameters, getParameters, isSupported

Constructor Details

AbstractParametricAcceleration

protected AbstractParametricAcceleration(Vector3D direction,
 boolean isInertial,
 AttitudeProvider attitudeOverride)

Constructor.

Parameters:

direction - direction of the acceleration

isInertial - flag defining if the acceleration direction is already defined in inertial frame (true)

attitudeOverride - override for the attitude provider.

Method Details

getAttitudeOverride

public AttitudeProvider getAttitudeOverride()

Getter for attitude override.

Returns:

attitude override

dependsOnPositionOnly

public boolean dependsOnPositionOnly()

Check if force model depends on position only at a given, fixed date.

Specified by:

dependsOnPositionOnly in interface ForceModel

Returns:

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

getAccelerationDirection

protected Vector3D getAccelerationDirection(SpacecraftState state)

Computes the acceleration's direction in the propagation frame.

Parameters:

state - state

Returns:

direction

getAccelerationDirection

protected <T extends CalculusFieldElement<T>>
FieldVector3D<T> getAccelerationDirection(FieldSpacecraftState<T> state)

Computes the acceleration's direction in the propagation frame.

Type Parameters:

T - field type

Parameters:

state - state

Returns:

direction

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 EventDetectorsProvider

Specified by:

getEventDetectors in interface ForceModel

Returns:

stream of event detectors

getFieldEventDetectors

public <T extends CalculusFieldElement<T>>
Stream<FieldEventDetector<T>> getFieldEventDetectors(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 EventDetectorsProvider

Specified by:

getFieldEventDetectors in interface ForceModel

Type Parameters:

T - extends CalculusFieldElement<T>

Parameters:

field - field to which the state belongs

Returns:

stream of event detectors