fr.cnes.sirius.patrius.forces.atmospheres

Interface Atmosphere

All Superinterfaces:

Serializable

All Known Subinterfaces:

ExtendedAtmosphere

All Known Implementing Classes:

AbstractDTM, DTM2000, DTM2012, HarrisPriester, JB2006, MSIS00Adapter, MSISE2000, SimpleExponentialAtmosphere, US76

public interface Atmosphere
extends Serializable

Interface for atmospheric models.

Author:

Luc Maisonobe

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.
double	getDensity(AbsoluteDate date, Vector3D position, Frame frame) Get the local density.
double	getSpeedOfSound(AbsoluteDate date, Vector3D position, Frame frame) Get the local speed of sound.
Vector3D	getVelocity(AbsoluteDate date, Vector3D position, Frame frame) Get the spacecraft velocity relative to the atmosphere.

Method Detail

getDensity

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

Get the local density.

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

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

Get the spacecraft velocity relative to the 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

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

Get the local speed of sound.

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

copy

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.

Returns:

a atmosphere of the detector.

checkSolarActivityData

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.

Parameters:

start - range start date

end - range end date

Throws:

PatriusException - thrown if some solar activity data is missing