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