fr.cnes.sirius.patrius.forces.atmospheres

Class DTM2000

java.lang.Object

fr.cnes.sirius.patrius.forces.atmospheres.DTM2000

All Implemented Interfaces:

Atmosphere, ExtendedAtmosphere, Serializable

public class DTM2000
extends Object
implements ExtendedAtmosphere

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

NB Since the initial implementation (rev 1665), the model has been modified to fix a bug (see Story V-83 for validation) : the number of days in the year (cachedDay)is a double, instead of an integer. This modification should be integrated in the OREKIT future version.

It is described in the paper:
The DTM-2000 empirical thermosphere model with new data assimilation and constraints at lower boundary: accuracy and properties
S. Bruinsma, G. Thuillier and F. Barlier
Journal of Atmospheric and Solar-Terrestrial Physics 65 (2003) 1053–1070

Two computation methods are proposed to the user:

• one OREKIT independent and compliant with initial FORTRAN routine entry values: getDensity(double, double, double, double, double, double, double, double, double).
• one compliant with OREKIT Atmosphere interface, necessary to the drag force model computation.

This model provides dense output for altitudes beyond 120 km. Computed data are:

• Temperature at altitude z (K)
• Exospheric temperature above input position (K)
• Vertical gradient of T a 120 km
• Total density (kg/m³)
• Mean atomic mass
• Partial densities in (kg/m³) : hydrogen, helium, atomic oxygen, molecular nitrogen, molecular oxygen, atomic nitrogen

The model needs geographical and time information to compute general values, but also needs space weather data : mean and instantaneous solar flux and geomagnetic indices.

Mean solar flux is (for the moment) represented by the F10.7 indices. Instantaneous flux can be set to the mean value if the data is not available. Geomagnetic activity is represented by the Kp indice, which goes from 1 (very low activity) to 9 (high activity).

All these data can be found on the NOAA (National Oceanic and Atmospheric Administration) website.

Mod : Modified line 871, added TimeZone.getTimeZone("GMT+00:00") to get a GregorianCalendar that doesnt depend on the machine locale time zone.

Mod : DTM2000 thread-safety improved : instances in different threads no longer corrupt each others' computations. But sharing one instance between several threads is untested (no realistic use case found).

Author:

R. Biancale, S. Bruinsma: original fortran routine, Fabien Maussion (java translation)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ATOMIC_NITROGEN Identifier for atomic nitrogen.
static int	ATOMIC_OXYGEN Identifier for atomic oxygen.
static int	HELIUM Identifier for helium.
static int	HYDROGEN Identifier for hydrogen.
static int	MOLECULAR_NITROGEN Identifier for molecular nitrogen.
static int	MOLECULAR_OXYGEN Identifier for molecular oxygen.

Constructor Summary

Constructors

Constructor and Description
DTM2000(DTM2000InputParameters parameters, PVCoordinatesProvider sunIn, BodyShape earthIn) Simple constructor for independent computation.

Method Summary

Modifier and Type	Method and Description
Atmosphere	copy() A copy of the atmosphere.
AtmosphereData	getData(AbsoluteDate date, Vector3D position, Frame frame) Get detailed atmospheric data.
double	getDensity(AbsoluteDate date, Vector3D position, Frame frame) Get the local density.
BodyShape	getEarth() Getter for the earth body shape.
DTM2000InputParameters	getParameters() Getter for the solar and magnetic activity data.
double	getSpeedOfSound(AbsoluteDate date, Vector3D position, Frame frame) Get the local speed of sound.
PVCoordinatesProvider	getSun() Getter for the sun position.
Vector3D	getVelocity(AbsoluteDate date, Vector3D position, Frame frame) Get the inertial velocity of atmosphere molecules.

Methods inherited from class java.lang.Object

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

Field Detail

HYDROGEN

public static final int HYDROGEN

Identifier for hydrogen.

See Also:

Constant Field Values

HELIUM

public static final int HELIUM

Identifier for helium.

See Also:

Constant Field Values

ATOMIC_OXYGEN

public static final int ATOMIC_OXYGEN

Identifier for atomic oxygen.

See Also:

Constant Field Values

MOLECULAR_NITROGEN

public static final int MOLECULAR_NITROGEN

Identifier for molecular nitrogen.

See Also:

Constant Field Values

MOLECULAR_OXYGEN

public static final int MOLECULAR_OXYGEN

Identifier for molecular oxygen.

See Also:

Constant Field Values

ATOMIC_NITROGEN

public static final int ATOMIC_NITROGEN

Identifier for atomic nitrogen.

See Also:

Constant Field Values

Constructor Detail

DTM2000

public DTM2000(DTM2000InputParameters parameters,
               PVCoordinatesProvider sunIn,
               BodyShape earthIn)
        throws PatriusException

Simple constructor for independent computation.

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

getDensity

public double getDensity(AbsoluteDate date,
                         Vector3D position,
                         Frame frame)
                  throws PatriusException

Get the local density.

Specified by:

getDensity in interface Atmosphere

Parameters:

date - current date

position - current position in frame

frame - the frame in which is defined the position

Returns:

local density (kg/m³)

Throws:

PatriusException - if date is out of range of solar activity model or if some frame conversion cannot be performed

getVelocity

public Vector3D getVelocity(AbsoluteDate date,
                            Vector3D position,
                            Frame frame)
                     throws PatriusException

Get the inertial velocity of atmosphere molecules. Here the case is simplified : atmosphere is supposed to have a null velocity in earth frame.

Specified by:

getVelocity in interface Atmosphere

Parameters:

date - current date

position - current position in frame

frame - the frame in which is defined the position

Returns:

velocity (m/s) (defined in the same frame as the position)

Throws:

PatriusException - if some frame conversion cannot be performed

getSpeedOfSound

public double getSpeedOfSound(AbsoluteDate date,
                              Vector3D position,
                              Frame frame)
                       throws PatriusException

Get the local speed of sound.

Specified by:

getSpeedOfSound in interface Atmosphere

Parameters:

date - current date

position - current position in frame

frame - the frame in which is defined the position

Returns:

speed of sound (m/s)

Throws:

PatriusException - if some conversion cannot be performed

getData

public AtmosphereData getData(AbsoluteDate date,
                              Vector3D position,
                              Frame frame)
                       throws PatriusException

Get detailed atmospheric data.

DTM2000 provides all data mentioned in AtmosphereData except partial density of Argon and anomalous oxygen.

Specified by:

getData in interface ExtendedAtmosphere

Parameters:

date - current date

position - current position in frame

frame - the frame in which is defined the position

Returns:

detailed atmospheric data

Throws:

PatriusException - if some atmospheric data cannot be retrieved (because date is out of range of solar activity model or if some frame conversion cannot be performed)

getParameters

public DTM2000InputParameters getParameters()

Getter for the solar and magnetic activity data.

Returns:

the solar and magnetic activity data

getSun

public PVCoordinatesProvider getSun()

Getter for the sun position.

Returns:

the the sun position

getEarth

public BodyShape getEarth()

Getter for the earth body shape.

Returns:

the the earth body shape

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: DTM2000InputParameters
• sun: PVCoordinatesProvider
• earth: BodyShape

Specified by:

copy in interface Atmosphere

Returns:

a atmosphere of the detector.