fr.cnes.sirius.patrius.stela.forces.gravity

Class SolidTidesAcc

java.lang.Object

fr.cnes.sirius.patrius.stela.forces.AbstractStelaLagrangeContribution

fr.cnes.sirius.patrius.stela.forces.gravity.SolidTidesAcc

All Implemented Interfaces:

StelaForceModel, Serializable

public class SolidTidesAcc
extends AbstractStelaLagrangeContribution

Class representing the tidal contribution.

Since:

3.2

Version:

$Id$

Author:

Emmanuel Bignon

See Also:

Serialized Form

Concurrency :

conditionally thread-safe

Concurrency comment :

thread safe if the CelestialBody used is thread safe

Field Summary

Fields inherited from class fr.cnes.sirius.patrius.stela.forces.AbstractStelaLagrangeContribution

dPot

Constructor Summary

Constructors

Constructor and Description
SolidTidesAcc(boolean computeSunContributionFlag, boolean computeMoonContributionFlag, CelestialPoint sunBody, CelestialPoint moonBody) Advanced constructor: the user can choose if the sun or the moon contribution has to be deactivated.
SolidTidesAcc(CelestialPoint sunBody, CelestialPoint moonBody) Default constructor: both sun and moon contributions have to be computed.

Method Summary

Modifier and Type	Method and Description
double[][]	computePartialDerivatives(StelaEquinoctialOrbit orbit) Compute the partial derivatives for a given spacecraft state.
double[]	computePerturbation(StelaEquinoctialOrbit orbit) Compute the dE/dt force derivatives for a given spacecraft state.
double[]	computeShortPeriods(StelaEquinoctialOrbit orbit, OrbitNatureConverter converter) Compute the short periodic variations for a given spacecraft state.
CelestialPoint	getMoon() Get the Moon.
CelestialPoint	getSun() Get the Sun.

Methods inherited from class fr.cnes.sirius.patrius.stela.forces.AbstractStelaLagrangeContribution

getdPot, getType

Methods inherited from class java.lang.Object

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

Constructor Detail

SolidTidesAcc

public SolidTidesAcc(CelestialPoint sunBody,
                     CelestialPoint moonBody)

Default constructor: both sun and moon contributions have to be computed.

Parameters:

sunBody - Sun

moonBody - Moon

SolidTidesAcc

public SolidTidesAcc(boolean computeSunContributionFlag,
                     boolean computeMoonContributionFlag,
                     CelestialPoint sunBody,
                     CelestialPoint moonBody)

Advanced constructor: the user can choose if the sun or the moon contribution has to be deactivated.

Parameters:

computeSunContributionFlag - true if sun contribution to be taken into account

computeMoonContributionFlag - true if moon contribution to be taken into account

sunBody - Sun (may be null if Sun contribution is not taken into account)

moonBody - Moon (may be null if Moon contribution is not taken into account)

Method Detail

computePerturbation

public double[] computePerturbation(StelaEquinoctialOrbit orbit)
                             throws PatriusException

Compute the dE/dt force derivatives for a given spacecraft state.

Specified by:

computePerturbation in class AbstractStelaLagrangeContribution

Parameters:

orbit - current orbit information: date, kinematics

Returns:

the perturbation dE/dt for the current force

Throws:

PatriusException - if perturbation computation fails

getSun

public CelestialPoint getSun()

Get the Sun.

Returns:

Sun

getMoon

public CelestialPoint getMoon()

Get the Moon.

Returns:

Moon

computeShortPeriods

public double[] computeShortPeriods(StelaEquinoctialOrbit orbit,
                                    OrbitNatureConverter converter)
                             throws PatriusException

Compute the short periodic variations for a given spacecraft state.

Parameters:

orbit - current orbit information: date, kinematics

converter - converter necessary in some specific case (drag short periods computation)

Returns:

the short periodic variations of the current force

Throws:

PatriusException - if short periods computation fails

computePartialDerivatives

public double[][] computePartialDerivatives(StelaEquinoctialOrbit orbit)
                                     throws PatriusException

Compute the partial derivatives for a given spacecraft state.

Parameters:

orbit - current orbit information: date, kinematics

Returns:

the partial derivatives of the current force

Throws:

PatriusException - if partial derivatives computation fails