fr.cnes.sirius.patrius.frames

Class SynodicFrame

java.lang.Object

fr.cnes.sirius.patrius.frames.SynodicFrame

public class SynodicFrame
extends Object

Synodic frame definition. A synodic frame is linked to the 3 body problem:

Center of the frame at the center of the provided inertial frame.

X axis directed along the line (secondary body, main body) and directed toward main body

Z axis out-of-plane

Coordinates in synodic frame are normalized: for example in the system (Sun, Earth) with inertial frame being Earth-centered, synodic frame is centered on Earth and Sun coordinates are (1, 0, 0).

Due to its particular definition (handling of adimensional quantities), this frame does not inherit the Frame class.

Since:

4.6

Author:

Emmanuel Bignon

Constructor Summary

Constructors

Constructor and Description
SynodicFrame(PVCoordinatesProvider bigPrimaryBody, PVCoordinatesProvider smallSecondaryBody, double meanMotion) Build a new instance.

Method Summary

Modifier and Type	Method and Description
PVCoordinatesProvider	getBody1() Returns the primary body.
PVCoordinatesProvider	getBody2() Returns the secondary body.
double	getMeanMotion() Returns the secondary body mean motion.
PVCoordinates	inertialToSynodic(AbsoluteDate date, Frame frame, PVCoordinates pvInertial) Transformation from inertial frame to synodic frame.
Vector3D	inertialToSynodicAcceleration(AbsoluteDate date, Frame frame, PVCoordinates pvInertial, Vector3D accelerationInertial3D) Transformation of acceleration from inertial frame to synodic frame.
PVCoordinates	synodicToInertial(AbsoluteDate date, Frame frame, PVCoordinates pvSynodic) Transformation from synodic frame to inertial frame.
Vector3D	synodicToInertialAcceleration(AbsoluteDate date, Frame frame, PVCoordinates pvSynodic, Vector3D accelerationSynodic3D) Transformation of acceleration from synodic frame to inertial frame.

Methods inherited from class java.lang.Object

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

Constructor Detail

SynodicFrame

public SynodicFrame(PVCoordinatesProvider bigPrimaryBody,
                    PVCoordinatesProvider smallSecondaryBody,
                    double meanMotion)

Build a new instance.

Parameters:

bigPrimaryBody - main body of the three-body problem

smallSecondaryBody - secondary body of the three-body problem

meanMotion - secondary body mean motion

Method Detail

inertialToSynodic

public PVCoordinates inertialToSynodic(AbsoluteDate date,
                                       Frame frame,
                                       PVCoordinates pvInertial)
                                throws PatriusException

Transformation from inertial frame to synodic frame. Center stays the same as input. Units change from m and m/s to adimensional.

Parameters:

date - At which the transformation is to be done.

frame - In which the transformation is done.

pvInertial - Initial PVCoordinates in the inertial frame.

Returns:

PVCoordinates in the synodic rotating frame.

Throws:

PatriusException - thrown if body coordinates could not be retrieved

synodicToInertial

public PVCoordinates synodicToInertial(AbsoluteDate date,
                                       Frame frame,
                                       PVCoordinates pvSynodic)
                                throws PatriusException

Transformation from synodic frame to inertial frame. Center stay the same as input. Units change from adimensional to m and m/s.

Parameters:

date - At which the transformation is to be done.

frame - In which the transformation is done.

pvSynodic - Initial PVCoordinates in the synodic reference frame.

Returns:

PVCoordinates in the inertial frame.

Throws:

PatriusException - thrown if body coordinates could not be retrieved

synodicToInertialAcceleration

public Vector3D synodicToInertialAcceleration(AbsoluteDate date,
                                              Frame frame,
                                              PVCoordinates pvSynodic,
                                              Vector3D accelerationSynodic3D)
                                       throws PatriusException

Transformation of acceleration from synodic frame to inertial frame. Center stay the same as input. Units change from adimensional to m and m/s.

Parameters:

date - At which the transformation is to be done.

frame - In which the transformation is done.

pvSynodic - Initial PVCoordinates in the synodic reference frame.

accelerationSynodic3D - Acceleration in synodic reference frame Vector3D

Returns:

Acceleration in the inertial frame, in Vector3D.

Throws:

PatriusException - thrown if body coordinates could not be retrieved

inertialToSynodicAcceleration

public Vector3D inertialToSynodicAcceleration(AbsoluteDate date,
                                              Frame frame,
                                              PVCoordinates pvInertial,
                                              Vector3D accelerationInertial3D)
                                       throws PatriusException

Transformation of acceleration from inertial frame to synodic frame. Center stays the same as input. Units change from m/s/s to adimensional.

Parameters:

date - At which the transformation is to be done.

frame - In which the transformation is done.

pvInertial - Initial PVCoordinates in the inertial frame.

accelerationInertial3D - Initial acceleration in the inertial frame.

Returns:

Acceleration in the synodic rotating frame.

Throws:

PatriusException - thrown if body coordinates could not be retrieved

getBody1

public final PVCoordinatesProvider getBody1()

Returns the primary body.

Returns:

the primary body

getBody2

public final PVCoordinatesProvider getBody2()

Returns the secondary body.

Returns:

the secondary body

getMeanMotion

public final double getMeanMotion()

Returns the secondary body mean motion.

Returns:

the secondary body mean motion