AbstractDTM (patrimoine de base SIRIUS 4.11 API)

java.lang.Object
- fr.cnes.sirius.patrius.forces.atmospheres.AbstractDTM

All Implemented Interfaces:

Atmosphere, ExtendedAtmosphere, Serializable

Direct Known Subclasses:

DTM2000, DTM2012
```
public abstract class AbstractDTM
extends Object
implements ExtendedAtmosphere
```
Common class for all DTM atmospheric models.

Since:

4.6

Author:

Williams Zanga

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected double[]`	`akp` Kp coefficients.
`protected double`	`alat` Geodetic Latitude (rad).
`protected static double[]`	`ALEFA` Thermal diffusion coefficient.
`static int`	`ATOMIC_NITROGEN` Identifier for atomic nitrogen.
`static int`	`ATOMIC_OXYGEN` Identifier for atomic oxygen.
`protected double[]`	`az` Elements coefficients.
`protected double[]`	`az2` Elements coefficients.
`protected double`	`c2h` Intermediate values.
`protected double`	`c3h` Intermediate values.
`protected double`	`cachedAlti` Geodetic altitude in km (minimum altitude: 120 km).
`protected double`	`cachedDay` Number of days in current year.
`protected double[]`	`cachedF` Instant solar flux.
`protected double[]`	`cachedFbar` Mean solar flux.
`protected double`	`cachedHl` Local solar time (rad).
`protected double`	`cachedTemperature` Cache mecanism - Temperature at altitude z (K).
`protected double[]`	`cc` Number of particles per cm3.
`protected double`	`ch` Intermediate values.
`protected static double`	`CPMG` Cosine of the latitude of the magnetic pole (79N, 71W).
`protected double[]`	`daz` Partial derivatives.
`protected double[]`	`daz2` Partial derivatives.
`protected double[]`	`dh` Partial derivatives.
`protected double[]`	`dhe` Partial derivatives.
`protected double[]`	`do2` Partial derivatives.
`protected double[]`	`dox` Partial derivatives.
`protected double[]`	`dt0` Partial derivatives.
`protected double[]`	`dtp` Partial derivatives.
`protected double[]`	`dtt` Partial derivatives.
`protected BodyShape`	`earth` Earth body shape.
`protected static double`	`GSURF` Gravity acceleration at 120 km altitude.
`protected double[]`	`h` Elements coefficients.
`protected double[]`	`he` Elements coefficients.
`static int`	`HELIUM` Identifier for helium.
`static int`	`HYDROGEN` Identifier for hydrogen.
`protected DTMInputParameters`	`inputParams` External data container.
`protected static double[]`	`MA` Atomic mass H, He, O, N2, O2, N.
`static int`	`MOLECULAR_NITROGEN` Identifier for molecular nitrogen.
`static int`	`MOLECULAR_OXYGEN` Identifier for molecular oxygen.
`protected double[]`	`o` Elements coefficients.
`protected double[]`	`o2` Elements coefficients.
`protected double`	`p10` Legendre coefficient.
`protected double`	`p10mg` Legendre coefficient.
`protected double`	`p11` Legendre coefficient.
`protected double`	`p20` Legendre coefficient.
`protected double`	`p20mg` Legendre coefficient.
`protected double`	`p21` Legendre coefficient.
`protected double`	`p22` Legendre coefficient.
`protected double`	`p30` Legendre coefficient.
`protected double`	`p31` Legendre coefficient.
`protected double`	`p32` Legendre coefficient.
`protected double`	`p33` Legendre coefficient.
`protected double`	`p40` Legendre coefficient.
`protected double`	`p40mg` Legendre coefficient.
`protected double`	`p41` Legendre coefficient.
`protected double`	`p42` Legendre coefficient.
`protected double`	`p50` Legendre coefficient.
`protected double`	`p51` Legendre coefficient.
`protected double`	`p52` Legendre coefficient.
`protected double`	`p60` Legendre coefficient.
`protected double`	`p62` Legendre coefficient.
`protected static double`	`RE` Polar Earth radius.
`protected static double`	`RGAS` Universal gas constant.
`protected double`	`ro` Total density (g/cm3).
`protected static double`	`ROT` 2 * π / 365.
`protected static double`	`ROT2` 2 * rot.
`protected double`	`s2h` Intermediate values.
`protected double`	`s3h` Intermediate values.
`protected double`	`sh` Intermediate values.
`protected static double`	`SPMG` Sine of the latitude of the magnetic pole (79N, 71W).
`protected PVCoordinatesProvider`	`sun` Sun position.
`protected double[]`	`t0` Elements coefficients.
`protected double`	`tinf` Exospheric temperature.
`protected double[]`	`tp` Elements coefficients.
`protected double[]`	`tt` Elements coefficients.
`protected static double[]`	`VMA` Atomic mass H, He, O, N2, O2, N.
`protected static double`	`XLMG` Longitude (in radians) of the magnetic pole (79N, 71W).
`protected double`	`xlon` Geodetic longitude (rad).
`protected static double`	`ZLB0` Reference altitude.

Constructor Summary

Constructors
Constructor and Description
`AbstractDTM(DTMInputParameters parameters, PVCoordinatesProvider sunIn, BodyShape earthIn, String dataFile)` Simple constructor for independent computation.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkSolarActivityData(AbsoluteDate start, AbsoluteDate end)` This methods throws an exception if the user did not provide solar activity on the provided interval [start, end].
`protected void`	`computeGeographicMagneticCoefficients()` Compute Legendre polynomials coefficients with respect to geographic and magnetic poles
`abstract Atmosphere`	`copy()` A copy of the atmosphere.
`protected abstract void`	`densityComputationFromFortran()` This function performs the actual density compuation once the inputs values are saved into the global caches.
`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.
`DTMInputParameters`	`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.
`protected abstract double`	`gFunction(double[] a, double[] da, int ff0, int kleEq)` Computation of function G.
`protected void`	`initderivatives()` Initialize the partial derivative arrays.
`protected void`	`initializeLegendreCoefficients(double c, double s)` compute Legendre polynomials wrt geographic pole

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
  - ALEFA
