Package org.orekit.forces.gravity.potential

Interface SphericalHarmonicsProvider

All Superinterfaces:
TideSystemProvider
All Known Subinterfaces:
NormalizedSphericalHarmonicsProvider, RawSphericalHarmonicsProvider, UnnormalizedSphericalHarmonicsProvider
All Known Implementing Classes:
CachedNormalizedSphericalHarmonicsProvider
public interface SphericalHarmonicsProvider extends TideSystemProvider
Interface used to provide spherical harmonics coefficients.

Two interfaces are provided to distinguish between normalized and un-normalized coefficients: NormalizedSphericalHarmonicsProvider and UnnormalizedSphericalHarmonicsProvider. To account for gravity perturbations all providers are capable of providing the coefficients on specific dates, using the onDate(AbsoluteDate) methods.

Typical usage when evaluating the geopotential: 


     NormalizedSphericalHarmonicsProvider provider = ...;
     NormalizedSphericalHarmonics coeffs = provider.onDate(date);
     double c20 = coeffs.getNormalizedCnm(2, 0);
Since:
6.0
Author:
Luc Maisonobe
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getAe()
    Get the value of the central body reference radius.
    int
    getMaxDegree()
    Get the maximal supported degree.
    int
    getMaxOrder()
    Get the maximal supported order.
    double
    getMu()
    Get the central body attraction coefficient.
    AbsoluteDate
    getReferenceDate()
    Get the reference date for the harmonics.

    Methods inherited from interface org.orekit.forces.gravity.potential.TideSystemProvider

    getTideSystem

  • Method Details

    • getMaxDegree

      int getMaxDegree()
      Get the maximal supported degree.
      Returns:
      maximal supported degree

    • getMaxOrder

      int getMaxOrder()
      Get the maximal supported order.
      Returns:
      maximal supported 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)

    • getReferenceDate

      AbsoluteDate getReferenceDate()
      Get the reference date for the harmonics.

      For piecewise models, the latest reference date is returned.

      Returns:
      reference date for the harmonics (may be null if no reference date is defined)