fr.cnes.sirius.patrius.bodies

Class AbstractCelestialBody

java.lang.Object

fr.cnes.sirius.patrius.bodies.AbstractCelestialBody

All Implemented Interfaces:

CelestialBody, PVCoordinatesProvider, Serializable

Direct Known Subclasses:

MeeusMoon, MeeusMoonStela, MeeusSun, UserCelestialBody

public abstract class AbstractCelestialBody
extends Object
implements CelestialBody

Abstract implementation of the CelestialBody interface.

This abstract implementation provides basic services that can be shared by most implementations of the CelestialBody interface. It holds the gravitational attraction coefficient and build the body-centered frames automatically using the definitions of pole and prime meridian specified by the IAU/IAG Working Group on Cartographic Coordinates and Rotational Elements of the Planets and Satellites (WGCCRE).

Author:

Luc Maisonobe

See Also:

IAUPole, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	EME2000_FRAME_NAME EME2000 frame name.
static String	ICRF_FRAME_NAME ICRF frame name.
static String	INERTIAL_FRAME_CONSTANT_MODEL Constant (equator) inertial, body-centered frame name.
static String	INERTIAL_FRAME_MEAN_MODEL Mean (equator) inertial, body-centered frame name.
static String	INERTIAL_FRAME_TRUE_MODEL True (equator) inertial, body-centered frame name.
static String	ROTATING_FRAME_CONSTANT_MODEL Constant rotating, body-centered frame name.
static String	ROTATING_FRAME_MEAN_MODEL Mean rotating, body-centered frame name.
static String	ROTATING_FRAME_TRUE_MODEL True rotating, body-centered frame name.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCelestialBody(CelestialBodyFrame icrf, String nameIn, GravityModel gravityModelIn, IAUPole iauPoleIn) Build an instance and the underlying frame.
protected	AbstractCelestialBody(String nameIn, double gmIn, IAUPole iauPoleIn, Frame parentFrame) Build an instance and the underlying frame.
protected	AbstractCelestialBody(String nameIn, GravityModel gravityModelIn, IAUPole iauPoleIn, Frame parentFrame) Build an instance and the underlying frame.

Method Summary

Modifier and Type	Method and Description
CelestialBodyFrame	getEME2000() Get an EME2000, body centered frame.
CelestialBodyEphemeris	getEphemeris() Get the ephemeris of the body.
double	getGM() Get the central attraction coefficient of the body.
GravityModel	getGravityModel() Get the gravitational attraction model of the body.
IAUPole	getIAUPole() Get the IAU pole and primer meridians orientation.
CelestialBodyFrame	getICRF() Get an ICRF, body centered frame.
CelestialBodyFrame	getInertialFrame(IAUPoleModelType iauPoleIn) Get an inertially oriented, body centered frame.
String	getName() Get the name of the body.
Frame	getNativeFrame(AbsoluteDate date, Frame frame) Get the native frame, i.e.
PVCoordinates	getPVCoordinates(AbsoluteDate date, Frame frame) Get the PVCoordinates of the body in the selected frame.
CelestialBodyFrame	getRotatingFrame(IAUPoleModelType iauPoleIn) Get a body oriented, body centered frame.
BodyShape	getShape() Get the geometric shape of the body.
void	setEphemeris(CelestialBodyEphemeris ephemerisIn) Set an ephemeris to the body.
void	setGM(double gmIn) Set a central attraction coefficient to the body.
void	setGravityModel(GravityModel modelIn) Set a gravitational attraction model to the body.
void	setIAUPole(IAUPole iauPoleIn) Set a IAU Pole to define the body frames.
void	setShape(BodyShape shapeIn) Set a geometric shape to the body.
String	toString() Returns a string representation of the body and its attributes.

Methods inherited from class java.lang.Object

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

Field Detail

ICRF_FRAME_NAME

public static final String ICRF_FRAME_NAME

ICRF frame name.

See Also:

Constant Field Values

EME2000_FRAME_NAME

public static final String EME2000_FRAME_NAME

