Package org.orekit.forces.gravity

Class AbstractBodyAttraction

java.lang.Object

org.orekit.forces.gravity.AbstractBodyAttraction

All Implemented Interfaces:

ForceModel, EventDetectorsProvider, ParameterDriversProvider

Direct Known Subclasses:

SingleBodyAbsoluteAttraction, SingleBodyRelativeAttraction, ThirdBodyAttraction

public abstract class AbstractBodyAttraction
extends Object
implements ForceModel

Abstract class for non-central body attraction force model.

Author:

Romain Serra

Field Summary

Fields

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

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

DATATION_ACCURACY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBodyAttraction(ExtendedPositionProvider positionProvider, String name, double mu)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
boolean	dependsOnPositionOnly()	Check if force model depends on position only at a given, fixed date.
String	getBodyName()	Getter for the body's name.
protected Vector3D	getBodyPosition(AbsoluteDate date, Frame frame)	Get the body's position vector.
protected <T extends CalculusFieldElement<T>> FieldVector3D<T>	getBodyPosition(FieldAbsoluteDate<T> date, Frame frame)	Get the body's position vector.
protected TimeStampedPVCoordinates	getBodyPVCoordinates(AbsoluteDate date, Frame frame)	Get the body's position-velocity-acceleration vector.
protected <T extends CalculusFieldElement<T>> TimeStampedFieldPVCoordinates<T>	getBodyPVCoordinates(FieldAbsoluteDate<T> date, Frame frame)	Get the body's position-velocity-acceleration vector.
List<ParameterDriver>	getParametersDrivers()	Get the drivers for parameters.

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, getEventDetectors, getFieldEventDetectors, getMassDerivative, getMassDerivative, init, init

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

getParameterDriver, getParameterDriverWithSubstring, getParameters, getParameters, isSupported

Field Details

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 Details

AbstractBodyAttraction

protected AbstractBodyAttraction(ExtendedPositionProvider positionProvider,
 String name,
 double mu)

Simple constructor.

Parameters:

positionProvider - provider for the body to consider

name - body name

mu - body gravitational constant

Method Details

getBodyName

public String getBodyName()

Getter for the body's name.

Returns:

the body's name

getBodyPosition

protected Vector3D getBodyPosition(AbsoluteDate date,
 Frame frame)

Get the body's position vector.

Parameters:

date - date

frame - frame

Returns:

position

Since:

12.2

getBodyPosition

protected <T extends CalculusFieldElement<T>>
FieldVector3D<T> getBodyPosition(FieldAbsoluteDate<T> date,
 Frame frame)

Get the body's position vector.

Type Parameters:

T - field type

Parameters:

date - date

frame - frame

Returns:

position

Since:

12.2

getBodyPVCoordinates

protected TimeStampedPVCoordinates getBodyPVCoordinates(AbsoluteDate date,
 Frame frame)

Get the body's position-velocity-acceleration vector.

Parameters:

date - date

frame - frame

Returns:

PV

Since:

12.2

getBodyPVCoordinates

protected <T extends CalculusFieldElement<T>>
TimeStampedFieldPVCoordinates<T> getBodyPVCoordinates(FieldAbsoluteDate<T> date,
 Frame frame)

Get the body's position-velocity-acceleration vector.

Type Parameters:

T - field type

Parameters:

date - date

frame - frame

Returns:

PV

Since:

12.2

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.

getParametersDrivers

public List<ParameterDriver> getParametersDrivers()

Get the drivers for parameters. By default, no parameters. Override, for instance, to enable partial derivatives.

Specified by:

getParametersDrivers in interface ForceModel

Specified by:

getParametersDrivers in interface ParameterDriversProvider

Returns:

drivers for parameters