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 FGTranslation
  32
  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 "FGMatrix33.h"
  47 #include "FGColumnVector3.h"
  48 #include "FGColumnVector4.h"
  49
  50 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  51 DEFINITIONS
  52 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  53
  54 #define ID_ATMOSPHERE "$Id$"
  55
  56 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  57 FORWARD DECLARATIONS
  58 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  59
  60 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  61 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
  62 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  63
  64 [1]   Anderson, John D. "Introduction to Flight, Third Edition", McGraw-Hill,
  65       1989, ISBN 0-07-001641-0
  66
  67 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  68 CLASS DOCUMENTATION
  69 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  70
  71 /** Models the standard atmosphere.
  72     @author Tony Peden, Jon Berndt
  73     @version $Id$
  74 */
  75
  76 /******************************************************************************
  77 CLASS DECLARATION
  78 *******************************************************************************/
  79
  80 class FGAtmosphere : public FGModel {
  81 public:
  82
  83   /// Constructor
  84   FGAtmosphere(FGFDMExec*);
  85   /// Destructor
  86   ~FGAtmosphere();
  87   /** Runs the Atmosphere model; called by the Executive
  88       @return false if no error */
  89   bool Run(void);
  90
  91   bool InitModel(void);
  92
  93   /// Returns the temperature in degrees Rankine.
  94   inline double GetTemperature(void) {return temperature;}
  95   /** Returns the density in slugs/ft^3.
  96       <i>This function may <b>only</b> be used if Run() is called first.</i> */
  97   inline double GetDensity(void)    {return density;}
  98   /// Returns the pressure in psf.
  99   inline double GetPressure(void)   {return pressure;}
 100   /// Returns the speed of sound in ft/sec.
 101   inline double GetSoundSpeed(void) {return soundspeed;}
 102
 103   /// Returns the sea level temperature in degrees Rankine.
 104   inline double GetTemperatureSL(void) { return SLtemperature; }
 105   /// Returns the sea level density in slugs/ft^3
 106   inline double GetDensitySL(void)     { return SLdensity; }
 107   /// Returns the sea level pressure in psf.
 108   inline double GetPressureSL(void)    { return SLpressure; }
 109   /// Returns the sea level speed of sound in ft/sec.
 110   inline double GetSoundSpeedSL(void)  { return SLsoundspeed; }
 111
 112   /// Returns the ratio of at-altitude temperature over the sea level value.
 113   inline double GetTemperatureRatio(void)  { return temperature*rSLtemperature; }
 114   /// Returns the ratio of at-altitude density over the sea level value.
 115   inline double GetDensityRatio(void)     { return density*rSLdensity; }
 116   /// Returns the ratio of at-altitude pressure over the sea level value.
 117   inline double GetPressureRatio(void)     { return pressure*rSLpressure; }
 118   /// Returns the ratio of at-altitude sound speed over the sea level value.
 119   inline double GetSoundSpeedRatio(void)   { return soundspeed*rSLsoundspeed; }
 120
 121   /// Tells the simulator to use an externally calculated atmosphere model.
 122   inline void UseExternal(void)          { useExternal=true;  }
 123   /// Tells the simulator to use the internal atmosphere model.
 124   inline void UseInternal(void)          { useExternal=false; } //this is the default
 125   /// Gets the boolean that tells if the external atmosphere model is being used.
 126   bool External(void) { return useExternal; }
 127
 128   /// Provides the external atmosphere model with an interface to set the temperature.
 129   inline void SetExTemperature(double t)  { exTemperature=t; }
 130   /// Provides the external atmosphere model with an interface to set the density.
 131   inline void SetExDensity(double d)      { exDensity=d; }
 132   /// Provides the external atmosphere model with an interface to set the pressure.
 133   inline void SetExPressure(double p)     { exPressure=p; }
 134
 135   /// Sets the wind components in NED frame.
 136   inline void SetWindNED(double wN, double wE, double wD) { vWindNED(1)=wN; vWindNED(2)=wE; vWindNED(3)=wD;}
 137
 138   /// Retrieves the wind components in NED frame.
 139   inline FGColumnVector3& GetWindNED(void) { return vWindNED; }
 140
 141   /** Retrieves the wind direction. The direction is defined as north=0 and
 142       increases counterclockwise. The wind heading is returned in radians.*/
 143   inline double GetWindPsi(void) { return psiw; }
 144
 145   inline void SetTurbGain(double tt) {TurbGain = tt;}
 146
 147   inline double GetTurbPQR(int idx) {return vTurbPQR(idx);}
 148   inline FGColumnVector3& GetTurbPQR(void) {return vTurbPQR;}
 149
 150 private:
 151   double rho;
 152
 153   enum tType {ttBerndt, ttNone} turbType;
 154
 155   int lastIndex;
 156   double h;
 157   double htab[8];
 158   double SLtemperature,SLdensity,SLpressure,SLsoundspeed;
 159   double rSLtemperature,rSLdensity,rSLpressure,rSLsoundspeed; //reciprocals
 160   double temperature,density,pressure,soundspeed;
 161   bool useExternal;
 162   double exTemperature,exDensity,exPressure;
 163
 164   double MagnitudedAccelDt, MagnitudeAccel, Magnitude;
 165   double TurbGain;
 166   FGColumnVector3 vDirectiondAccelDt;
 167   FGColumnVector3 vDirectionAccel;
 168   FGColumnVector3 vDirection;
 169   FGColumnVector3 vTurbulence;
 170   FGColumnVector3 vTurbulenceGrad;
 171   FGColumnVector3 vBodyTurbGrad;
 172   FGColumnVector3 vTurbPQR;
 173
 174   FGColumnVector3 vWindNED;
 175   double psiw;
 176
 177   void Calculate(double altitude);
 178   void Turbulence(void);
 179   void Debug(int from);
 180 };
 181
 182 /******************************************************************************/
 183 #endif
 184