fr.cnes.sirius.patrius.forces.gravity.tides.coefficients

Class OceanTidesCoefficientsSet

java.lang.Object

fr.cnes.sirius.patrius.forces.gravity.tides.coefficients.OceanTidesCoefficientsSet

public final class OceanTidesCoefficientsSet
extends Object

Represents a line from the ocean tides data file.
The proper way to use this it to call the getCoefficientProvider method. Indeed, the OceanTidesCoefficientsFactory will determine the best reader to use, depending on file available in the file system.

Since:

1.2

Version:

$Id: OceanTidesCoefficientsSet.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Rami Houdroge

Concurrency :

immutable

Constructor Summary

Constructors

Constructor and Description
OceanTidesCoefficientsSet(double nDoodson, int degree, int order, double cslmp, double cclmp, double cslmm, double cclmm, double clmp, double elmp, double clmm, double elmm) Constructor.

Method Summary

Modifier and Type	Method and Description
double	code() Get a hashcode for this set.
static double	computeCode(double doodson, int l, int m) Computes code of data set.
double	getCcm()
double	getCcp()
double	getCm()
double	getCp()
double	getCsm()
double	getCsp()
int	getDegree()
double	getDoodson()
double	getEm()
double	getEp()
int	getOrder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OceanTidesCoefficientsSet

public OceanTidesCoefficientsSet(double nDoodson,
                                 int degree,
                                 int order,
                                 double cslmp,
                                 double cclmp,
                                 double cslmm,
                                 double cclmm,
                                 double clmp,
                                 double elmp,
                                 double clmm,
                                 double elmm)

Constructor. Create new OceanTidesCoefficientsSet from line of file

Parameters:

nDoodson - doodson number

degree - degree

order - order

cslmp - Csin_lm⁺

cclmp - Ccos_lm⁺

cslmm - Csin_lm^-

cclmm - Ccos_lm^-

clmp - C_lm⁺

elmp - ε_lm⁺

clmm - C_lm^-

elmm - ε_lm^-

Method Detail

getDoodson

public double getDoodson()

Returns:

the doodson number

getDegree

public int getDegree()

Returns:

the degree

getOrder

public int getOrder()

Returns:

the order

getCcp

public double getCcp()

Returns:

C_lm⁺

getCcm

public double getCcm()

Returns:

C_lm^-

getCsp

public double getCsp()

Returns:

S_lm⁺

getCsm

public double getCsm()

Returns:

S_lm^-

getCp

public double getCp()

Returns:

C_lm⁺

getCm

public double getCm()

Returns:

C_lm^-

getEp

public double getEp()

Returns:

ε_lm⁺

getEm

public double getEm()

Returns:

ε_lm^-

code

public double code()

Get a hashcode for this set.

Returns:

hashcode

computeCode

public static double computeCode(double doodson,
                                 int l,
                                 int m)

Computes code of data set. Assigns a unique Integer to a OceanTidesCoefficientsSet depending on Doodson number, degree and order.

Parameters:

doodson - doodson number

l - degree

m - order

Returns:

code