fr.cnes.sirius.patrius.forces.atmospheres

Class SimpleExponentialAtmosphere

java.lang.Object

fr.cnes.sirius.patrius.forces.atmospheres.SimpleExponentialAtmosphere

All Implemented Interfaces:

Atmosphere, Serializable

public class SimpleExponentialAtmosphere
extends Object
implements Atmosphere

Simple exponential atmospheric model.

This model represents a simple atmosphere with an exponential density and rigidly bound to the underlying rotating body.

This class is restricted to be used with EllipsoidBodyShape.

Author:

Fabien Maussion, Luc Maisonobe

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SimpleExponentialAtmosphere(EllipsoidBodyShape shapeIn, double rho0In, double h0In, double hscaleIn) Create an exponential atmosphere.

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	getH0() Getter for the Altitude of reference (m).
double	getHscale() Getter for the Scale factor (m).
double	getRho0() Getter for the Density at the altitude h0.
BodyShape	getShape() Getter for the Body shape model.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleExponentialAtmosphere

public SimpleExponentialAtmosphere(EllipsoidBodyShape shapeIn,
                                   double rho0In,
                                   double h0In,
                                   double hscaleIn)

Create an exponential atmosphere.

Parameters:

shapeIn - body shape model

rho0In - Density at the altitude h0

h0In - Altitude of reference (m)

hscaleIn - Scale factor (m)

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

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)

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)

getShape

public BodyShape getShape()

Getter for the Body shape model.

Returns:

the Body shape model

getRho0

public double getRho0()

Getter for the Density at the altitude h0.

Returns:

the Density at the altitude h0

getH0

public double getH0()

Getter for the Altitude of reference (m).

Returns:

the Altitude of reference (m)

getHscale

public double getHscale()

Getter for the Scale factor (m).

Returns:

the Scale factor (m)

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:

• shape: BodyShape

Specified by:

copy in interface Atmosphere

Returns:

a atmosphere of the detector.

checkSolarActivityData

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