Package org.orekit.forces.gravity.potential

Enum Class TideSystem

java.lang.Object
java.lang.Enum<TideSystem>
org.orekit.forces.gravity.potential.TideSystem
All Implemented Interfaces:
Serializable, Comparable<TideSystem>, Constable
public enum TideSystem extends Enum<TideSystem>
Enumerate for tie systems.

Tide-systems are used to identify if the permanent tide is already present in the gravity field or if it should be handled when computing the solid tides force model.

Since:
6.0
Author:
Luc Maisonobe
See Also:

  • Enum Constant Details

    • TIDE_FREE

      public static final TideSystem TIDE_FREE
      Constant for tide-free gravity fields.

      Tide-free fields don't include the permanent tide, so it must be taken care of when computing the solid tides effects.

    • ZERO_TIDE

      public static final TideSystem ZERO_TIDE
      Constant for zero-tide gravity fields.

      Zero-tide systems already include the permanent tide, so the solid tides effects must not add them, to avoid it been counted twice.

    • UNKNOWN

      public static final TideSystem UNKNOWN
      Constant for unknown tide system.

  • Method Details

    • values

      public static TideSystem[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static TideSystem valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null