```
protected static final double[] ALEFA
```
    Thermal diffusion coefficient.
  - MA
```
protected static final double[] MA
```
    Atomic mass H, He, O, N2, O2, N.
  - VMA
```
protected static final double[] VMA
```
    Atomic mass H, He, O, N2, O2, N.
  - RE
```
protected static final double RE
```
    Polar Earth radius.
    
    See Also:
    
    Constant Field Values
  - ZLB0
```
protected static final double ZLB0
```
    Reference altitude.
    
    See Also:
    
    Constant Field Values
  - CPMG
```
protected static final double CPMG
```
    Cosine of the latitude of the magnetic pole (79N, 71W).
    
    See Also:
    
    Constant Field Values
  - SPMG
```
protected static final double SPMG
```
    Sine of the latitude of the magnetic pole (79N, 71W).
    
    See Also:
    
    Constant Field Values
  - XLMG
```
protected static final double XLMG
```
    Longitude (in radians) of the magnetic pole (79N, 71W).
    
    See Also:
    
    Constant Field Values
  - GSURF
```
protected static final double GSURF
```
    Gravity acceleration at 120 km altitude.
    
    See Also:
    
    Constant Field Values
  - RGAS
```
protected static final double RGAS
```
    Universal gas constant.
    
    See Also:
    
    Constant Field Values
  - ROT
```
protected static final double ROT
```
    2 * π / 365.
    
    See Also:
    
    Constant Field Values
  - ROT2
```
protected static final double ROT2
```
    2 * rot.
    
    See Also:
    
    Constant Field Values
  - tt
```
protected double[] tt
```
    Elements coefficients.
  - h
```
protected double[] h
```
    Elements coefficients.
  - he
```
protected double[] he
```
    Elements coefficients.
  - o
```
protected double[] o
```
    Elements coefficients.
  - az2
```
protected double[] az2
```
    Elements coefficients.
  - o2
```
protected double[] o2
```
    Elements coefficients.
  - az
```
protected double[] az
```
    Elements coefficients.
  - t0
```
protected double[] t0
```
    Elements coefficients.
  - tp
```
protected double[] tp
```
    Elements coefficients.
  - dtt
```
protected double[] dtt
```
    Partial derivatives.
  - dh
```
protected double[] dh
```
    Partial derivatives.
  - dhe
```
protected double[] dhe
```
    Partial derivatives.
  - dox
```
protected double[] dox
```
    Partial derivatives.
  - daz2
```
protected double[] daz2
```
    Partial derivatives.
  - do2
```
protected double[] do2
```
    Partial derivatives.
  - daz
```
protected double[] daz
```
    Partial derivatives.
  - dt0
```
protected double[] dt0
```
    Partial derivatives.
  - dtp
```
protected double[] dtp
```
    Partial derivatives.
  - cachedDay
```
protected double cachedDay
```
    Number of days in current year.
  - cachedF
```
protected final double[] cachedF
```
    Instant solar flux. f[1] = instantaneous flux; f[2] = 0. (not used).
  - cachedFbar
```
protected final double[] cachedFbar
```
    Mean solar flux. fbar[1] = mean flux; fbar[2] = 0. (not used).
  - akp
```
protected final double[] akp
```
    Kp coefficients.
    - akp[1] = 3-hourly kp
    - akp[2] = 0 (not used)
    - akp[3] = mean kp of last 24 hours
    - akp[4] = 0 (not used)
  - cachedAlti
```
protected double cachedAlti
```
    Geodetic altitude in km (minimum altitude: 120 km).
  - cachedHl
```
protected double cachedHl
```
    Local solar time (rad).
  - alat
```
protected double alat
```
    Geodetic Latitude (rad).
  - xlon
```
protected double xlon
```
    Geodetic longitude (rad).
  - cachedTemperature
```
protected volatile double cachedTemperature
```
    Cache mecanism - Temperature at altitude z (K).
  - tinf
```
protected volatile double tinf
```
    Exospheric temperature.
  - ro
```
protected double ro
```
    Total density (g/cm3).
  - cc
