fr.cnes.sirius.patrius.propagation.analytical.twod

Class Analytical2DOrbitModel

java.lang.Object

fr.cnes.sirius.patrius.propagation.analytical.twod.Analytical2DOrbitModel

All Implemented Interfaces:

MeanOsculatingElementsProvider, Serializable

public class Analytical2DOrbitModel
extends Object
implements Serializable, MeanOsculatingElementsProvider

This class represents an analytical 2D orbit model, it is made of 6 parameter models, one per adapted circular parameter.

Since:

1.3

Version:

$Id: Analytical2DOrbitModel.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Rami Houdroge

See Also:

Analytical2DParameterModel, Analytical2DPropagator, Serialized Form

Concurrency :

conditionally thread-safe

Concurrency comment :

thread safe if the underlying Analytical2DParameterModel and AbsoluteDate objects are thread safe

Constructor Summary

Constructors

Constructor and Description
Analytical2DOrbitModel(Analytical2DParameterModel a, Analytical2DParameterModel ex, Analytical2DParameterModel ey, Analytical2DParameterModel i, Analytical2DParameterModel lna, Analytical2DParameterModel alpha, double mu) Create an analytical 2D orbit model with specified parameter models.
Analytical2DOrbitModel(Analytical2DParameterModel a, Analytical2DParameterModel ex, Analytical2DParameterModel ey, Analytical2DParameterModel i, Analytical2DParameterModel lna, Analytical2DParameterModel alpha, int[] orders, double mu) Create an analytical 2D orbit model with specified parameter models.
Analytical2DOrbitModel(Analytical2DParameterModel a, Analytical2DParameterModel ex, Analytical2DParameterModel ey, Analytical2DParameterModel i, Analytical2DParameterModel lna, Analytical2DParameterModel alpha, int[] orders, MassProvider mass, double mu) Create an analytical 2D orbit model with specified parameter models, development orders, standard gravitational parameter and spacecraft mass.
Analytical2DOrbitModel(Analytical2DParameterModel a, Analytical2DParameterModel ex, Analytical2DParameterModel ey, Analytical2DParameterModel i, Analytical2DParameterModel lna, Analytical2DParameterModel alpha, MassProvider mass, double mu) Create an analytical 2D orbit model with specified parameter models, standard gravitational parameter and spacecraft mass.

Method Summary

Modifier and Type	Method and Description
Analytical2DParameterModel	getAolModel() Get the argument of latitude parameter model.
int[]	getDevelopmentOrders() Return the array with models trigonometric orders.
Analytical2DParameterModel	getExModel() Get the x eccentricity component parameter model.
Analytical2DParameterModel	getEyModel() Get the y eccentricity component parameter model.
Analytical2DParameterModel	getIncModel() Get the inclination parameter model.
Analytical2DParameterModel	getLnaModel() Get the longitude of ascending node parameter model.
MassProvider	getMassModel() Returns the spacecraft mass model.
int[]	getMaxOrders() Return the array with the highest trigonometric orders available.
double	getMu() Returns the standard gravitational parameter.
Analytical2DParameterModel[]	getParameterModels() Get the array of parameter models.
Analytical2DParameterModel	getSmaModel() Get the semi major axis parameter model.
Orbit	mean2osc(Orbit orbit) Convert provided mean orbit into osculating elements.
protected Orbit	mean2osc(Orbit orbit, int[] orders) Mean to osculating conversion with provided orders.
Orbit	osc2mean(Orbit orbit) Convert provided osculating orbit into mean elements.
protected Orbit	osc2mean(Orbit orbit, int[] orders) Osculating to mean conversion with provided orders.
Orbit	propagateMeanOrbit(AbsoluteDate date) Propagate mean orbit until provided date.
double[]	propagateModel(AbsoluteDate date) Propagate each parameter model to specified date and return an array of 6 values.
double[]	propagateModel(AbsoluteDate date, int[] orders) Propagate each parameter model to specified date and return an array of 6 values.
void	setThreshold(double newThreshold) Setter for relative convergence threshold for osculating to mean conversion used by method osc2mean(Orbit).

