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

Class VariablePotentialCoefficientsSet

java.lang.Object

fr.cnes.sirius.patrius.forces.gravity.variations.coefficients.VariablePotentialCoefficientsSet

All Implemented Interfaces:

Serializable

public class VariablePotentialCoefficientsSet
extends Object
implements Serializable

Represents a variable potential coefficients set for a given degree and order.

Since:

1.3

Version:

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

Author:

Rami Houdroge

See Also:

http://grgs.obs-mip.fr/grace/variable-models-grace-lageos/formats}, Serialized Form

Concurrency :

immutable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VariablePotentialCoefficientsSet.PeriodicComputationMethod Enum designating the method to compute the phase of the periodic functions

Constructor Summary

Constructors

Constructor and Description
VariablePotentialCoefficientsSet(int degree, int order, double c, double s, double[] cc, double[] sc) Create a set for a given order and degree
VariablePotentialCoefficientsSet(int degree, int order, double c, double cDrift, double cS1A, double cC1A, double cS2A, double cC2A, double s, double sDrift, double sS1A, double sC1A, double sS2A, double sC2A) Create a set for a given order and degree

Method Summary

Modifier and Type	Method and Description
double	computeCDriftComponent(double driftFunction) Compute the normalized drift component of the C coefficient
double	computeCPeriodicComponent(double sin2Pi, double cos2Pi, double sin4Pi, double cos4Pi) Compute the normalized periodic component of the C coefficient
static double	computeDriftFunction(AbsoluteDate date, AbsoluteDate refDate) Compute drift function to provide to #computeCDriftComponent or #computeSDriftComponent
static double[]	computePeriodicFunctions(AbsoluteDate date) Compute periodic functions to provide to #computeCPeriodicComponent or #computeSPeriodicComponent
double	computeSDriftComponent(double driftFunction) Compute the normalized drift component of the S coefficient
double	computeSPeriodicComponent(double sin2Pi, double cos2Pi, double sin4Pi, double cos4Pi) Compute the normalized periodic component of the S coefficient
double	getCoefC() Getter for normalized coefC
double	getCoefCCos1A() Getter for normalized coefCCos1A
double	getCoefCCos2A() Getter for normalized coefCCos2A
double	getCoefCDrift() Getter for normalized coefCDrift
double	getCoefCSin1A() Getter for normalized coefCSin1A
double	getCoefCSin2A() Getter for normalized coefCSin2A
double	getCoefS() Getter for normalized coefS
double	getCoefSCos1A() Getter for normalized coefSCos1A
double	getCoefSCos2A() Getter for normalized coefSCos2A
double	getCoefSDrift() Getter for normalized coefSDrift
double	getCoefSSin1A() Getter for normalized coefSSin1A
double	getCoefSSin2A() Getter for normalized coefSSin2A
int	getDegree()
int	getOrder()
static VariablePotentialCoefficientsSet.PeriodicComputationMethod	getPeriodicComputationMethod() Getter for periodicComputationMethod
static void	setPeriodicComputationMethod(VariablePotentialCoefficientsSet.PeriodicComputationMethod periodicComputationMethod) Setter for periodicComputationMethod

Methods inherited from class java.lang.Object

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

Constructor Detail

VariablePotentialCoefficientsSet

public VariablePotentialCoefficientsSet(int degree,
                                        int order,
                                        double c,
                                        double s,
                                        double[] cc,
                                        double[] sc)

Create a set for a given order and degree

Parameters:

degree - degree of set

order - order of set

c - C correction parameters

s - S correction parameters

cc - c coefficient corrections {DOT, S1A, C1A, S2A, C2A}

sc - s coefficient corrections {DOT, S1A, C1A, S2A, C2A}

VariablePotentialCoefficientsSet

public VariablePotentialCoefficientsSet(int degree,
                                        int order,
                                        double c,
                                        double cDrift,
                                        double cS1A,
                                        double cC1A,
                                        double cS2A,
                                        double cC2A,
                                        double s,
                                        double sDrift,
                                        double sS1A,
                                        double sC1A,
                                        double sS2A,
                                        double sC2A)

Create a set for a given order and degree

Parameters:

degree - degree of set

order - order of set

c - normalized c coefficient

cDrift - C_DRIFT

cS1A - sinus 1A c coefficient

cC1A - cosinus 1A c coefficient

cS2A - sinus 2A c coefficient

