FGAtmosphere Class Reference

#include <FGAtmosphere.h>

Inherits FGModel.

Inherited by FGMars, and MSIS.

List of all members.


Detailed Description

Author:
Tony Peden, Jon Berndt
Version:
Id
FGAtmosphere.h,v 1.19 2009/02/25 03:28:57 jberndt Exp
See also:
Anderson, John D. "Introduction to Flight, Third Edition", McGraw-Hill, 1989, ISBN 0-07-001641-0

Definition at line 75 of file FGAtmosphere.h.


Public Types

enum  tType { ttStandard, ttBerndt, ttCulp, ttNone }

Public Member Functions

bool External (void)
 Gets the boolean that tells if the external atmosphere model is being used.
 FGAtmosphere (FGFDMExec *)
 Constructor.
double GetAbsoluteViscosity (void) const
 Returns the absolute viscosity.
double GetDeltaT (void) const
 Gets the current delta-T in degrees Fahrenheit.
double GetDensity (double altitude)
 Returns the standard density at a specified altitude.
double GetDensity (void) const
 Returns the density in slugs/ft^3.
double GetDensityAltitude (void) const
 Gets the density altitude in feet.
double GetDensityRatio (void) const
 Returns the ratio of at-altitude density over the sea level value.
double GetDensitySL (void) const
 Returns the sea level density in slugs/ft^3.
FGColumnVector3GetGustNED (void)
 Retrieves the gust components in NED frame.
double GetGustNED (int idx) const
 Retrieves a gust component in NED frame.
double GetKinematicViscosity (void) const
 Returns the kinematic viscosity.
double GetPressure (double altitude)
 Returns the standard pressure at a specified altitude.
double GetPressure (void) const
 Returns the pressure in psf.
double GetPressureRatio (void) const
 Returns the ratio of at-altitude pressure over the sea level value.
double GetPressureSL (void) const
 Returns the sea level pressure in psf.
double GetRhythmicity () const
double GetSLTempDev (void) const
 Gets the temperature deviation at sea-level in degrees Fahrenheit.
double GetSoundSpeed (void) const
 Returns the speed of sound in ft/sec.
double GetSoundSpeedRatio (void) const
 Returns the ratio of at-altitude sound speed over the sea level value.
double GetSoundSpeedSL (void) const
 Returns the sea level speed of sound in ft/sec.
double GetTempDev (void) const
 Gets the at-altitude temperature deviation in degrees Fahrenheit.
double GetTemperature (double altitude)
 Returns the standard temperature at a specified altitude.
double GetTemperature (void) const
 Returns the temperature in degrees Rankine.
double GetTemperatureRatio (void) const
 Returns the ratio of at-altitude temperature over the sea level value.
double GetTemperatureSL (void) const
 Returns the sea level temperature in degrees Rankine.
double GetTotalWindNED (int idx) const
 Retrieves a total wind component in NED frame.
FGColumnVector3GetTotalWindNED (void)
 Retrieves the total wind components in NED frame.
FGColumnVector3GetTurbDirection (void)
double GetTurbGain () const
double GetTurbMagnitude (void) const
FGColumnVector3GetTurbPQR (void)
double GetTurbPQR (int idx) const
double GetTurbRate () const
tType GetTurbType () const
double GetWindNED (int idx) const
 Retrieves a wind component in NED frame.
FGColumnVector3GetWindNED (void)
 Retrieves the wind components in NED frame.
double GetWindPsi (void) const
 Retrieves the direction that the wind is coming from.
double GetWindspeed (void) const
bool InitModel (void)
bool Run (void)
 Runs the Atmosphere model; called by the Executive.
void SetDeltaT (double d)
 Sets the current delta-T in degrees Fahrenheit.
void SetExDensity (double d)
 Provides the external atmosphere model with an interface to set the density.
void SetExPressure (double p)
 Provides the external atmosphere model with an interface to set the pressure.
void SetExTemperature (double t)
 Provides the external atmosphere model with an interface to set the temperature.