Methods inherited from class java.lang.Object

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

Constructor Detail

Analytical2DOrbitModel

public Analytical2DOrbitModel(Analytical2DParameterModel a,
                              Analytical2DParameterModel ex,
                              Analytical2DParameterModel ey,
                              Analytical2DParameterModel i,
                              Analytical2DParameterModel lna,
                              Analytical2DParameterModel alpha,
                              int[] orders,
                              MassProvider mass,
                              double mu)

Create an analytical 2D orbit model with specified parameter models, development orders, standard gravitational parameter and spacecraft mass.

Parameters:

a - 2D model of orbital parameter a

ex - 2D model of orbital parameter ex

ey - 2D model of orbital parameter ey

i - 2D model of parameter i

lna - 2D model of parameter lna

alpha - 2D model of parameter alpha

orders - orders of trigonometric developments for [a, ex, ey, i, lna, alpha]

mass - mass of spacecraft

mu - standard gravitational parameter

Analytical2DOrbitModel

public Analytical2DOrbitModel(Analytical2DParameterModel a,
                              Analytical2DParameterModel ex,
                              Analytical2DParameterModel ey,
                              Analytical2DParameterModel i,
                              Analytical2DParameterModel lna,
                              Analytical2DParameterModel alpha,
                              MassProvider mass,
                              double mu)

Create an analytical 2D orbit model with specified parameter models, standard gravitational parameter and spacecraft mass. The trigonometric development orders will be the highest admissible.

Parameters:

a - 2D model of orbital parameter a

ex - 2D model of orbital parameter ex

ey - 2D model of parameter ey

i - 2D model of parameter i

lna - 2D model of parameter lna

alpha - 2D model of parameter alpha

mass - mass of spacecraft

mu - standard gravitational parameter

Analytical2DOrbitModel

public Analytical2DOrbitModel(Analytical2DParameterModel a,
                              Analytical2DParameterModel ex,
                              Analytical2DParameterModel ey,
                              Analytical2DParameterModel i,
                              Analytical2DParameterModel lna,
                              Analytical2DParameterModel alpha,
                              double mu)

Create an analytical 2D orbit model with specified parameter models. The pso and lna coefficients will be computed using the user specified psoLnaCoefs array. The trigonometric development orders will be the highest admissible.

Parameters:

a - 2D model of parameter a

ex - 2D model of parameter ex

ey - 2D model of parameter ey

i - 2D model of parameter i

lna - 2D model of parameter raan

alpha - 2D model of parameter alpha

mu - standard gravitational parameter

Analytical2DOrbitModel

public Analytical2DOrbitModel(Analytical2DParameterModel a,
                              Analytical2DParameterModel ex,
                              Analytical2DParameterModel ey,
                              Analytical2DParameterModel i,
                              Analytical2DParameterModel lna,
                              Analytical2DParameterModel alpha,
                              int[] orders,
                              double mu)

Create an analytical 2D orbit model with specified parameter models. The pso and lna coefficients will be computed using the user specified psoLnaCoefs array. The development orders will be the highest admissible.

Parameters:

a - 2D model of parameter a

ex - 2D model of parameter ex

ey - 2D model of parameter ey

i - 2D model of parameter i

lna - 2D model of parameter raan

alpha - 2D model of parameter alpha

orders - orders of trigonometric developments for [a, ex, ey, i, lna, alpha]

mu - standard gravitational parameter

Method Detail

propagateModel

public double[] propagateModel(AbsoluteDate date)
                        throws PatriusException

Propagate each parameter model to specified date and return an array of 6 values.

Parameters:

date - date

Returns:

array containing [a, ex, ey, i, raan, alpha]

Throws:

PatriusException - thrown if Earth Rotation Angle (ERA) cannot be computed

propagateModel

public double[] propagateModel(AbsoluteDate date,
                               int[] orders)
                        throws PatriusException

