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