src/FDM/JSBSim/FGAtmosphere.h

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Header:       FGAtmosphere.h
   4  Author:       Jon Berndt
   5                Implementation of 1959 Standard Atmosphere added by Tony Peden
   6  Date started: 11/24/98
   7
   8  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
   9
  10  This program is free software; you can redistribute it and/or modify it under
  11  the terms of the GNU General Public License as published by the Free Software
  12  Foundation; either version 2 of the License, or (at your option) any later
  13  version.
  14
  15  This program is distributed in the hope that it will be useful, but WITHOUT
  16  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  18  details.
  19
  20  You should have received a copy of the GNU General Public License along with
  21  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  22  Place - Suite 330, Boston, MA  02111-1307, USA.
  23
  24  Further information about the GNU General Public License can also be found on
  25  the world wide web at http://www.gnu.org.
  26
  27 HISTORY
  28 --------------------------------------------------------------------------------
  29 11/24/98   JSB   Created
  30 07/23/99   TP    Added implementation of 1959 Standard Atmosphere
  31                  Moved calculation of Mach number to FGPropagate
  32                  Updated to '76 model
  33
  34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  35 SENTRY
  36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  37
  38 #ifndef FGAtmosphere_H
  39 #define FGAtmosphere_H
  40
  41 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  42 INCLUDES
  43 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  44
  45 #include "FGModel.h"
  46 #include "FGColumnVector3.h"
  47
  48 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  49 DEFINITIONS
  50 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  51
  52 #define ID_ATMOSPHERE "$Id$"
  53
  54 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  55 FORWARD DECLARATIONS
  56 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  57
  58 namespace JSBSim {
  59
  60 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  61 CLASS DOCUMENTATION
  62 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  63
  64 /** Models the standard atmosphere.
  65     @author Tony Peden, Jon Berndt
  66     @version $Id$
  67     @see Anderson, John D. "Introduction to Flight, Third Edition", McGraw-Hill,
  68          1989, ISBN 0-07-001641-0
  69 */
  70
  71 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  72 CLASS DECLARATION
  73 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  74
  75 class FGAtmosphere : public FGModel {
  76 public:
  77
  78   /// Constructor
  79   FGAtmosphere(FGFDMExec*);
  80   /// Destructor
  81   ~FGAtmosphere();
  82   /** Runs the Atmosphere model; called by the Executive
  83       @return false if no error */
  84   bool Run(void);
  85
  86   bool InitModel(void);
  87
  88   /// Returns the temperature in degrees Rankine.
  89   inline double GetTemperature(void) const {return *temperature;}
  90   /** Returns the density in slugs/ft^3.
  91       <i>This function may <b>only</b> be used if Run() is called first.</i> */
  92   inline double GetDensity(void)  const {return *density;}
  93   /// Returns the pressure in psf.
  94   inline double GetPressure(void)  const {return *pressure;}
  95   /// Returns the pressure at an arbitrary altitude in psf
  96   double GetPressure(double alt);
  97   /// Returns the speed of sound in ft/sec.
  98   inline double GetSoundSpeed(void) const {return soundspeed;}
  99
 100   /// Returns the sea level temperature in degrees Rankine.
 101   inline double GetTemperatureSL(void) const { return SLtemperature; }
 102   /// Returns the sea level density in slugs/ft^3
 103   inline double GetDensitySL(void)  const { return SLdensity; }
 104   /// Returns the sea level pressure in psf.
 105   inline double GetPressureSL(void) const { return SLpressure; }
 106   /// Returns the sea level speed of sound in ft/sec.
 107   inline double GetSoundSpeedSL(void) const { return SLsoundspeed; }
 108
 109   /// Returns the ratio of at-altitude temperature over the sea level value.
 110   inline double GetTemperatureRatio(void) const { return (*temperature)*rSLtemperature; }
 111   /// Returns the ratio of at-altitude density over the sea level value.
 112   inline double GetDensityRatio(void) const { return (*density)*rSLdensity; }
 113   /// Returns the ratio of at-altitude pressure over the sea level value.
 114   inline double GetPressureRatio(void) const { return (*pressure)*rSLpressure; }
 115   /// Returns the ratio of at-altitude sound speed over the sea level value.
 116   inline double GetSoundSpeedRatio(void) const { return soundspeed*rSLsoundspeed; }
 117
 118   /// Tells the simulator to use an externally calculated atmosphere model.
 119   void UseExternal(void);
 120   /// Tells the simulator to use the internal atmosphere model.
 121   void UseInternal(void);  //this is the default
 122   /// Gets the boolean that tells if the external atmosphere model is being used.
 123   bool External(void) { return useExternal; }
 124
 125   /// Provides the external atmosphere model with an interface to set the temperature.
 126   inline void SetExTemperature(double t)  { exTemperature=t; }
 127   /// Provides the external atmosphere model with an interface to set the density.
 128   inline void SetExDensity(double d)      { exDensity=d; }
 129   /// Provides the external atmosphere model with an interface to set the pressure.
 130   inline void SetExPressure(double p)     { exPressure=p; }
 131
 132   /// Sets the temperature deviation at sea-level in degrees Fahrenheit
 133   inline void SetSLTempDev(double d)  { T_dev_sl = d; }
 134   /// Gets the temperature deviation at sea-level in degrees Fahrenheit
 135   inline double GetSLTempDev(void) const { return T_dev_sl; }
 136   /// Sets the current delta-T in degrees Fahrenheit
 137   inline void SetDeltaT(double d)  { delta_T = d; }
 138   /// Gets the current delta-T in degrees Fahrenheit
 139   inline double GetDeltaT(void) const  { return delta_T; }
 140   /// Gets the at-altitude temperature deviation in degrees Fahrenheit
 141   inline double GetTempDev(void) const { return T_dev; }
 142   /// Gets the density altitude in feet
 143   inline double GetDensityAltitude(void) const { return density_altitude; }
 144
 145   /// Sets the wind components in NED frame.
 146   inline void SetWindNED(double wN, double wE, double wD) { vWindNED(1)=wN; vWindNED(2)=wE; vWindNED(3)=wD;}
 147
 148   /// Retrieves the wind components in NED frame.
 149   inline FGColumnVector3& GetWindNED(void) { return vWindNED; }
 150
 151   /** Retrieves the wind direction. The direction is defined as north=0 and
 152       increases counterclockwise. The wind heading is returned in radians.*/
 153   inline double GetWindPsi(void) const { return psiw; }
 154
 155   inline void SetTurbGain(double tt) {TurbGain = tt;}
 156   inline void SetTurbRate(double tt) {TurbRate = tt;}
 157
 158   inline double GetTurbPQR(int idx) const {return vTurbPQR(idx);}
 159   inline FGColumnVector3& GetTurbPQR(void) {return vTurbPQR;}
 160
 161   void bind(void);
 162   void unbind(void);
 163
 164
 165 protected:
 166   double rho;
 167
 168   enum tType {ttStandard, ttBerndt, ttNone} turbType;
 169
 170   int lastIndex;
 171   double h;
 172   double htab[8];
 173   double SLtemperature,SLdensity,SLpressure,SLsoundspeed;
 174   double rSLtemperature,rSLdensity,rSLpressure,rSLsoundspeed; //reciprocals
 175   double *temperature,*density,*pressure;
 176   double soundspeed;
 177   bool useExternal;
 178   double exTemperature,exDensity,exPressure;
 179   double intTemperature, intDensity, intPressure;
 180   double T_dev_sl, T_dev, delta_T, density_altitude;
 181
 182   double MagnitudedAccelDt, MagnitudeAccel, Magnitude;
 183   double TurbGain;
 184   double TurbRate;
 185   FGColumnVector3 vDirectiondAccelDt;
 186   FGColumnVector3 vDirectionAccel;
 187   FGColumnVector3 vDirection;
 188   FGColumnVector3 vTurbulence;
 189   FGColumnVector3 vTurbulenceGrad;
 190   FGColumnVector3 vBodyTurbGrad;
 191   FGColumnVector3 vTurbPQR;
 192
 193   FGColumnVector3 vWindNED;
 194   double psiw;
 195
 196   void Calculate(double altitude);
 197   void Turbulence(void);
 198   void Debug(int from);
 199 };
 200
 201 } // namespace JSBSim
 202
 203 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 204 #endif
 205