void SetGustNED (double gN, double gE, double gD)
 Sets the gust components in NED frame.
void SetGustNED (int idx, double gust)
 Sets a gust component in NED frame.
void SetRhythmicity (double r)
void SetSLTempDev (double d)
 Sets the temperature deviation at sea-level in degrees Fahrenheit.
void SetTurbGain (double tg)
void SetTurbRate (double tr)
void SetTurbType (tType tt)
 Turbulence models available: ttStandard, ttBerndt, ttCulp, ttNone.
void SetWindNED (int idx, double wind)
 Sets a wind component in NED frame.
void SetWindNED (double wN, double wE, double wD)
 Sets the wind components in NED frame.
void SetWindPsi (double dir)
 Sets the direction that the wind is coming from.
void SetWindspeed (double speed)
void UseExternal (void)
 Tells the simulator to use an externally calculated atmosphere model.
void UseInternal (void)
 Tells the simulator to use the internal atmosphere model.
 ~FGAtmosphere ()
 Destructor.

Public Attributes

enum JSBSim::FGAtmosphere::tType turbType

Protected Member Functions

void bind (void)
void Calculate (double altitude)
 Calculate the atmosphere for the given altitude, including effects of temperature deviation.
void CalculateDerived (void)
 Calculate atmospheric properties other than the basic T, P and rho.
void Debug (int from)
void GetStdAtmosphere (double altitude)
 Get T, P and rho for a standard atmosphere at the given altitude.
void Turbulence (void)

Protected Attributes

atmType atmosphere
double Beta
double delta_T
double * density
double density_altitude
double exDensity
double exPressure
double exTemperature
bool first_pass
double h
double htab [8]
double intDensity
double intKinematicViscosity
double intPressure
double intTemperature
double intViscosity
int lastIndex
double Magnitude
double MagnitudeAccel
double MagnitudedAccelDt
double * pressure
double psiw
double rho
double Rhythmicity
double rSLdensity
double rSLpressure
double rSLsoundspeed
double rSLtemperature
double SLdensity
double SLpressure
double SLsoundspeed
double SLtemperature
double soundspeed
double spike
bool StandardTempOnly
double StdSLdensity
double StdSLpressure
double StdSLsoundspeed
double StdSLtemperature
double strength
double SutherlandConstant
double T_dev
double T_dev_sl
double target_time
double * temperature
double TurbGain
double TurbRate
bool useExternal
FGColumnVector3 vBodyTurbGrad
FGColumnVector3 vDirection
FGColumnVector3 vDirectionAccel
FGColumnVector3 vDirectiondAccelDt
FGColumnVector3 vGustNED
FGColumnVector3 vTotalWindNED
FGColumnVector3 vTurbPQR
FGColumnVector3 vTurbulenceGrad
FGColumnVector3 vTurbulenceNED
FGColumnVector3 vWindNED
double wind_from_clockwise

Classes

struct  atmType

Member Function Documentation

double GetDensity ( void   )  const [inline]

This function may only be used if Run() is called first.

Definition at line 92 of file FGAtmosphere.h.

double GetWindPsi ( void   )  const [inline]

The direction is defined as north=0 and increases counterclockwise. The wind heading is returned in radians.

Definition at line 178 of file FGAtmosphere.h.

bool Run ( void   )  [virtual]

Returns:
false if no error

Reimplemented from FGModel.

Definition at line 133 of file FGAtmosphere.cpp.

void SetWindPsi ( double  dir  ) 

The direction is defined as north=0 and increases counterclockwise to 2*pi (radians). The vertical component of wind is assumed to be zero - and is forcibly set to zero. This function sets the vWindNED vector components based on the supplied direction. The magnitude of the wind set in the vector is preserved (assuming the vertical component is non-zero).

Parameters:
dir wind direction in the horizontal plane, in radians.

Definition at line 367 of file FGAtmosphere.cpp.


The documentation for this class was generated from the following files:

Generated on Tue May 26 00:55:09 2009 for JSBSim Flight Dynamics Model by  doxygen 1.5.5