org.orekit.forces.gravity

Class SingleBodyRelativeAttraction

java.lang.Object

org.orekit.forces.AbstractForceModel

org.orekit.forces.gravity.SingleBodyRelativeAttraction

All Implemented Interfaces:

ForceModel

public class SingleBodyRelativeAttraction
extends AbstractForceModel

Body attraction force model computed as relative acceleration towards frame center.

Author:

Luc Maisonabe, Julio Hernanz

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRACTION_COEFFICIENT_SUFFIX Suffix for parameter name for attraction coefficient enabling Jacobian processing.

Constructor Summary

Constructors

Constructor and Description
SingleBodyRelativeAttraction(CelestialBody body) Simple constructor.

Method Summary

Modifier and Type	Method and Description
<T extends RealFieldElement<T>> FieldVector3D<T>	acceleration(FieldSpacecraftState<T> s, T[] parameters) Compute acceleration.
Vector3D	acceleration(SpacecraftState s, double[] parameters) Compute acceleration.
boolean	dependsOnPositionOnly() Check if force models depends on position only.
Stream<EventDetector>	getEventsDetectors() Get the discrete events related to the model.
<T extends RealFieldElement<T>> Stream<FieldEventDetector<T>>	getFieldEventsDetectors(Field<T> field) Get the discrete events related to the model.
ParameterDriver[]	getParametersDrivers() Get the drivers for force model parameters.

Methods inherited from class org.orekit.forces.AbstractForceModel

complainIfNotSupported, getParameterDriver, isSupported

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

addContribution, addContribution, getParameters, getParameters, init

Field Detail

ATTRACTION_COEFFICIENT_SUFFIX

public static final String ATTRACTION_COEFFICIENT_SUFFIX

Suffix for parameter name for attraction coefficient enabling Jacobian processing.

See Also:

Constant Field Values

Constructor Detail

SingleBodyRelativeAttraction

public SingleBodyRelativeAttraction(CelestialBody body)

Simple constructor.

Parameters:

body - the body to consider (ex: CelestialBodyFactory.getSun() or CelestialBodyFactory.getMoon())

Method Detail

dependsOnPositionOnly

public boolean dependsOnPositionOnly()

Check if force models depends on position only.

Returns:

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

acceleration

public Vector3D acceleration(SpacecraftState s,
                             double[] parameters)

Compute acceleration.

Parameters:

s - current state information: date, kinematics, attitude

parameters - values of the force model parameters

Returns:

acceleration in same frame as state

acceleration

public <T extends RealFieldElement<T>> FieldVector3D<T> acceleration(FieldSpacecraftState<T> s,
                                                                     T[] parameters)

Compute acceleration.

Type Parameters:

T - type of the elements

Parameters:

s - current state information: date, kinematics, attitude

parameters - values of the force model parameters

Returns:

acceleration in same frame as state

getEventsDetectors

public Stream<EventDetector> getEventsDetectors()

Get the discrete events related to the model.

Returns:

stream of events detectors

getFieldEventsDetectors

public <T extends RealFieldElement<T>> Stream<FieldEventDetector<T>> getFieldEventsDetectors(Field<T> field)

Description copied from interface: ForceModel

Get the discrete events related to the model.

Type Parameters:

T - extends RealFieldElement<T>

Parameters:

field - field to which the state belongs

Returns:

stream of events detectors

getParametersDrivers

public ParameterDriver[] getParametersDrivers()

Get the drivers for force model parameters.

Returns:

drivers for force model parameters