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 body attraction force model.- Author:
- Romain Serra
-
-
Field Summary
Fields Modifier and Type Field Description static 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(CelestialBody body)
Simple constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
dependsOnPositionOnly()
Check if force model depends on position only at a given, fixed date.protected CelestialBody
getBody()
Protected getter for the body.String
getBodyName()
Getter for the body's name.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
getEventDetectors, getFieldEventDetectors
-
Methods inherited from interface org.orekit.forces.ForceModel
acceleration, acceleration, addContribution, addContribution, dependsOnAttitudeRate, getEventDetectors, getFieldEventDetectors, init, init
-
Methods inherited from interface org.orekit.utils.ParameterDriversProvider
getNbParametersDriversValue, getParameterDriver, getParameters, getParameters, getParameters, getParameters, getParametersAllValues, getParametersAllValues, isSupported
-
-
-
-
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
-
AbstractBodyAttraction
protected AbstractBodyAttraction(CelestialBody body)
Simple constructor.- Parameters:
body
- the third body to consider
-
-
Method Detail
-
getBodyName
public String getBodyName()
Getter for the body's name.- Returns:
- the body's name
-
getBody
protected CelestialBody getBody()
Protected getter for the body.- Returns:
- the third body considered
-
dependsOnPositionOnly
public boolean dependsOnPositionOnly()
Check if force model depends on position only at a given, fixed date.- Specified by:
dependsOnPositionOnly
in interfaceForceModel
- Returns:
- true if force model depends on position only, false if it depends on velocity, either directly or due to a dependency on attitude
-
getParametersDrivers
public List<ParameterDriver> getParametersDrivers()
Get the drivers for parameters.- Specified by:
getParametersDrivers
in interfaceParameterDriversProvider
- Returns:
- drivers for parameters
-
-