fr.cnes.sirius.patrius.forces.atmospheres

Class HarrisPriester

java.lang.Object

fr.cnes.sirius.patrius.forces.atmospheres.HarrisPriester

All Implemented Interfaces:

Atmosphere, Serializable

public class HarrisPriester
extends Object
implements Atmosphere

This atmosphere model is the realization of the Modified Harris-Priester model.

This model is a static one that takes into account the diurnal density bulge. It doesn't need any space weather data but a density vs. altitude table, which depends on solar activity.

The implementation relies on the book:
Satellite Orbits
Oliver Montenbruck, Eberhard Gill
Springer 2005

Author:

Pascal Parraud

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HarrisPriester(PVCoordinatesProvider sunIn, BodyShape earthIn) Simple constructor for Modified Harris-Priester atmosphere model.
HarrisPriester(PVCoordinatesProvider sunIn, BodyShape earthIn, double nIn) Constructor for Modified Harris-Priester atmosphere model.
HarrisPriester(PVCoordinatesProvider sunIn, BodyShape earthIn, double[][] tabAltRhoIn) Constructor for Modified Harris-Priester atmosphere model.
HarrisPriester(PVCoordinatesProvider sunIn, BodyShape earthIn, double[][] tabAltRhoIn, double nIn) Constructor for Modified Harris-Priester atmosphere model.

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	getDensity(double sunRAsc, double sunDecl, Vector3D satPos, double satAlt) Get the local density.
double	getMaxAlt() Get the maximal altitude for the model.
double	getMinAlt() Get the minimal altitude for the model.
double	getSpeedOfSound(AbsoluteDate date, Vector3D position, Frame frame) Get the local speed of sound.
double[][]	getTabDensity() Get the current density table.
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

Constructor Detail

HarrisPriester

public HarrisPriester(PVCoordinatesProvider sunIn,
                      BodyShape earthIn)

Simple constructor for Modified Harris-Priester atmosphere model.

The cosine exponent value is set to 4 by default.

The default embedded density table is the one given in the referenced book from Montenbruck & Gill. It is given for mean solar activity and spreads over 100 to 1000 km.

Parameters:

sunIn - the sun position

earthIn - the earth body shape

HarrisPriester

public HarrisPriester(PVCoordinatesProvider sunIn,
                      BodyShape earthIn,
                      double nIn)

Constructor for Modified Harris-Priester atmosphere model.

Recommanded values for the cosine exponent spread over the range 2, for low inclination orbits, to 6, for polar orbits.

The default embedded density table is the one given in the referenced book from Montenbruck & Gill. It is given for mean solar activity and spreads over 100 to 1000 km.

Parameters:

sunIn - the sun position

earthIn - the earth body shape

nIn - the cosine exponent

HarrisPriester

public HarrisPriester(PVCoordinatesProvider sunIn,
                      BodyShape earthIn,
                      double[][] tabAltRhoIn)

Constructor for Modified Harris-Priester atmosphere model.

The provided density table must be an array such as:

• tabAltRho[][0] = altitude (m)
• tabAltRho[][1] = min density (kg/m³)
• tabAltRho[][2] = max density (kg/m³)

The altitude must be increasing without limitation in range.
The internal density table is a copy of the provided one.

The cosine exponent value is set to 4 by default.

Parameters:

sunIn - the sun position

earthIn - the earth body shape

tabAltRhoIn - the density table

HarrisPriester

public HarrisPriester(PVCoordinatesProvider sunIn,
                      BodyShape earthIn,
                      double[][] tabAltRhoIn,
                      double nIn)

Constructor for Modified Harris-Priester atmosphere model.

Recommanded values for the cosine exponent spread over the range 2, for low inclination orbits, to 6, for polar orbits.

The provided density table must be an array such as:

• tabAltRho[][0] = altitude (m)
• tabAltRho[][1] = min density (kg/m³)
• tabAltRho[][2] = max density (kg/m³)

The altitude must be increasing without limitation in range.
The internal density table is a copy of the provided one.

Parameters:

sunIn - the sun position

earthIn - the earth body shape

tabAltRhoIn - the density table

nIn - the cosine exponent

Method Detail

getTabDensity

public double[][] getTabDensity()

Get the current density table.

The density table is an array such as:

• tabAltRho[][0] = altitude (m)
• tabAltRho[][1] = min density (kg/m³)
• tabAltRho[][2] = max density (kg/m³)

The altitude must be increasing without limitation in range.

The returned density table is a copy of the current one.

Returns:

density vs. altitude table

getMinAlt

public double getMinAlt()

Get the minimal altitude for the model.

No computation is possible below this altitude.

Returns:

the minimal altitude (m)

getMaxAlt

public double getMaxAlt()

Get the maximal altitude for the model.

Above this altitude, density is assumed to be zero.

Returns:

the maximal altitude (m)

getDensity

public double getDensity(double sunRAsc,
                         double sunDecl,
                         Vector3D satPos,
                         double satAlt)
                  throws PatriusException

Get the local density.

Parameters:

sunRAsc - Right Ascension of Sun (radians)

sunDecl - Declination of Sun (radians)

satPos - position of s/c in earth frame(m)

satAlt - height of s/c (m)

Returns:

the local density (kg/m³)

Throws:

PatriusException - if altitude is below the model minimal altitude

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 some frame conversion cannot be performed or if altitude is below the model minimal altitude

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

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:

• 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