fr.cnes.sirius.patrius.stela.forces.atmospheres

Class Jacchia77

java.lang.Object

fr.cnes.sirius.patrius.stela.forces.atmospheres.Jacchia77

All Implemented Interfaces:

Atmosphere, Serializable

public class Jacchia77
extends Object
implements Atmosphere

This class implements the Jaccia77 atmospheric model.

This class is restricted to be used with EllipsoidBodyShape.

Since:

4.16

Author:

Thomas Rodrigues, Thibaut BONIT HISTORY VERSION:4.16:OPENFD-389:25/04/2025:[STELA-PATRIUS] Activites solaires additionnelles VERSION:4.16:OPENFD-390:25/04/2025:[STELA-PATRIUS] Modeles d'atmosphere additionnels END-HISTORY

See Also:

Serialized Form

Concurrency :

thread-hostile

Concurrency comment :

This class uses a Jacchia77Data which can read data through a public access (initTempWmMaps()) which is not synchronized (thread lock) at the moment.

Constructor Summary

Constructors

Constructor and Description
Jacchia77(IStelaSolarActivity solarActivity, EllipsoidBodyShape earthBody, PVCoordinatesProvider sun) Simple constructor to build an instance of the class.

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.
JacchiaOutput	getData(AbsoluteDate date, Vector3D position, Frame frame) Getter for the atmospheric model output container.
double	getDensity(AbsoluteDate date, Vector3D position, Frame frame) Getter for the density at the local point.
EllipsoidBodyShape	getEarthBody() Getter for the earth body.
double	getMeanMolarMass(AbsoluteDate date, Vector3D position, Frame frame) Getter for the mean molar mass at the local point.
IStelaSolarActivity	getSolarActivity() Getter for the solar activity.
double	getSpeedOfSound(AbsoluteDate date, Vector3D position, Frame frame) Get the local speed of sound.
PVCoordinatesProvider	getSun() Getter for the sun.
double	getTemperature(AbsoluteDate date, Vector3D position, Frame frame) Getter for the temperature at the local point.
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

Jacchia77

public Jacchia77(IStelaSolarActivity solarActivity,
                 EllipsoidBodyShape earthBody,
                 PVCoordinatesProvider sun)

Simple constructor to build an instance of the class.

Parameters:

solarActivity - Solar activity

earthBody - Earth body

sun - Sun

Method Detail

getData

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

Getter for the atmospheric model output container.

Note: a cache mechanism avoid recomputation of the output container if it should be recomputed a second time with the same inputs.

Parameters:

date - current date

position - current position in frame

frame - the frame in which is defined the position

Returns:

the atmospheric model output container

Throws:

PatriusException - if a Patrius error occurs

getDensity

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

Getter for the density at the local point.

The default behavior of this method is to only compute the density (not the temperature nor the mean molar mass).
Note: a cache mechanism avoid recomputation of this parameter if it should be recomputed a second time with the same inputs.

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:

the local density (kg/m³)

Throws:

PatriusException - if a Patrius error occurs

getTemperature

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

Getter for the temperature at the local point.

The default behavior of this method is to compute the temperature as well as the density and the mean molar mass.
Note: a cache mechanism avoid recomputation of these parameters if they should be recomputed a second time with the same inputs.

Parameters:

date - current date

position - current position in frame

frame - the frame in which is defined the position

Returns:

the temperature (K)

Throws:

PatriusException - if a Patrius error occurs

getMeanMolarMass

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

Getter for the mean molar mass at the local point.

The default behavior of this method is to compute the mean molar mass as well as the density and the temperature.
Note: a cache mechanism avoid recomputation of these parameters if they should be recomputed a second time with the same inputs.

Parameters:

date - current date

position - current position in frame

frame - the frame in which is defined the position

Returns:

the mean molar mass (kg/mol)

Throws:

PatriusException - if a Patrius error occurs

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

getSolarActivity

public IStelaSolarActivity getSolarActivity()

Getter for the solar activity.

Returns:

the solar activity

getEarthBody

public EllipsoidBodyShape getEarthBody()

Getter for the earth body.

Returns:

the earth body

getSun

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

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