cC2A - cosinus 2A c coefficient

s - normalized s coefficient

sDrift - S_DRIFT

sS1A - sinus 1A s coefficient

sC1A - cosinus 1A s coefficient

sS2A - sinus 2A s coefficient

sC2A - cosinus 2A s coefficient

Method Detail

getDegree

public int getDegree()

Returns:

the degree of the set

getOrder

public int getOrder()

Returns:

the order of the set

getCoefC

public double getCoefC()

Getter for normalized coefC

Returns:

the coefC

getCoefCDrift

public double getCoefCDrift()

Getter for normalized coefCDrift

Returns:

the coefCDrift

getCoefCSin1A

public double getCoefCSin1A()

Getter for normalized coefCSin1A

Returns:

the coefCSin1A

getCoefCCos1A

public double getCoefCCos1A()

Getter for normalized coefCCos1A

Returns:

the coefCCos1A

getCoefCSin2A

public double getCoefCSin2A()

Getter for normalized coefCSin2A

Returns:

the coefCSin2A

getCoefCCos2A

public double getCoefCCos2A()

Getter for normalized coefCCos2A

Returns:

the coefCCos2A

getCoefS

public double getCoefS()

Getter for normalized coefS

Returns:

the coefS

getCoefSDrift

public double getCoefSDrift()

Getter for normalized coefSDrift

Returns:

the coefSDrift

getCoefSSin1A

public double getCoefSSin1A()

Getter for normalized coefSSin1A

Returns:

the coefSSin1A

getCoefSCos1A

public double getCoefSCos1A()

Getter for normalized coefSCos1A

Returns:

the coefSCos1A

getCoefSSin2A

public double getCoefSSin2A()

Getter for normalized coefSSin2A

Returns:

the coefSSin2A

getCoefSCos2A

public double getCoefSCos2A()

Getter for normalized coefSCos2A

Returns:

the coefSCos2A

computeCDriftComponent

public double computeCDriftComponent(double driftFunction)

Compute the normalized drift component of the C coefficient

Parameters:

driftFunction - between two dates value

Returns:

double C drift component

computeSDriftComponent

public double computeSDriftComponent(double driftFunction)

Compute the normalized drift component of the S coefficient

Parameters:

driftFunction - between two dates value

Returns:

double S drift component

computeCPeriodicComponent

public double computeCPeriodicComponent(double sin2Pi,
                                        double cos2Pi,
                                        double sin4Pi,
                                        double cos4Pi)

Compute the normalized periodic component of the C coefficient

Parameters:

sin2Pi - sinus(2*pi*time) component

cos2Pi - cosinus(2*pi*time) component

sin4Pi - sinus(4*pi*time) component

cos4Pi - cosinus(4*pi*time) component

Returns:

double C periodic component

computeSPeriodicComponent

public double computeSPeriodicComponent(double sin2Pi,
                                        double cos2Pi,
                                        double sin4Pi,
                                        double cos4Pi)

Compute the normalized periodic component of the S coefficient

Parameters:

sin2Pi - sinus(2*pi*time) component

cos2Pi - cosinus(2*pi*time) component

sin4Pi - sinus(4*pi*time) component

cos4Pi - cosinus(4*pi*time) component

Returns:

double S periodic component

computeDriftFunction

public static double computeDriftFunction(AbsoluteDate date,
                                          AbsoluteDate refDate)

Compute drift function to provide to #computeCDriftComponent or #computeSDriftComponent

Parameters:

date - final date

refDate - starting date

Returns:

double drift function

computePeriodicFunctions

public static double[] computePeriodicFunctions(AbsoluteDate date)

Compute periodic functions to provide to #computeCPeriodicComponent or #computeSPeriodicComponent

Parameters:

date - choosen date

Returns:

double[] Values of sin2Pi, cos2Pi, sin4Pi, cos4Pi for the provided date

getPeriodicComputationMethod

public static VariablePotentialCoefficientsSet.PeriodicComputationMethod getPeriodicComputationMethod()

Getter for periodicComputationMethod

Returns:

the periodicComputationMethod

setPeriodicComputationMethod

public static void setPeriodicComputationMethod(VariablePotentialCoefficientsSet.PeriodicComputationMethod periodicComputationMethod)

Setter for periodicComputationMethod

Parameters:

periodicComputationMethod - the periodicComputationMethod to set