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 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  58 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
  59 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  60
  61 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  62 CLASS DOCUMENTATION
  63 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  64
  65 /** Encapsulates various uncategorized scheduled functions.
  66     @author Tony Peden, Jon Berndt
  67     @version $Id$
  68     @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGAuxiliary.h?rev=HEAD&content-type=text/vnd.viewcvs-markup">
  69          Header File </a>
  70     @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGAuxiliary.cpp?rev=HEAD&content-type=text/vnd.viewcvs-markup">
  71          Source File </a>
  72 */
  73
  74 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  75 CLASS DECLARATION
  76 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  77
  78 namespace JSBSim {
  79
  80 class FGAuxiliary : public FGModel {
  81 public:
  82   /** Constructor
  83       @param Executive a pointer to the parent executive object */
  84   FGAuxiliary(FGFDMExec*);
  85   /// Destructor
  86   ~FGAuxiliary();
  87
  88   /** Runs the Auxiliary routines; called by the Executive
  89       @return false if no error */
  90   bool Run(void);
  91
  92   // Use FGInitialCondition to set these speeds
  93   inline double GetVcalibratedFPS(void) const { return vcas; }
  94   inline double GetVcalibratedKTS(void) const { return vcas*fpstokts; }
  95   inline double GetVequivalentFPS(void) const { return veas; }
  96   inline double GetVequivalentKTS(void) const { return veas*fpstokts; }
  97
  98   inline double GetTotalTemperature(void) const { return tat; }
  99
 100   // total pressure above is freestream total pressure for subsonic only
 101   // for supersonic it is the 1D total pressure behind a normal shock
 102   inline double GetTotalPressure(void) const { return pt; }
 103
 104   inline FGColumnVector3& GetPilotAccel(void) { return vPilotAccel; }
 105   inline double GetPilotAccel(int idx) const { return vPilotAccel(idx); }
 106   FGColumnVector3 GetNpilot(void) const { return vPilotAccelN; }
 107   double GetNpilot(int idx) const { return vPilotAccelN(idx); }
 108
 109   inline double GetEarthPositionAngle(void) const { return earthPosAngle; }
 110
 111   double GetHeadWind(void);
 112   double GetCrossWind(void);
 113
 114   void bind(void);
 115   void unbind(void);
 116
 117 private:
 118   double vcas;
 119   double veas;
 120   double mach;
 121   double qbar,rhosl,rho,p,psl,pt,tat,sat;
 122
 123   // Don't add a getter for pt!
 124
 125   FGColumnVector3 vPilotAccel;
 126   FGColumnVector3 vPilotAccelN;
 127   FGColumnVector3 vToEyePt;
 128
 129   double earthPosAngle;
 130
 131   void GetState(void);
 132   void Debug(int from);
 133 };
 134
 135 } // namespace JSBSim
 136
 137 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 138 #endif
 139