KeplerianParamComputer (patrimoine de base SIRIUS 4.17 API)

java.lang.Object
- fr.cnes.sirius.patrius.progmission.KeplerianParamComputer

```
public final class KeplerianParamComputer
extends Object
```
Utility class computing various keplerian characteristics based on the semi-major axis, eccentricity and true anomaly.
Inspired by the CL_kp_characteristics method from Celestlab

Since:

4.17

Author:

vermeulenp, guillemettem

Constructor Summary

Constructors
Constructor and Description
`KeplerianParamComputer(double sma, double ecc, double v)` Simple constructor with bodyRadius set to `Constants.EGM96_EARTH_EQUATORIAL_RADIUS` and gravitationnal parameter set to `Constants.EGM96_EARTH_MU`.
`KeplerianParamComputer(double sma, double ecc, double v, double bodyRadius, double mu)` Constructor of the class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getCArea()` Compute and return the C constant for the law of areas for the provided orbit.
`double`	`getCCon()` Compute and return the conic's c parameter for the provided orbit, also known as the linear eccentricity.
`double`	`getDinf()` Compute and return the distance between the asymptote and the focus point for the provided orbit.
`double`	`getDva()` Compute and return the delta-V needed to reach liberation velocity at apoapsis for the provided orbit.
`double`	`getDvp()` Compute and return the delta-V needed to reach liberation velocity at periapsis for the provided orbit.
`double`	`getE()` Return the eccentric anomaly for the provided orbit.
`double`	`getEcc()` Returns the eccentricity of the provided orbit.
`double`	`getEnergy()` Compute and return the energy of the provided orbit.
`double`	`getHa()` Compute and return the altitude at apoapsis of the provided orbit.
`double`	`getHp()` Compute and return the altitude at periapsis of the provided orbit.
`static List<KeplerianParamComputer>`	`getKeplerianParams(double[] sma, double[] ecc, double[] v)` Generate instances of `KeplerianParamComputer` based on the provided sma, ecc and v arrays.
`static List<KeplerianParamComputer>`	`getKeplerianParams(double[] sma, double[] ecc, double[] v, double bodyRadius, double mu)` Generate instances of `KeplerianParamComputer` based on the provided sma, ecc and v arrays.
`double`	`getLCon()` Compute and return the conic's l parameter for the provided orbit, also known as the semi-latus rectum.
`double`	`getM()` Return the mean anomaly for the provided orbit.
`double`	`getMeanMotion()` Compute and return the mean motion of the provided orbit.
`double`	`getPeriod()` Compute and return the hyperbolic excess velocity of the provided orbit.
`double`	`getR()` Compute and return the current radius for the provided orbit.
`double`	`getRa()` Compute and return the radius at apoapsis of the provided orbit.
`double`	`getRp()` Compute and return the radius at periapsis of the provided orbit.
`double`	`getSlope()` Compute and return the current velocity slope for the provided orbit.
`double`	`getSma()` Returns the semi-major axis of the provided orbit.
`double`	`getSmb()` Compute and return the semi-minor axis for the provided orbit.
`double`	`getTaninf()` Compute and return the true anomaly at infinity for the provided orbit.
`double`	`getTperi()` Compute and return the time elapsed from last periapsis for the provided orbit.
`double`	`getV()` Return the true anomaly for the provided orbit.
`double`	`getVa()` Compute and return the velocity at apoapsis of the provided orbit.
`double`	`getVel()` Compute and return the current velocity for the provided orbit.
`double`	`getVinf()` Compute and return the hyperbolic excess velocity of the provided orbit.
`double`	`getVla()` Compute and return the liberation velocity at apoapsis for the provided orbit.
`double`	`getVlp()` Compute and return the liberation velocity at periapsis for the provided orbit.
`double`	`getVp()` Compute and return the velocity at periapsis of the provided orbit.
`double`	`getX()` Compute and return the current position on the X-axis for the provided orbit.
`double`	`getY()` Compute and return the current position on the Y-axis for the provided orbit.
`boolean`	`isHyperbolic()` Indicates if the provided orbit is hyperbolic.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - KeplerianParamComputer
```
public KeplerianParamComputer(double sma,
                              double ecc,
                              double v)
                       throws PatriusException
```
    Simple constructor with bodyRadius set to Constants.EGM96_EARTH_EQUATORIAL_RADIUS and gravitationnal parameter set to Constants.EGM96_EARTH_MU.
    
    Parameters:
    
    sma - Semi-major axis (m)
    
    ecc - Eccentricity
    
    v - True anomaly (rad)
    
    Throws:
    
    PatriusException - if the inputs are not valid
  - KeplerianParamComputer
```
public KeplerianParamComputer(double sma,
                              double ecc,
                              double v,
                              double bodyRadius,
                              double mu)
                       throws PatriusException