```
protected final double[] cc
```
    Number of particles per cm3. cc(1) = hydrogen cc(2) = helium cc(3) = atomic oxygen cc(4) = molecular nitrogen cc(5) = molecular oxygen cc(6) = atomic nitrogen
  - p10
```
protected double p10
```
    Legendre coefficient.
  - p20
```
protected double p20
```
    Legendre coefficient.
  - p30
```
protected double p30
```
    Legendre coefficient.
  - p40
```
protected double p40
```
    Legendre coefficient.
  - p50
```
protected double p50
```
    Legendre coefficient.
  - p60
```
protected double p60
```
    Legendre coefficient.
  - p11
```
protected double p11
```
    Legendre coefficient.
  - p21
```
protected double p21
```
    Legendre coefficient.
  - p31
```
protected double p31
```
    Legendre coefficient.
  - p41
```
protected double p41
```
    Legendre coefficient.
  - p51
```
protected double p51
```
    Legendre coefficient.
  - p22
```
protected double p22
```
    Legendre coefficient.
  - p32
```
protected double p32
```
    Legendre coefficient.
  - p42
```
protected double p42
```
    Legendre coefficient.
  - p52
```
protected double p52
```
    Legendre coefficient.
  - p62
```
protected double p62
```
    Legendre coefficient.
  - p33
```
protected double p33
```
    Legendre coefficient.
  - p10mg
```
protected double p10mg
```
    Legendre coefficient.
  - p20mg
```
protected double p20mg
```
    Legendre coefficient.
  - p40mg
```
protected double p40mg
```
    Legendre coefficient.
  - ch
```
protected double ch
```
    Intermediate values.
  - sh
```
protected double sh
```
    Intermediate values.
  - c2h
```
protected double c2h
```
    Intermediate values.
  - s2h
```
protected double s2h
```
    Intermediate values.
  - c3h
```
protected double c3h
```
    Intermediate values.
  - s3h
```
protected double s3h
```
    Intermediate values.
  - sun
```
protected final PVCoordinatesProvider sun
```
    Sun position.
  - inputParams
```
protected final DTMInputParameters inputParams
```
    External data container.
  - earth
```
protected final BodyShape earth
```
    Earth body shape.
- Constructor Detail
  - AbstractDTM
```
public AbstractDTM(DTMInputParameters parameters,
                   PVCoordinatesProvider sunIn,
                   BodyShape earthIn,
                   String dataFile)
            throws PatriusException
```
    Simple constructor for independent computation.
    
    Parameters:
    
    parameters - the solar and magnetic activity data
    
    sunIn - the sun position
    
    earthIn - the earth body shape
    
    dataFile - the path to the file that contains the data of the model
    
    Throws:
    
    PatriusException - if some resource file reading error occurs
- Method Detail
  - initderivatives
```
protected void initderivatives()
```
    Initialize the partial derivative arrays.
  - initializeLegendreCoefficients
```
protected void initializeLegendreCoefficients(double c,
                                              double s)
```
    compute Legendre polynomials wrt geographic pole
    
    Parameters:
    
    c - sinus latitude
    
    s - cosinus latitude
  - computeGeographicMagneticCoefficients
```
protected void computeGeographicMagneticCoefficients()
```
    Compute Legendre polynomials coefficients with respect to geographic and magnetic poles
  - 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
  - densityComputationFromFortran
```
protected abstract 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
  - gFunction
```
protected abstract double gFunction(double[] a,
                                    double[] da,
                                    int ff0,
                                    int kleEq)
```
    Computation of function G.
    
    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
  - 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.
    DTM 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 DTMInputParameters 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 abstract 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
    Specified by:
    
    copy in interface Atmosphere
    
    Returns:
    
    a atmosphere of the detector.
  - checkSolarActivityData
```
public void checkSolarActivityData(AbsoluteDate start,
                                   AbsoluteDate end)
                            throws PatriusException
```
    This methods throws an exception if the user did not provide solar activity on the provided interval [start, end]. All models should implement their own method since the required data interval depends on the model.
    
    Specified by:
    
    checkSolarActivityData in interface Atmosphere
    
    Parameters:
    
    start - range start date
    
    end - range end date
    
    Throws:
    
    PatriusException - thrown if some solar activity data is missing

Class AbstractDTM

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HYDROGEN

HELIUM

ATOMIC_OXYGEN

MOLECULAR_NITROGEN

MOLECULAR_OXYGEN

ATOMIC_NITROGEN

ALEFA

MA

VMA

RE

ZLB0

CPMG

SPMG

XLMG

GSURF

RGAS

ROT

ROT2

tt

h

he

o

az2

o2

az

t0

tp

dtt

dh

dhe

dox

daz2

do2

daz

dt0

dtp

cachedDay

cachedF

cachedFbar

akp

cachedAlti

cachedHl

alat

xlon

cachedTemperature

tinf

ro

cc

p10

p20

p30

p40

p50

p60

p11

p21

p31

p41

p51

p22

p32

p42

p52

p62

p33

p10mg

p20mg

p40mg

ch

sh

c2h

s2h

c3h

s3h