src/FDM/JSBSim/FGCoefficient.h

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Header:       FGCoefficient.h
   4  Author:       Jon Berndt
   5  Date started: 12/28/98
   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 12/28/98   JSB   Created
  29
  30 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  31 SENTRY
  32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  33
  34 #ifndef FGCOEFFICIENT_H
  35 #define FGCOEFFICIENT_H
  36
  37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #ifdef FGFS
  42 #  include <simgear/compiler.h>
  43 #endif
  44
  45 #include <vector>
  46 #include <string>
  47 #include "FGConfigFile.h"
  48 #include "FGDefs.h"
  49 #include "FGTable.h"
  50 #include "FGJSBBase.h"
  51
  52 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  53 DEFINITIONS
  54 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  55
  56 #define ID_COEFFICIENT "$Id$"
  57
  58 using std::vector;
  59
  60 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  61 FORWARD DECLARATIONS
  62 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  63
  64 class FGFDMExec;
  65 class FGState;
  66 class FGAtmosphere;
  67 class FGFCS;
  68 class FGAircraft;
  69 class FGTranslation;
  70 class FGRotation;
  71 class FGPosition;
  72 class FGAuxiliary;
  73 class FGOutput;
  74
  75 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  76 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
  77 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  78
  79 Note that the coefficients need not be calculated each delta-t. This is
  80 something that may be fixed someday.
  81
  82 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  83 CLASS DOCUMENTATION
  84 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  85
  86 /** This class models the stability derivative coefficient lookup tables.
  87     Each coefficient for an axis is stored in that axes' vector of coefficients.
  88     Each FDM execution frame the Run() method of the [currently] FGAircraft model
  89     is called and the coefficient value is calculated.
  90     @author Jon S. Berndt
  91     @version $Id$
  92     @see -
  93 */
  94
  95 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  96 CLASS DECLARATION
  97 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  98
  99 class FGCoefficient : public FGJSBBase
 100 {
 101 public:
 102   FGCoefficient(FGFDMExec*);
 103   virtual ~FGCoefficient();
 104
 105   virtual bool Load(FGConfigFile* AC_cfg);
 106
 107   typedef vector <eParam> MultVec;
 108   virtual float TotalValue(void);
 109   virtual inline string Getname(void) {return name;}
 110   virtual inline float GetSD(void) { return SD;}
 111   inline MultVec Getmultipliers(void) {return multipliers;}
 112   void DumpSD(void);
 113
 114   /** Outputs coefficient information.
 115       Non-dimensionalizing parameter descriptions are output
 116       for each aero coefficient defined.
 117       @param multipliers the list of multipliers for this coefficient.*/
 118   virtual void DisplayCoeffFactors(void);
 119   virtual inline string GetCoefficientStrings(void) { return name; }
 120   virtual string GetCoefficientValues(void);
 121
 122 private:
 123   enum Type {UNKNOWN, VALUE, VECTOR, TABLE, EQUATION};
 124
 125   int numInstances;
 126   string filename;
 127   string description;
 128   string name;
 129   string method;
 130   float Value(float, float);
 131   float Value(float);
 132   float Value(void);
 133   float StaticValue;
 134   eParam LookupR, LookupC;
 135   MultVec multipliers;
 136   int rows, columns;
 137   Type type;
 138   float SD; // Actual stability derivative (or other coefficient) value
 139   FGTable *Table;
 140
 141   FGFDMExec*      FDMExec;
 142   FGState*        State;
 143   FGAtmosphere*   Atmosphere;
 144   FGFCS*          FCS;
 145   FGAircraft*     Aircraft;
 146   FGTranslation*  Translation;
 147   FGRotation*     Rotation;
 148   FGPosition*     Position;
 149   FGAuxiliary*    Auxiliary;
 150   FGOutput*       Output;
 151
 152   virtual void Debug(void);
 153 };
 154
 155 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 156 #endif
 157