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

Class PoleTides

java.lang.Object

fr.cnes.sirius.patrius.math.parameter.Parameterizable

fr.cnes.sirius.patrius.math.parameter.JacobiansParameterizable

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

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

All Implemented Interfaces:

ForceModel, GradientModel, PotentialTimeVariations, IJacobiansParameterizable, IParameterizable, Serializable

public class PoleTides
extends AbstractTides

This class implements the perturbating force due to pole tides. Pole tide is the deformation of the Earth due to the movement of its rotation axis. Polar tides directly depends on Earth pole position (xp, yp) and have two contributors:

• Solid Earth pole tides
• Earth ocean pole tides

It is possible to activate/deactivate each of these contributors through flags at construction.

Since:

4.6

Author:

Emmanuel Bignon

See Also:

Serialized Form

Field Summary

Fields inherited from class fr.cnes.sirius.patrius.forces.gravity.tides.AbstractTides

bodyFrame, coefficientsC, coefficientsCPD, coefficientsS, coefficientsSPD, MU, paramAe, paramMu, RADIUS

Constructor Summary

Constructors

Constructor and Description
PoleTides(Frame centralBodyFrame, double equatorialRadius, double mu, boolean solidTidesFlag, boolean oceanicTidesFlag) Constructor.
PoleTides(Frame centralBodyFrame, double equatorialRadius, double mu, boolean solidTidesFlag, boolean oceanicTidesFlag, boolean computePD) Constructor.
PoleTides(Frame centralBodyFrame, Parameter equatorialRadius, Parameter mu, boolean solidTidesFlag, boolean oceanicTidesFlag) Constructor.
PoleTides(Frame centralBodyFrame, Parameter equatorialRadius, Parameter mu, boolean solidTidesFlag, boolean oceanicTidesFlag, boolean computePD) Constructor.

Method Summary

Modifier and Type	Method and Description
void	checkData(AbsoluteDate start, AbsoluteDate end) This methods throws an exception if the user did not provide all the required data to perform model call on provided range [start; end].
boolean	computeGradientPosition() This method returns true if the acceleration partial derivatives with respect to position have to be computed.
void	updateCoefficientsCandS(AbsoluteDate date) Update the C and the S coefficients for acceleration computation.
void	updateCoefficientsCandSPD(AbsoluteDate date) Update the C and the S coefficients for partial derivatives computation.

Methods inherited from class fr.cnes.sirius.patrius.forces.gravity.tides.AbstractTides

addContribution, addDAccDParam, addDAccDState, computeAcceleration, computeAcceleration, computeGradientVelocity, getEventsDetectors

Methods inherited from class fr.cnes.sirius.patrius.math.parameter.JacobiansParameterizable

addJacobiansParameter, addJacobiansParameter, addJacobiansParameter, supportsJacobianParameter

Methods inherited from class fr.cnes.sirius.patrius.math.parameter.Parameterizable

addAllParameters, addAllParameters, addParameter, getParameters, supportsParameter

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.sirius.patrius.math.parameter.IParameterizable

getParameters, supportsParameter

Constructor Detail

PoleTides

public PoleTides(Frame centralBodyFrame,
                 double equatorialRadius,
                 double mu,
                 boolean solidTidesFlag,
                 boolean oceanicTidesFlag)

Constructor.

Parameters:

centralBodyFrame - rotating body frame

equatorialRadius - reference equatorial radius of the potential

mu - central body attraction coefficient (m³/s²)

solidTidesFlag - true if solid Earth pole tides contribution should be taken into account

oceanicTidesFlag - true if ocean pole tides contribution should be taken into account

PoleTides

public PoleTides(Frame centralBodyFrame,
                 double equatorialRadius,
                 double mu,
                 boolean solidTidesFlag,
                 boolean oceanicTidesFlag,
                 boolean computePD)

Constructor.

Parameters:

centralBodyFrame - rotating body frame

equatorialRadius - reference equatorial radius of the potential

mu - central body attraction coefficient (m³/s²)

solidTidesFlag - true if solid Earth pole tides contribution should be taken into account

oceanicTidesFlag - true if ocean pole tides contribution should be taken into account

computePD - true if partial derivatives wrt position have to be computed

PoleTides

public PoleTides(Frame centralBodyFrame,
                 Parameter equatorialRadius,
                 Parameter mu,
                 boolean solidTidesFlag,
                 boolean oceanicTidesFlag)

Constructor.

Parameters:

centralBodyFrame - rotating body frame

equatorialRadius - reference equatorial radius of the potential parameter

mu - central body attraction coefficient (m³/s²) parameter

solidTidesFlag - true if solid Earth pole tides contribution should be taken into account

oceanicTidesFlag - true if ocean pole tides contribution should be taken into account

PoleTides

public PoleTides(Frame centralBodyFrame,
                 Parameter equatorialRadius,
                 Parameter mu,
                 boolean solidTidesFlag,
                 boolean oceanicTidesFlag,
                 boolean computePD)

Constructor.

Parameters:

centralBodyFrame - rotating body frame

equatorialRadius - reference equatorial radius of the potential parameter

mu - central body attraction coefficient (m³/s²) parameter

solidTidesFlag - true if solid Earth pole tides contribution should be taken into account

oceanicTidesFlag - true if ocean pole tides contribution should be taken into account

computePD - true if partial derivatives have to be computed

Method Detail

updateCoefficientsCandS

public void updateCoefficientsCandS(AbsoluteDate date)
                             throws PatriusException

Update the C and the S coefficients for acceleration computation.

Specified by:

updateCoefficientsCandS in interface PotentialTimeVariations

Specified by:

updateCoefficientsCandS in class AbstractTides

Parameters:

date - : date

Throws:

PatriusException - if position cannot be computed in given frame

updateCoefficientsCandSPD

public void updateCoefficientsCandSPD(AbsoluteDate date)
                               throws PatriusException

Update the C and the S coefficients for partial derivatives computation.

Specified by:

updateCoefficientsCandSPD in interface PotentialTimeVariations

Specified by:

updateCoefficientsCandSPD in class AbstractTides

Parameters:

date - : date

Throws:

PatriusException - if position cannot be computed in given frame

computeGradientPosition

public boolean computeGradientPosition()

This method returns true if the acceleration partial derivatives with respect to position have to be computed.

Returns:

true if the derivatives have to be computed, false otherwise

checkData

public void checkData(AbsoluteDate start,
                      AbsoluteDate end)
               throws PatriusException

This methods throws an exception if the user did not provide all the required data to perform model call on provided range [start; end]. It is the responsibility of the model implementation to properly throw exceptions (for example DragForce will throw an exception if solar activity data is missing in the range [start, end]).

Parameters:

start - range start date

end - range end date

Throws:

PatriusException - thrown if some data is missing