fr.cnes.sirius.patrius.propagation.analytical

Class LiuMeanOsculatingConverter

java.lang.Object

fr.cnes.sirius.patrius.propagation.analytical.LiuMeanOsculatingConverter

All Implemented Interfaces:

MeanOsculatingElementsProvider

public class LiuMeanOsculatingConverter
extends Object
implements MeanOsculatingElementsProvider

Liu mean - osculating elements converter. It provides a mean - osculating elements conversion following Liu theory. Liu theory is detailed in the article published by J.J.F. Liu in 1980 entitled "Semianalytic Theory for a Close-Earth Artificial Satellite".

Since:

4.5

Author:

Noe Charpigny

Constructor Summary

Constructors

Constructor and Description
LiuMeanOsculatingConverter(double referenceRadius, double mu, double j2, Frame frame) Constructor.

Method Summary

Modifier and Type	Method and Description
protected Orbit	convertFrame(Orbit orbit, Frame outputFrame) Convert provided orbit in output frame.
Orbit	mean2osc(Orbit orbit) Convert provided mean orbit into osculating elements.
Orbit	osc2mean(Orbit orbit) Convert provided osculating orbit into mean elements.
Orbit	propagateMeanOrbit(AbsoluteDate date) Propagate mean orbit until provided date.
void	setThreshold(double newThreshold) Setter for relative convergence threshold for osculating to mean algorithm.

Methods inherited from class java.lang.Object

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

Constructor Detail

LiuMeanOsculatingConverter

public LiuMeanOsculatingConverter(double referenceRadius,
                                  double mu,
                                  double j2,
                                  Frame frame)
                           throws PatriusException

Constructor.

Parameters:

referenceRadius - reference radius of the central body attraction model (m)

mu - central attraction coefficient (m³/s²)

j2 - Second harmonic of the oblateness of the Earth (.)

frame - Inertial or quasi-inertial frame in which the model is supposed valid, the Z axis of the frame being the polar axis of the body

Throws:

PatriusException - thrown if failed to build initial state or coefficients frame is not inertial

Method Detail

osc2mean

public Orbit osc2mean(Orbit orbit)
               throws PatriusException

Convert provided osculating orbit into mean elements.

Warning: Used algorithm often consists in an iterative algorithm with a convergence criterion. As a result convergence is not always ensured, depending on the underlying theory.

Specified by:

osc2mean in interface MeanOsculatingElementsProvider

Parameters:

orbit - an orbit (osculating elements)

Returns:

mean elements of provided orbit

Throws:

PatriusException - if conversion fails

mean2osc

public Orbit mean2osc(Orbit orbit)
               throws PatriusException

Convert provided mean orbit into osculating elements.

Specified by:

mean2osc in interface MeanOsculatingElementsProvider

Parameters:

orbit - an orbit (mean elements)

Returns:

osculating elements of provided orbit

Throws:

PatriusException - if conversion fails

convertFrame

protected Orbit convertFrame(Orbit orbit,
                             Frame outputFrame)
                      throws PatriusException

Convert provided orbit in output frame.

Parameters:

orbit - orbit

outputFrame - output frame

Returns:

converted orbit in output frame

Throws:

PatriusException - thrown if conversion failed

setThreshold

public void setThreshold(double newThreshold)

Setter for relative convergence threshold for osculating to mean algorithm.

Parameters:

newThreshold - new relative threshold

propagateMeanOrbit

public Orbit propagateMeanOrbit(AbsoluteDate date)
                         throws PatriusException

Propagate mean orbit until provided date.

Specified by:

propagateMeanOrbit in interface MeanOsculatingElementsProvider

Parameters:

date - a date

Returns:

mean orbit at provided date

Throws:

PatriusException - thrown if computation failed