src/FDM/JSBSim/FGAuxiliary.h

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Header:       FGAuxiliary.h
   4  Author:       Jon Berndt
   5  Date started: 01/26/99
   6
   7  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
   8
   9  This program is free software; you can redistribute it and/or modify it under
  10  the terms of the GNU General Public License as published by the Free Software
  11  Foundation; either version 2 of the License, or (at your option) any later
  12  version.
  13
  14  This program is distributed in the hope that it will be useful, but WITHOUT
  15  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  17  details.
  18
  19  You should have received a copy of the GNU General Public License along with
  20  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  21  Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23  Further information about the GNU General Public License can also be found on
  24  the world wide web at http://www.gnu.org.
  25
  26 HISTORY
  27 --------------------------------------------------------------------------------
  28 11/22/98   JSB   Created
  29   1/1/00   TP    Added calcs and getters for VTAS, VCAS, VEAS, Vground, in knots
  30
  31 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  32 SENTRY
  33 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  34
  35 #ifndef FGAUXILIARY_H
  36 #define FGAUXILIARY_H
  37
  38 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  39 INCLUDES
  40 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  41
  42 #include "FGModel.h"
  43 #include "FGMatrix33.h"
  44 #include "FGColumnVector3.h"
  45 #include "FGColumnVector4.h"
  46
  47 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  48 DEFINITIONS
  49 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  50
  51 #define ID_AUXILIARY "$Id$"
  52
  53 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  54 FORWARD DECLARATIONS
  55 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  56
  57 namespace JSBSim {
  58
  59 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  60 CLASS DOCUMENTATION
  61 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  62
  63 /** Encapsulates various uncategorized scheduled functions.
  64     @author Tony Peden, Jon Berndt
  65     @version $Id$
  66 */
  67
  68 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  69 CLASS DECLARATION
  70 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  71
  72 class FGAuxiliary : public FGModel {
  73 public:
  74   /** Constructor
  75       @param Executive a pointer to the parent executive object */
  76   FGAuxiliary(FGFDMExec* Executive);
  77   /// Destructor
  78   ~FGAuxiliary();
  79
  80   /** Runs the Auxiliary routines; called by the Executive
  81       @return false if no error */
  82   bool Run(void);
  83
  84   // Use FGInitialCondition to set these speeds
  85   inline double GetVcalibratedFPS(void) const { return vcas; }
  86   inline double GetVcalibratedKTS(void) const { return vcas*fpstokts; }
  87   inline double GetVequivalentFPS(void) const { return veas; }
  88   inline double GetVequivalentKTS(void) const { return veas*fpstokts; }
  89   inline double GetMachU(void) const { return machU; }
  90
  91   inline double GetTotalTemperature(void) const { return tat; }
  92   inline double GetTAT_C(void) const { return tatc; }
  93
  94   // total pressure above is freestream total pressure for subsonic only
  95   // for supersonic it is the 1D total pressure behind a normal shock
  96   inline double GetTotalPressure(void) const { return pt; }
  97
  98   inline FGColumnVector3& GetPilotAccel(void) { return vPilotAccel; }
  99   inline double GetPilotAccel(int idx) const { return vPilotAccel(idx); }
 100   FGColumnVector3 GetNpilot(void) const { return vPilotAccelN; }
 101   double GetNpilot(int idx) const { return vPilotAccelN(idx); }
 102
 103   inline double GetEarthPositionAngle(void) const { return earthPosAngle; }
 104
 105   double GetHeadWind(void);
 106   double GetCrossWind(void);
 107
 108   void bind(void);
 109   void unbind(void);
 110
 111 private:
 112   double vcas;
 113   double veas;
 114   double mach;
 115   double machU;
 116   double qbar,rhosl,rho,p,psl,pt,tat,sat,tatc;
 117
 118   // Don't add a getter for pt!
 119
 120   FGColumnVector3 vPilotAccel;
 121   FGColumnVector3 vPilotAccelN;
 122   FGColumnVector3 vToEyePt;
 123
 124   double earthPosAngle;
 125
 126   void GetState(void);
 127   void Debug(int from);
 128 };
 129
 130 } // namespace JSBSim
 131
 132 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 133 #endif
 134