```
    Constructor of the class.
    
    Parameters:
    
    sma - Semi-major axis (m)
    
    ecc - Eccentricity
    
    v - True anomaly (rad)
    
    bodyRadius - Radius of the central body (m)
    
    mu - Gravitational parameter of the central first body (m^3/s^2)
    
    Throws:
    
    PatriusException - if the inputs are not valid
- Method Detail
  - isHyperbolic
```
public boolean isHyperbolic()
```
    Indicates if the provided orbit is hyperbolic.
    
    Returns:
    
    true if it is, false otherwise
  - getSma
```
public double getSma()
```
    Returns the semi-major axis of the provided orbit.
    
    Returns:
    
    the stored sma (m)
  - getEcc
```
public double getEcc()
```
    Returns the eccentricity of the provided orbit.
    
    Returns:
    
    the stored ecc
  - getRa
```
public double getRa()
             throws PatriusException
```
    Compute and return the radius at apoapsis of the provided orbit.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored ra (m)
    
    Throws:
    
    PatriusException - on internal error
  - getRp
```
public double getRp()
             throws PatriusException
```
    Compute and return the radius at periapsis of the provided orbit.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored rp (m)
    
    Throws:
    
    PatriusException - if incompatible or unhandled types are provided
  - getHa
```
public double getHa()
             throws PatriusException
```
    Compute and return the altitude at apoapsis of the provided orbit.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored ha (m)
    
    Throws:
    
    PatriusException - if incompatible or unhandled types are provided
  - getHp
```
public double getHp()
             throws PatriusException
```
    Compute and return the altitude at periapsis of the provided orbit.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored hp (m)
    
    Throws:
    
    PatriusException - if incompatible or unhandled types are provided
  - getVa
```
public double getVa()
             throws PatriusException
```
    Compute and return the velocity at apoapsis of the provided orbit.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored va (m/s)
    
    Throws:
    
    PatriusException - if incompatible or unhandled types are provided
  - getVp
```
public double getVp()
             throws PatriusException
```
    Compute and return the velocity at periapsis of the provided orbit.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored vp (m/s)
    
    Throws:
    
    PatriusException - if incompatible or unhandled types are provided
  - getVinf
```
public double getVinf()
               throws PatriusException
```
    Compute and return the hyperbolic excess velocity of the provided orbit.
    If the orbit is elliptic, NaN is returned
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored vinf (m/s)
    
    Throws:
    
    PatriusException - if incompatible or unhandled types are provided
  - getPeriod
```
public double getPeriod()
```
    Compute and return the hyperbolic excess velocity of the provided orbit.
    If the orbit is hyperbolic, +inf is returned.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored period (s)
  - getMeanMotion
```
public double getMeanMotion()
```
    Compute and return the mean motion of the provided orbit.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored meanMotion (rad/s)
  - getEnergy
```
public double getEnergy()
```
    Compute and return the energy of the provided orbit.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored energy (J)
  - getCArea
```
public double getCArea()
```
    Compute and return the C constant for the law of areas for the provided orbit.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored cArea (m2/s)
  - getLCon
```
public double getLCon()
```
    Compute and return the conic's l parameter for the provided orbit, also known as the semi-latus rectum.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored lCon (m)
  - getCCon
```
public double getCCon()
```
    Compute and return the conic's c parameter for the provided orbit, also known as the linear eccentricity.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored cCon (m)
  - getSmb
```
public double getSmb()
```
    Compute and return the semi-minor axis for the provided orbit.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored smb (m)
  - getDinf
```
public double getDinf()
```
    Compute and return the distance between the asymptote and the focus point for the provided orbit.
    If the orbit is elliptical, NaN is returned.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored dinf (m)
  - getVlp
```
public double getVlp()
              throws PatriusException
```
    Compute and return the liberation velocity at periapsis for the provided orbit.
    If the orbit is hyperbolic, NaN is returned.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored vlp (m/s)
    
    Throws:
    
    PatriusException - if incompatible or unhandled types are provided
  - getVla
```
public double getVla()
              throws PatriusException
```
    Compute and return the liberation velocity at apoapsis for the provided orbit.
    If the orbit is hyperbolic, NaN is returned.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored vla (m/s)
    
    Throws:
    
    PatriusException - if incompatible or unhandled types are provided
  - getDvp
```
public double getDvp()
              throws PatriusException
