Package org.orekit.models.earth.displacement

Class OceanLoading

  • All Implemented Interfaces:
    StationDisplacement
    public class OceanLoading
extends Object
implements StationDisplacement
    Modeling of displacement of reference points due to ocean loading.

    This class implements the same model as IERS HARDIP.F program. For a given site, this model uses a set of amplitudes and phases for the 11 main tides (M₂, S₂, N₂, K₂, K₁, O₁, P₁, Q₁, Mf, Mm, and Ssa) in BLQ format as provided by the Bos-Scherneck web site at Onsala Space Observatory. From these elements, additional admittances are derived using spline interpolation based on tides frequencies for a total of 342 tides, including the 11 main tides.

    This implementation is a complete rewrite of the original HARDISP.F program developed by Duncan Agnew and copyright 2008 IERS Conventions center. This derived work is not endorsed by the IERS conventions center. What remains from the original program is the model (spline interpolation and coefficients). The code by itself is completely different, using the underlying mathematical library for spline interpolation and the existing Orekit features for nutation arguments, time and time scales handling, tides modeling...

    Instances of this class are guaranteed to be immutable

    The original HARDISP.F program is distributed with the following notice: 

      Copyright (C) 2008
  IERS Conventions Center

  ==================================
  IERS Conventions Software License
  ==================================

  NOTICE TO USER:

  BY USING THIS SOFTWARE YOU ACCEPT THE FOLLOWING TERMS AND CONDITIONS
  WHICH APPLY TO ITS USE.

  1. The Software is provided by the IERS Conventions Center ("the
     Center").

  2. Permission is granted to anyone to use the Software for any
     purpose, including commercial applications, free of charge,
     subject to the conditions and restrictions listed below.

  3. You (the user) may adapt the Software and its algorithms for your
     own purposes and you may distribute the resulting "derived work"
     to others, provided that the derived work complies with the
     following requirements:

     a) Your work shall be clearly identified so that it cannot be
        mistaken for IERS Conventions software and that it has been
        neither distributed by nor endorsed by the Center.

     b) Your work (including source code) must contain descriptions of
        how the derived work is based upon and/or differs from the
        original Software.

     c) The name(s) of all modified routine(s) that you distribute
        shall be changed.

     d) The origin of the IERS Conventions components of your derived
        work must not be misrepresented; you must not claim that you
        wrote the original Software.

     e) The source code must be included for all routine(s) that you
        distribute.  This notice must be reproduced intact in any
        source distribution.

  4. In any published work produced by the user and which includes
     results achieved by using the Software, you shall acknowledge
     that the Software was used in obtaining those results.

  5. The Software is provided to the user "as is" and the Center makes
     no warranty as to its use or performance.   The Center does not
     and cannot warrant the performance or results which the user may
     obtain by using the Software.  The Center makes no warranties,
     express or implied, as to non-infringement of third party rights,
     merchantability, or fitness for any particular purpose.  In no
     event will the Center be liable to the user for any consequential,
     incidental, or special damages, including any lost profits or lost
     savings, even if a Center representative has been advised of such
     damages, or for any claim by any third party.

  Correspondence concerning IERS Conventions software should be
  addressed as follows:

                     Gerard Petit
     Internet email: gpetit[at]bipm.org
     Postal address: IERS Conventions Center
                     Time, frequency and gravimetry section, BIPM
                     Pavillon de Breteuil
                     92312 Sevres  FRANCE

     or

                     Brian Luzum
     Internet email: brian.luzum[at]usno.navy.mil
     Postal address: IERS Conventions Center
                     Earth Orientation Department
                     3450 Massachusetts Ave, NW
                     Washington, DC 20392
    Since:
    9.1
    Author:
    Luc Maisonobe
    See Also:
    GroundStation

    • Method Detail

      • displacement

        public org.hipparchus.geometry.euclidean.threed.Vector3D displacement​(BodiesElements elements,
                                                                      Frame earthFrame,
                                                                      org.hipparchus.geometry.euclidean.threed.Vector3D referencePoint)
        Compute displacement of a ground reference point.
        Specified by:
        displacement in interface StationDisplacement
        Parameters:
        elements - elements affecting Earth orientation
        earthFrame - Earth frame in which reference point is defined
        referencePoint - reference point position in earthFrame
        Returns:
        displacement vector to be added to referencePoint