EME2000 frame name.

See Also:

Constant Field Values

INERTIAL_FRAME_CONSTANT_MODEL

public static final String INERTIAL_FRAME_CONSTANT_MODEL

Constant (equator) inertial, body-centered frame name.

See Also:

Constant Field Values

INERTIAL_FRAME_MEAN_MODEL

public static final String INERTIAL_FRAME_MEAN_MODEL

Mean (equator) inertial, body-centered frame name.

See Also:

Constant Field Values

INERTIAL_FRAME_TRUE_MODEL

public static final String INERTIAL_FRAME_TRUE_MODEL

True (equator) inertial, body-centered frame name.

See Also:

Constant Field Values

ROTATING_FRAME_CONSTANT_MODEL

public static final String ROTATING_FRAME_CONSTANT_MODEL

Constant rotating, body-centered frame name.

See Also:

Constant Field Values

ROTATING_FRAME_MEAN_MODEL

public static final String ROTATING_FRAME_MEAN_MODEL

Mean rotating, body-centered frame name.

See Also:

Constant Field Values

ROTATING_FRAME_TRUE_MODEL

public static final String ROTATING_FRAME_TRUE_MODEL

True rotating, body-centered frame name.

See Also:

Constant Field Values

Constructor Detail

AbstractCelestialBody

protected AbstractCelestialBody(String nameIn,
                                GravityModel gravityModelIn,
                                IAUPole iauPoleIn,
                                Frame parentFrame)

Build an instance and the underlying frame.

Parameters:

nameIn - name of the body

gravityModelIn - gravitationalAttraction model

iauPoleIn - IAU pole implementation

parentFrame - parent frame (usually it should be the ICRF centered on the parent body)

AbstractCelestialBody

protected AbstractCelestialBody(String nameIn,
                                double gmIn,
                                IAUPole iauPoleIn,
                                Frame parentFrame)

Build an instance and the underlying frame.

Parameters:

nameIn - name of the body

gmIn - gravitational attraction coefficient (in m³/s²)

iauPoleIn - IAU pole implementation

parentFrame - parent frame (usually it should be the ICRF centered on the parent body)

AbstractCelestialBody

protected AbstractCelestialBody(CelestialBodyFrame icrf,
                                String nameIn,
                                GravityModel gravityModelIn,
                                IAUPole iauPoleIn)

Build an instance and the underlying frame.

Parameters:

icrf - ICRF frame

nameIn - name of the body

gravityModelIn - gravitational attraction model

iauPoleIn - IAU pole implementation

Method Detail

getName

public String getName()

Get the name of the body.

Specified by:

getName in interface CelestialBody

Returns:

name of the body

getICRF

public CelestialBodyFrame getICRF()

Get an ICRF, body centered frame.

The frame is always bound to the body center, and its axes have a fixed orientation with respect to other inertial frames.

Specified by:

getICRF in interface CelestialBody

Returns:

an inertially oriented, body centered frame

See Also:

#getRotatingFrame(IAUPoleModelType.TRUE)

getEME2000

public CelestialBodyFrame getEME2000()

Get an EME2000, body centered frame.

The frame is always bound to the body center, and its axes are colinear to Earth EME2000 frame.

Specified by:

getEME2000 in interface CelestialBody

Returns:

an EME2000, body centered frame

getInertialFrame

public CelestialBodyFrame getInertialFrame(IAUPoleModelType iauPoleIn)
                                    throws PatriusException

Get an inertially oriented, body centered frame.

Warning: Inertiality of such frame depends on its definition and on its use: if related IAUPole includes strong precession/nutation effect and temporal horizon of use is long, frame may not be considered inertial. As a rule of thumb, precession/nutation effects of Earth frames such as CIRF/MOD are considered small enough on a horizon of a day to consider them pseudo-inertial. Also frames based on IAUPoleModelType.CONSTANT will be more inertial than IAUPoleModelType.MEAN and than IAUPoleModelType.TRUE. Similarly, models including IAUPoleFunction.IAUTimeDependency.DAYS with high values will tend to be less inertial than models including IAUPoleFunction.IAUTimeDependency.CENTURIES with high values. Definition of sufficiently inertial precession/nutation effects remains on the user responsibility depending on the frame usage.