```
    Compute and return the delta-V needed to reach liberation velocity at periapsis for the provided orbit.
    If the orbit is hyperbolic, NaN is returned.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored dvp (m/s)
    
    Throws:
    
    PatriusException - if incompatible or unhandled types are provided
  - getDva
```
public double getDva()
              throws PatriusException
```
    Compute and return the delta-V needed to reach liberation velocity at apoapsis for the provided orbit.
    If the orbit is hyperbolic, NaN is returned.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored dva (m/s)
    
    Throws:
    
    PatriusException - if incompatible or unhandled types are provided
  - getV
```
public double getV()
```
    Return the true anomaly for the provided orbit.
    
    Returns:
    
    the stored V (rad)
  - getM
```
public double getM()
```
    Return the mean anomaly for the provided orbit.
    
    Returns:
    
    the stored M (rad)
  - getE
```
public double getE()
```
    Return the eccentric anomaly for the provided orbit.
    
    Returns:
    
    the stored E (rad)
  - getTaninf
```
public double getTaninf()
```
    Compute and return the true anomaly at infinity for the provided orbit.
    If the orbit is elliptic, NaN is returned.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored trueAnomInf (rad)
  - getTperi
```
public double getTperi()
```
    Compute and return the time elapsed from last periapsis for the provided orbit.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored tFromPeri (s)
  - getR
```
public double getR()
```
    Compute and return the current radius for the provided orbit.
    All keplerian characteristics are computed once.
    
    Returns:
    
    the stored r (m)
  - getX
```
public double getX()
```
    Compute and return the current position on the X-axis for the provided orbit.
    The position is computed once.
    
    Returns:
    
    the stored x value (m)
  - getY
```
public double getY()
```
    Compute and return the current position on the Y-axis for the provided orbit.
    The position is computed once.
    
    Returns:
    
    the stored y value (m)
  - getSlope
```
public double getSlope()
```
    Compute and return the current velocity slope for the provided orbit.
    The position is computed once.
    
    Returns:
    
    the stored slope (rad)
  - getVel
```
public double getVel()
```
    Compute and return the current velocity for the provided orbit.
    The velocity is computed once.
    
    Returns:
    
    the stored vel (m/s)
  - getKeplerianParams
```
public static List<KeplerianParamComputer> getKeplerianParams(double[] sma,
                                                              double[] ecc,
                                                              double[] v)
                                                       throws PatriusException
```
    Generate instances of KeplerianParamComputer based on the provided sma, ecc and v arrays.
    Constants.EGM96_EARTH_MU will be used as the gravitational parameter and Constants.EGM96_EARTH_EQUATORIAL_RADIUS as the body radius.
    
    Parameters:
    
    sma - Array containing semi-major axis values (m)
    
    ecc - Array containing eccentriicty values
    
    v - Array containing true anomaly values (rad)
    
    Returns:
    
    the generated list
    
    Throws:
    
    PatriusException - if incompatible or unhandled types are provided
  - getKeplerianParams
```
public static List<KeplerianParamComputer> getKeplerianParams(double[] sma,
                                                              double[] ecc,
                                                              double[] v,
                                                              double bodyRadius,
                                                              double mu)
                                                       throws PatriusException
```
    Generate instances of KeplerianParamComputer based on the provided sma, ecc and v arrays.
    Constants.EGM96_EARTH_MU will be used as the gravitational parameter and Constants.EGM96_EARTH_EQUATORIAL_RADIUS as the body radius.
    
    Parameters:
    
    sma - Array containing semi-major axis values (m)
    
    ecc - Array containing eccentriicty values
    
    v - Array containing true anomaly values (rad)
    
    bodyRadius - Body radius (m)
    
    mu - Gravitational parameter of the central first body (m^3/s^2)
    
    Returns:
    
    the generated list
    
    Throws:
    
    PatriusException - if incompatible or unhandled types are provided

Class KeplerianParamComputer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KeplerianParamComputer

KeplerianParamComputer

Method Detail

isHyperbolic

getSma

getEcc

getRa

getRp

getHa

getHp

getVa

getVp

getVinf

getPeriod

getMeanMotion

getEnergy

getCArea

getLCon

getCCon

getSmb

getDinf

getVlp

getVla

getDvp

getDva

getV

getM

getE

getTaninf

getTperi

getR

getX

getY

getSlope

getVel

getKeplerianParams

getKeplerianParams