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