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     @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGAtmosphere.h?rev=HEAD&content-type=text/vnd.viewcvs-markup">
  75          Header File </a>
  76     @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGAtmosphere.cpp?rev=HEAD&content-type=text/vnd.viewcvs-markup">
  77          Source File </a>
  78 */
  79
  80 /******************************************************************************
  81 CLASS DECLARATION
  82 *******************************************************************************/
  83
  84 class FGAtmosphere : public FGModel {
  85 public:
  86
  87   /// Constructor
  88   FGAtmosphere(FGFDMExec*);
  89   /// Destructor
  90   ~FGAtmosphere();
  91   /** Runs the Atmosphere model; called by the Executive
  92       @return false if no error */
  93   bool Run(void);
  94
  95   bool InitModel(void);
  96
  97   /// Returns the temperature in degrees Rankine.
  98   inline double GetTemperature(void) const {return temperature;}
  99   /** Returns the density in slugs/ft^3.
 100       <i>This function may <b>only</b> be used if Run() is called first.</i> */
 101   inline double GetDensity(void)  const {return density;}
 102   /// Returns the pressure in psf.
 103   inline double GetPressure(void)  const {return pressure;}
 104   /// Returns the speed of sound in ft/sec.
 105   inline double GetSoundSpeed(void) const {return soundspeed;}
 106
 107   /// Returns the sea level temperature in degrees Rankine.
 108   inline double GetTemperatureSL(void) const { return SLtemperature; }
 109   /// Returns the sea level density in slugs/ft^3
 110   inline double GetDensitySL(void)  const { return SLdensity; }
 111   /// Returns the sea level pressure in psf.
 112   inline double GetPressureSL(void) const { return SLpressure; }
 113   /// Returns the sea level speed of sound in ft/sec.
 114   inline double GetSoundSpeedSL(void) const { return SLsoundspeed; }
 115
 116   /// Returns the ratio of at-altitude temperature over the sea level value.
 117   inline double GetTemperatureRatio(void) const { return temperature*rSLtemperature; }
 118   /// Returns the ratio of at-altitude density over the sea level value.
 119   inline double GetDensityRatio(void) const { return density*rSLdensity; }
 120   /// Returns the ratio of at-altitude pressure over the sea level value.
 121   inline double GetPressureRatio(void) const { return pressure*rSLpressure; }
 122   /// Returns the ratio of at-altitude sound speed over the sea level value.
 123   inline double GetSoundSpeedRatio(void) const { return soundspeed*rSLsoundspeed; }
 124
 125   /// Tells the simulator to use an externally calculated atmosphere model.
 126   inline void UseExternal(void)          { useExternal=true;  }
 127   /// Tells the simulator to use the internal atmosphere model.
 128   inline void UseInternal(void)          { useExternal=false; } //this is the default
 129   /// Gets the boolean that tells if the external atmosphere model is being used.
 130   bool External(void) { return useExternal; }
 131
 132   /// Provides the external atmosphere model with an interface to set the temperature.
 133   inline void SetExTemperature(double t)  { exTemperature=t; }
 134   /// Provides the external atmosphere model with an interface to set the density.
 135   inline void SetExDensity(double d)      { exDensity=d; }
 136   /// Provides the external atmosphere model with an interface to set the pressure.
 137   inline void SetExPressure(double p)     { exPressure=p; }
 138
 139   /// Sets the wind components in NED frame.
 140   inline void SetWindNED(double wN, double wE, double wD) { vWindNED(1)=wN; vWindNED(2)=wE; vWindNED(3)=wD;}
 141
 142   /// Retrieves the wind components in NED frame.
 143   inline FGColumnVector3& GetWindNED(void) { return vWindNED; }
 144
 145   /** Retrieves the wind direction. The direction is defined as north=0 and
 146       increases counterclockwise. The wind heading is returned in radians.*/
 147   inline double GetWindPsi(void) const { return psiw; }
 148
 149   inline void SetTurbGain(double tt) {TurbGain = tt;}
 150
 151   inline double GetTurbPQR(int idx) const {return vTurbPQR(idx);}
 152   inline FGColumnVector3& GetTurbPQR(void) {return vTurbPQR;}
 153
 154   void bind(void);
 155   void unbind(void);
 156
 157
 158 private:
 159   double rho;
 160
 161   enum tType {ttBerndt, ttNone} turbType;
 162
 163   int lastIndex;
 164   double h;
 165   double htab[8];
 166   double SLtemperature,SLdensity,SLpressure,SLsoundspeed;
 167   double rSLtemperature,rSLdensity,rSLpressure,rSLsoundspeed; //reciprocals
 168   double temperature,density,pressure,soundspeed;
 169   bool useExternal;
 170   double exTemperature,exDensity,exPressure;
 171
 172   double MagnitudedAccelDt, MagnitudeAccel, Magnitude;
 173   double TurbGain;
 174   FGColumnVector3 vDirectiondAccelDt;
 175   FGColumnVector3 vDirectionAccel;
 176   FGColumnVector3 vDirection;
 177   FGColumnVector3 vTurbulence;
 178   FGColumnVector3 vTurbulenceGrad;
 179   FGColumnVector3 vBodyTurbGrad;
 180   FGColumnVector3 vTurbPQR;
 181
 182   FGColumnVector3 vWindNED;
 183   double psiw;
 184
 185   void Calculate(double altitude);
 186   void Turbulence(void);
 187   void Debug(int from);
 188 };
 189
 190 /******************************************************************************/
 191 #endif
 192