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 "FGTable.h"
  49 #include "FGJSBBase.h"
  50 #include "FGPropertyManager.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 namespace JSBSim {
  65
  66 class FGFDMExec;
  67 class FGState;
  68 class FGAtmosphere;
  69 class FGFCS;
  70 class FGAircraft;
  71 class FGPropagate;
  72 class FGAuxiliary;
  73 class FGOutput;
  74
  75 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  76 CLASS DOCUMENTATION
  77 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  78
  79 /** This class models the aero coefficient and stability derivative coefficient
  80     lookup table, value, vector, or equation (equation not modeled, yet).
  81     Each coefficient for an axis is stored in that axes' vector of coefficients.
  82     Each FDM execution frame the Run() method of the FGAerodynamics model
  83     is called and the coefficient values are calculated.
  84     @author Jon S. Berndt
  85     @version $Id$
  86 */
  87
  88 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  89 CLASS DECLARATION
  90 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  91
  92 class FGCoefficient : public FGJSBBase
  93 {
  94 public:
  95   /** Constructor.
  96       @param exec a pointer to the FGFDMExec instance. */
  97   FGCoefficient(FGFDMExec* exec);
  98   /// Destructor.
  99   virtual ~FGCoefficient();
 100
 101   /** Loads the stability derivative/aero coefficient data from the config file
 102       as directed by the FGAerodynamics instance.
 103       @param AC_cfg a pointer to the current config file instance. */
 104   virtual bool Load(FGConfigFile* AC_cfg);
 105
 106   typedef vector <FGPropertyManager*> MultVec;
 107
 108   enum Type {UNKNOWN, VALUE, VECTOR, TABLE, TABLE3D, EQUATION};
 109
 110   /** Returns the value for this coefficient.
 111       Each instance of FGCoefficient stores a value for the "type" of coefficient
 112       it is, one of: VALUE, VECTOR, TABLE, or EQUATION. This TotalValue function
 113       is called when the value for a coefficient needs to be known. When it is called,
 114       depending on what type of coefficient is represented by the FGCoefficient
 115       instance, TotalValue() directs the appropriate Value() function to be called.
 116       The type of coefficient represented is determined when the config file is read.
 117       The coefficient definition includes the "type" specifier.
 118       @return the current value of the coefficient represented by this instance of
 119       FGCoefficient. */
 120   virtual double TotalValue(void);
 121
 122   /** Returns the value for this coefficient.
 123       TotalValue is stored each time TotalValue() is called. This function returns
 124       the stored value but does not calculate it anew. This is valuable for merely
 125       printing out the value.
 126       @return the most recently calculated and stored value of the coefficient
 127       represented by this instance of FGCoefficient. */
 128   virtual inline double GetValue(void) const { return totalValue; }
 129
 130   /// Returns the name of this coefficient.
 131   virtual inline string Getname(void) const {return name;}
 132
 133   /// Returns the value of the coefficient only - before it is re-dimensionalized.
 134   virtual inline double GetSD(void) const { return SD;}
 135
 136   /** Outputs coefficient information.
 137       Non-dimensionalizing parameter descriptions are output
 138       for each aero coefficient defined. */
 139   virtual void DisplayCoeffFactors(void);
 140
 141   /// Returns the name of the coefficient.
 142   virtual inline string GetCoefficientName(void) { return name; }
 143   /// Returns the stability derivative or coefficient value as a string.
 144   virtual string GetSDstring(void);
 145
 146   inline void setBias(double b) { bias=b; }
 147   inline void setGain(double g) { gain=g; };
 148   inline double getBias(void) const { return bias; }
 149   inline double getGain(void) const { return gain; }
 150
 151   virtual void bind(FGPropertyManager *parent);
 152   virtual void unbind(void);
 153
 154 protected:
 155   FGFDMExec* FDMExec;
 156
 157 private:
 158   int numInstances;
 159   string description;
 160   string name;
 161   string filename;
 162   string method;
 163   string multparms;
 164   string multparmsRow;
 165   string multparmsCol;
 166   string multparmsTable;
 167   double Value(double, double, double);
 168   double Value(double, double);
 169   double Value(double);
 170   double Value(void);
 171   double StaticValue;
 172   double totalValue;
 173   double bias,gain;
 174   FGPropertyManager *LookupR, *LookupC, *LookupT;
 175
 176   FGPropertyManager *node; // must be private!!
 177
 178   MultVec multipliers;
 179   int rows, columns, tables;
 180   Type type;
 181   double SD; // Actual stability derivative (or other coefficient) value
 182   FGTable *Table;
 183
 184   FGState*        State;
 185   FGAtmosphere*   Atmosphere;
 186   FGFCS*          FCS;
 187   FGAircraft*     Aircraft;
 188   FGPropagate*    Propagate;
 189   FGAuxiliary*    Auxiliary;
 190   FGOutput*       Output;
 191   FGPropertyManager* PropertyManager;
 192
 193   FGPropertyManager* resolveSymbol(string name);
 194
 195   virtual void Debug(int from);
 196 };
 197
 198 } // using namespace JSBSim
 199
 200 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 201 #endif
 202