org.orekit.forces.gravity.potential

Enum OceanLoadDeformationCoefficients

java.lang.Object

java.lang.Enum<OceanLoadDeformationCoefficients>

org.orekit.forces.gravity.potential.OceanLoadDeformationCoefficients

All Implemented Interfaces:

Serializable, Comparable<OceanLoadDeformationCoefficients>

public enum OceanLoadDeformationCoefficients
extends Enum<OceanLoadDeformationCoefficients>

Supported Ocean load Deformation coefficients (Love numbers k'_i).

Since:

6.1

Author:

Luc Maisonobe

See Also:

GravityFieldFactory

Enum Constant Summary

Enum Constants

Enum Constant and Description
GEGOUT Coefficients computed by Pascal Gégout, CNRS / UMR5563 (GET).
IERS_1996 Coefficients from IERS 1996 conventions.
IERS_2003 Coefficients from IERS 2003 conventions.
IERS_2010 Coefficients from IERS 2010 conventions.

Method Summary

Modifier and Type	Method and Description
abstract double[]	getCoefficients() Get the load deformation coefficients for ocean tides.
static OceanLoadDeformationCoefficients	valueOf(String name) Returns the enum constant of this type with the specified name.
static OceanLoadDeformationCoefficients[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

IERS_1996

public static final OceanLoadDeformationCoefficients IERS_1996

Coefficients from IERS 1996 conventions.

Note that coefficients from conventions IERS 1996, 2003 and 2010 are all equal to each other.

IERS_2003

public static final OceanLoadDeformationCoefficients IERS_2003

Coefficients from IERS 2003 conventions.

Note that coefficients from conventions IERS 1996, 2003 and 2010 are all equal to each other.

IERS_2010

public static final OceanLoadDeformationCoefficients IERS_2010

Coefficients from IERS 2010 conventions.

Note that coefficients from conventions IERS 1996, 2003 and 2010 are all equal to each other.

GEGOUT

public static final OceanLoadDeformationCoefficients GEGOUT

Coefficients computed by Pascal Gégout, CNRS / UMR5563 (GET).

These coefficients are available up to degree 250.

Method Detail

values

public static OceanLoadDeformationCoefficients[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OceanLoadDeformationCoefficients c : OceanLoadDeformationCoefficients.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OceanLoadDeformationCoefficients valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getCoefficients

public abstract double[] getCoefficients()
                                  throws OrekitException

Get the load deformation coefficients for ocean tides.

Returns:

load deformation coefficients for ocean tides

Throws:

OrekitException - if coefficients cannot be loaded