Specified by:

getInertialFrame in interface CelestialBody

Parameters:

iauPoleIn - the type of IAUPole used for the frame

Returns:

an inertially oriented, body centered frame

Throws:

PatriusException - if frame cannot be retrieved

getRotatingFrame

public CelestialBodyFrame getRotatingFrame(IAUPoleModelType iauPoleIn)
                                    throws PatriusException

Get a body oriented, body centered frame.

Specified by:

getRotatingFrame in interface CelestialBody

Parameters:

iauPoleIn - the type of IAUPole used for the frame

Returns:

a body oriented, body centered frame

Throws:

PatriusException - if frame cannot be retrieved

getGM

public double getGM()

Get the central attraction coefficient of the body.

Warning: attraction model should not be null (it is not null by default)/

Specified by:

getGM in interface CelestialBody

Returns:

central attraction coefficient of the body (m³/s²)

setGM

public void setGM(double gmIn)

Set a central attraction coefficient to the body.

Specified by:

setGM in interface CelestialBody

Parameters:

gmIn - the central attraction coefficient (m³/s²)

getIAUPole

public IAUPole getIAUPole()

Get the IAU pole and primer meridians orientation.

Specified by:

getIAUPole in interface CelestialBody

Returns:

the IAU Pole

setIAUPole

public void setIAUPole(IAUPole iauPoleIn)

Set a IAU Pole to define the body frames.

Specified by:

setIAUPole in interface CelestialBody

Parameters:

iauPoleIn - the IAU pole

getPVCoordinates

public PVCoordinates getPVCoordinates(AbsoluteDate date,
                                      Frame frame)
                               throws PatriusException

Get the PVCoordinates of the body in the selected frame.

Specified by:

getPVCoordinates in interface PVCoordinatesProvider

Parameters:

date - current date

frame - the frame where to define the position

Returns:

position/velocity of the body (m and m/s)

Throws:

PatriusException - if position cannot be computed in given frame

getNativeFrame

public Frame getNativeFrame(AbsoluteDate date,
                            Frame frame)
                     throws PatriusException

Get the native frame, i.e. the raw frame in which PVCoordinates are expressed before transformation to user output frame. This native frame can be dependent on date and frame.

Specified by:

getNativeFrame in interface PVCoordinatesProvider

Parameters:

date - a date

frame - a frame

Returns:

the native frame

Throws:

PatriusException - thrown if native frame is undefined or unknown

getGravityModel

public GravityModel getGravityModel()

Get the gravitational attraction model of the body.

Specified by:

getGravityModel in interface CelestialBody

Returns:

the gravitational attraction model

setGravityModel

public void setGravityModel(GravityModel modelIn)

Set a gravitational attraction model to the body.

Specified by:

setGravityModel in interface CelestialBody

Parameters:

modelIn - the gravitational attraction model

getShape

public BodyShape getShape()

Get the geometric shape of the body.

Specified by:

getShape in interface CelestialBody

Returns:

geometric shape of the body

setShape

public void setShape(BodyShape shapeIn)

Set a geometric shape to the body.

Specified by:

setShape in interface CelestialBody

Parameters:

shapeIn - the shape of the body

getEphemeris

public CelestialBodyEphemeris getEphemeris()

Get the ephemeris of the body.

Specified by:

getEphemeris in interface CelestialBody

Returns:

the ephemeris

setEphemeris

public void setEphemeris(CelestialBodyEphemeris ephemerisIn)

Set an ephemeris to the body.

Specified by:

setEphemeris in interface CelestialBody

Parameters:

ephemerisIn - the ephemeris

toString

public String toString()

Returns a string representation of the body and its attributes.

Specified by:

toString in interface CelestialBody

Overrides:

toString in class Object

Returns:

a string representation of the body and its attributes