fr.cnes.sirius.patrius.forces.gravity.potential

Interface PotentialCoefficientsProvider

All Superinterfaces:

Serializable

All Known Implementing Classes:

EGMFormatReader, GRGSFormatReader, ICGEMFormatReader, PotentialCoefficientsReader, SHMFormatReader

public interface PotentialCoefficientsProvider
extends Serializable

Interface used to provide gravity field coefficients.

Author:

Luc Maisonobe

See Also:

GravityFieldFactory

Method Summary

Modifier and Type	Method and Description
double	getAe() Get the value of the central body reference radius.
double[][]	getC(int n, int m, boolean normalized) Get the tesseral-sectorial and zonal coefficients.
double[]	getJ(boolean normalized, int n) Get the zonal coefficients.
double	getMu() Get the central body attraction coefficient.
double[][]	getS(int n, int m, boolean normalized) Get tesseral-sectorial coefficients.
double[][]	getSigmaC(int n, int m, boolean normalized) Get the sigma tesseral-sectorial and zonal coefficients.
double[][]	getSigmaS(int n, int m, boolean normalized) Get tesseral-sectorial coefficients.

Method Detail

getJ

double[] getJ(boolean normalized,
              int n)
       throws PatriusException

Get the zonal coefficients.

Parameters:

normalized - (true) or un-normalized (false)

n - the maximal degree requested

Returns:

J the zonal coefficients array.

Throws:

PatriusException - if the requested maximal degree exceeds the available degree

getC

double[][] getC(int n,
                int m,
                boolean normalized)
         throws PatriusException

Get the tesseral-sectorial and zonal coefficients.

Parameters:

n - the degree

m - the order

normalized - (true) or un-normalized (false)

Returns:

the cosines coefficients matrix

Throws:

PatriusException - if the requested maximal degree or order exceeds the available degree or order

getS

double[][] getS(int n,
                int m,
                boolean normalized)
         throws PatriusException

Get tesseral-sectorial coefficients.

Parameters:

n - the degree

m - the order

normalized - (true) or un-normalized (false)

Returns:

the sines coefficients matrix

Throws:

PatriusException - if the requested maximal degree or order exceeds the available degree or order

getSigmaC

double[][] getSigmaC(int n,
                     int m,
                     boolean normalized)
              throws PatriusException

Get the sigma tesseral-sectorial and zonal coefficients.

Parameters:

n - the degree

m - the order

normalized - (true) or un-normalized (false)

Returns:

the sines coefficients matrix

Throws:

PatriusException - if the requested maximal degree or order exceeds the available degree or order

getSigmaS

double[][] getSigmaS(int n,
                     int m,
                     boolean normalized)
              throws PatriusException

Get tesseral-sectorial coefficients.

Parameters:

n - the degree

m - the order

normalized - (true) or un-normalized (false)

Returns:

the sines coefficients matrix

Throws:

PatriusException - if the requested maximal degree or order exceeds the available degree or order

getMu

double getMu()

Get the central body attraction coefficient.

Returns:

mu (m³/s²)

getAe

double getAe()

Get the value of the central body reference radius.

Returns:

ae (m)