Tide (ORbit Extrapolation KIT 10.1 API)

java.lang.Object
- org.orekit.models.earth.displacement.Tide

```
public class Tide
extends Object
```
Class representing a tide.

Since:

9.1

Author:

Luc Maisonobe

Field Summary

Fields
Modifier and Type	Field and Description
`static Tide`	`K1` K₁ tide.
`static Tide`	`K2` K₂ tide.
`static Tide`	`M2` M₂ tide.
`static Tide`	`MF` Mf tide.
`static Tide`	`MM` Mm tide.
`static Tide`	`N2` N₂ tide.
`static Tide`	`O1` O₁ tide.
`static Tide`	`P1` P₁ tide.
`static Tide`	`Q1` Q₁ tide.
`static Tide`	`S2` S₂ tide.
`static Tide`	`SSA` Ssa tide.

Constructor Summary

Constructors
Constructor and Description
`Tide(int doodsonNumber)` Simple constructor.
`Tide(int cTau, int cS, int cH, int cP, int cNprime, int cPs)` Simple constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object object)`
`int[]`	`getDelaunayMultipliers()` Get the multipliers for Delaunay arguments (l, l', F, D, Ω).
`int[]`	`getDoodsonMultipliers()` Get the multipliers for Doodson arguments (τ, s, h, p, N', ps).
`int`	`getDoodsonNumber()` Get the Doodson number.
`double`	`getPhase(BodiesElements elements)` Get the phase of the tide.
`double`	`getRate(BodiesElements elements)` Get the angular rate of the tide.
`int`	`getTauMultiplier()` Get the multiplier for the τ Doodson argument.
`int`	`hashCode()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - M2
```
public static final Tide M2
```
    M₂ tide.
  - S2
```
public static final Tide S2
```
    S₂ tide.
  - N2
```
public static final Tide N2
```
    N₂ tide.
  - K2
```
public static final Tide K2
```
    K₂ tide.
  - K1
```
public static final Tide K1
```
    K₁ tide.
  - O1
```
public static final Tide O1
```
    O₁ tide.
  - P1
```
public static final Tide P1
```
    P₁ tide.
  - Q1
```
public static final Tide Q1
```
    Q₁ tide.
  - MF
```
public static final Tide MF
```
    Mf tide.
  - MM
```
public static final Tide MM
```
    Mm tide.
  - SSA
```
public static final Tide SSA
```
    Ssa tide.
- Constructor Detail
  - Tide
```
public Tide(int cTau,
            int cS,
            int cH,
            int cP,
            int cNprime,
            int cPs)
```
    Simple constructor.
    
    Parameters:
    
    cTau - coefficient for mean lunar time
    
    cS - coefficient for mean longitude of the Moon
    
    cH - coefficient for mean longitude of the Sun
    
    cP - coefficient for longitude of Moon mean perigee
    
    cNprime - negative of the longitude of the Moon's mean ascending node on the ecliptic
    
    cPs - coefficient for longitude of Sun mean perigee
  - Tide
```
public Tide(int doodsonNumber)
```
    Simple constructor.
    
    Parameters:
    
    doodsonNumber - Doodson Number
- Method Detail
  - getDelaunayMultipliers
```
public int[] getDelaunayMultipliers()
```
    Get the multipliers for Delaunay arguments (l, l', F, D, Ω).
    Beware that for tides the multipliers for Delaunay arguments have an opposite sign with respect to the convention used for nutation computation! Here, we obey the tides convention.
    
    Returns:
    
    multipliers for Delaunay arguments (l, l', F, D, Ω)
  - getDoodsonMultipliers
```
public int[] getDoodsonMultipliers()
```
    Get the multipliers for Doodson arguments (τ, s, h, p, N', ps).
    
    Returns:
    
    multipliers for Doodson arguments (τ, s, h, p, N', ps)
  - getDoodsonNumber
```
public int getDoodsonNumber()
```
    Get the Doodson number.
    
    Returns:
    
    Doodson number
  - getTauMultiplier
```
public int getTauMultiplier()
```
    Get the multiplier for the τ Doodson argument.
    This multiplier identifies semi-diurnal tides (2), diurnal tides (1) and long period tides (0)
    
    Returns:
    
    multiplier for the τ Doodson argument
  - getPhase
```
public double getPhase(BodiesElements elements)
```
    Get the phase of the tide.
    
    Parameters:
    
    elements - elements to use
    
    Returns:
    
    phase of the tide (radians)
  - getRate
```
public double getRate(BodiesElements elements)
```
    Get the angular rate of the tide.
    
    Parameters:
    
    elements - elements to use
    
    Returns:
    
    angular rate of the tide (radians/second)
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Tide

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

M2

S2

N2

K2

K1

O1

P1

Q1

MF

MM

SSA

Constructor Detail

Tide

Tide

Method Detail

getDelaunayMultipliers

getDoodsonMultipliers

getDoodsonNumber

getTauMultiplier

getPhase

getRate

equals

hashCode