Propagate each parameter model to specified date and return an array of 6 values.

Parameters:

date - date

orders - orders [6 x trig]

Returns:

array containing [a, ex, ey, i, raan, alpha]

Throws:

PatriusException - thrown if Earth Rotation Angle (ERA) cannot be computed

getDevelopmentOrders

public int[] getDevelopmentOrders()

Return the array with models trigonometric orders. These orders are ordered as per : [a, ex, ey, i, lna, alpha].

Returns:

array with models trigonometric orders

getMaxOrders

public int[] getMaxOrders()

Return the array with the highest trigonometric orders available. These orders are ordered as per : [a, ex, ey, i, lna, alpha].

Returns:

array with highest orders

getMassModel

public MassProvider getMassModel()

Returns the spacecraft mass model.

Returns:

the mass model

getMu

public double getMu()

Returns the standard gravitational parameter.

Returns:

mu

getParameterModels

public Analytical2DParameterModel[] getParameterModels()

Get the array of parameter models.

Returns:

[sma, ex, ey, inc, lna, aol]

getSmaModel

public Analytical2DParameterModel getSmaModel()

Get the semi major axis parameter model.

Returns:

the parameter model

getExModel

public Analytical2DParameterModel getExModel()

Get the x eccentricity component parameter model.

Returns:

the parameter model

getEyModel

public Analytical2DParameterModel getEyModel()

Get the y eccentricity component parameter model.

Returns:

the parameter model

getIncModel

public Analytical2DParameterModel getIncModel()

Get the inclination parameter model.

Returns:

the parameter model

getLnaModel

public Analytical2DParameterModel getLnaModel()

Get the longitude of ascending node parameter model.

Returns:

the parameter model

getAolModel

public Analytical2DParameterModel getAolModel()

Get the argument of latitude parameter model.

Returns:

the parameter model

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.

This method returns the mean/centered part of the orbit (i.e. without the harmonic part).

Warning: the method assumes the provided orbit is an "osculating" orbit in the analytical 2D model sense.

Specified by:

osc2mean in interface MeanOsculatingElementsProvider

Parameters:

orbit - an orbit (osculating elements)

Returns:

mean elements of provided orbit

Throws:

PatriusException - if conversion fails

osc2mean

protected Orbit osc2mean(Orbit orbit,
                         int[] orders)
                  throws PatriusException

Osculating to mean conversion with provided orders.

This method returns the mean/centered part of the orbit (i.e. without the harmonic part).

Warning: the method assumes the provided orbit is an "osculating" orbit in the analytical 2D model sense.

Protected method because not to be used by users but only by this class and Analytical2DPropagator

.

Parameters:

orbit - osculating orbit

orders - development orders

Returns:

mean orbit in orbit frame and type

Throws:

PatriusException - thrown if model propagation failed or frame conversion to output type failed or algorithm dit not converge

mean2osc

public Orbit mean2osc(Orbit orbit)
               throws PatriusException

Convert provided mean orbit into osculating elements.

Warning: the method assumes the provided orbit is a "mean" orbit in the analytical 2D model sense.

Specified by:

mean2osc in interface MeanOsculatingElementsProvider

Parameters:

orbit - an orbit (mean elements)

Returns:

osculating elements of provided orbit

Throws:

PatriusException - if conversion fails

mean2osc

protected Orbit mean2osc(Orbit orbit,
                         int[] orders)
                  throws PatriusException

Mean to osculating conversion with provided orders.

Warning: the method assumes the provided orbit is a "mean" orbit in the analytical 2D model sense.

Protected method because not to be used by users but only by this class and Analytical2DPropagator

.

Parameters:

orbit - mean orbit

orders - development orders

Returns:

osculating orbit in orbit frame and type

Throws:

PatriusException - thrown if model propagation failed or frame conversion to output type failed

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

setThreshold

public void setThreshold(double newThreshold)

Setter for relative convergence threshold for osculating to mean conversion used by method osc2mean(Orbit).

Parameters:

newThreshold - new relative threshold