fr.cnes.sirius.patrius.forces.atmospheres

Class DTM2012

java.lang.Object

fr.cnes.sirius.patrius.forces.atmospheres.AbstractDTM

fr.cnes.sirius.patrius.forces.atmospheres.DTM2012

All Implemented Interfaces:

Atmosphere, ExtendedAtmosphere, Serializable

public class DTM2012
extends AbstractDTM

This atmosphere model is the realization of the DTM-2012 model.

This class is restricted to be used with EllipsoidBodyShape.

Since:

4.6

Author:

Williams Zanga

See Also:

Serialized Form

Field Summary

Fields inherited from class fr.cnes.sirius.patrius.forces.atmospheres.AbstractDTM

akp, alat, ALEFA, ATOMIC_NITROGEN, ATOMIC_OXYGEN, az, az2, c2h, c3h, cachedAlti, cachedDay, cachedF, cachedFbar, cachedHl, cachedTemperature, cc, ch, CPMG, daz, daz2, dh, dhe, do2, dox, dt0, dtp, dtt, earth, GSURF, h, he, HELIUM, HYDROGEN, inputParams, MA, MOLECULAR_NITROGEN, MOLECULAR_OXYGEN, o, o2, p10, p10mg, p11, p20, p20mg, p21, p22, p30, p31, p32, p33, p40, p40mg, p41, p42, p50, p51, p52, p60, p62, RE, RGAS, ro, ROT, ROT2, s2h, s3h, sh, SPMG, sun, t0, tinf, tp, tt, VMA, XLMG, xlon, ZLB0

Constructor Summary

Constructors

Constructor and Description
DTM2012(DTMInputParameters parameters, PVCoordinatesProvider sunIn, EllipsoidBodyShape earthIn) Simple constructor with PATRIUS data file.
DTM2012(DTMInputParameters parameters, PVCoordinatesProvider sunIn, EllipsoidBodyShape earthIn, String dataFilename) Constructor with user-provided data file.

Method Summary

Modifier and Type	Method and Description
Atmosphere	copy() A copy of the atmosphere.
protected void	densityComputationFromFortran() This function performs the actual density compuation once the inputs values are saved into the global caches.
protected double	gFunction(double[] a, double[] da, int ff0, int kleEq) Computation of function G.

Methods inherited from class fr.cnes.sirius.patrius.forces.atmospheres.AbstractDTM

checkSolarActivityData, computeGeographicMagneticCoefficients, getData, getDensity, getEarth, getParameters, getSpeedOfSound, getSun, getVelocity, initderivatives, initializeLegendreCoefficients

Methods inherited from class java.lang.Object

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

Constructor Detail

DTM2012

public DTM2012(DTMInputParameters parameters,
               PVCoordinatesProvider sunIn,
               EllipsoidBodyShape earthIn,
               String dataFilename)
        throws PatriusException

Constructor with user-provided data file.

Parameters:

parameters - the solar and magnetic activity data

sunIn - the sun position

earthIn - the earth body shape

dataFilename - data filename

Throws:

PatriusException - if some resource file reading error occurs

DTM2012

public DTM2012(DTMInputParameters parameters,
               PVCoordinatesProvider sunIn,
               EllipsoidBodyShape earthIn)
        throws PatriusException

Simple constructor with PATRIUS data file.

Parameters:

parameters - the solar and magnetic activity data

sunIn - the sun position

earthIn - the earth body shape

Throws:

PatriusException - if some resource file reading error occurs

Method Detail

densityComputationFromFortran

protected void densityComputationFromFortran()

This function performs the actual density compuation once the inputs values are saved into the global caches. This method directly modifies class variables
- ro
- cc
- d
- cachedTemperature
Hence no result is returned

Specified by:

densityComputationFromFortran in class AbstractDTM

gFunction

protected double gFunction(double[] a,
                           double[] da,
                           int ff0,
                           int kleEq)

Computation of function G.

S.Bruisma 06/03/2009 MOD PS 04/2012 : rol calculation of function g(l) for dtm2009 & dtm2012. (Java implementation from the original Fortran routine)

Specified by:

gFunction in class AbstractDTM

Parameters:

a - vector of coefficients for computation

da - vector of partial derivatives

ff0 - coefficient flag (1 for Ox, Az, He, T°; 0 for H and tp120)

kleEq - season indicator flag (summer, winter, equinox)

Returns:

value of G

copy

public Atmosphere copy()

A copy of the atmosphere. By default copy is deep. If not, atmosphere javadoc will specify which attribute is not fully copied. In that case, the attribute reference is passed.

The following attributes are not deeply copied:

• inputParams: DTMInputParameters
• sun: PVCoordinatesProvider
• earth: BodyShape

The following attributes are not deeply copied:

• inputParams: DTMInputParameters
• sun: PVCoordinatesProvider
• earth: BodyShape

Specified by:

copy in interface Atmosphere

Specified by:

copy in class AbstractDTM

Returns:

a atmosphere of the detector.