fr.cnes.sirius.patrius.forces.atmospheres

Class MSISE2000

java.lang.Object

fr.cnes.sirius.patrius.forces.atmospheres.MSISE2000

All Implemented Interfaces:

Atmosphere, ExtendedAtmosphere, Serializable

public class MSISE2000
extends Object
implements ExtendedAtmosphere

This class implements the MSIS00 atmospheric model.
It is an interface layer between the NRLMSISE00 class - adapted from Fortran - and the SIRIUS data structures.

Warning: this model is not continuous. There is a discontinuity every day (at 0h in UTC time scale). Discontinuities are however very small (1E-3 on a relative scale).

This class is restricted to be used with EllipsoidBodyShape.

Since:

1.2

Version:

$Id: MSISE2000.java 17794 2017-09-01 07:15:56Z bignon $

Author:

Vincent Ruch, Rami Houdroge

See Also:

Serialized Form

Concurrency :

thread-hostile

Concurrency comment :

The direct use of thread hostile objects makes this class thread hostile itself.

Constructor Summary

Constructors

Constructor and Description
MSISE2000(MSISE2000InputParameters data, EllipsoidBodyShape earthBody, CelestialPoint sun) Simple constructor for class MSIS00Adapter.

Method Summary

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].
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	getEarthBody() Getter for the earth body.
MSISE2000InputParameters	getParameters() Getter for the solar parameters.
double	getPressure(AbsoluteDate date, Vector3D position, Frame frame) Getter for the pressure.
double	getSpeedOfSound(AbsoluteDate date, Vector3D position, Frame frame) Get the local speed of sound.
CelestialPoint	getSun() Getter for the Sun.
Vector3D	getVelocity(AbsoluteDate date, Vector3D position, Frame frame) Get the spacecraft velocity relative to the atmosphere.

Methods inherited from class java.lang.Object

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

Constructor Detail

MSISE2000

public MSISE2000(MSISE2000InputParameters data,
                 EllipsoidBodyShape earthBody,
                 CelestialPoint sun)

Simple constructor for class MSIS00Adapter.

Parameters:

data - solar data

earthBody - earth body

sun - the sun

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

getPressure

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

Getter for the pressure.

Parameters:

date - date

position - position

frame - frame

Returns:

pressure at date

Throws:

PatriusException - if pressure could not be computed

getVelocity

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

Get the spacecraft velocity relative to the atmosphere.

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 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.

MSISE2000 provides all data mentioned in AtmosphereData.

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 MSISE2000InputParameters getParameters()

Getter for the solar parameters.

Returns:

the solar parameters

getEarthBody

public BodyShape getEarthBody()

Getter for the earth body.

Returns:

the earth body

getSun

public CelestialPoint getSun()

Getter for the Sun.

Returns:

the Sun

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: MSISE2000InputParameters
• 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