1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 Module: FGCoefficient.cpp
6 Purpose: Encapsulates the stability derivative class FGCoefficient;
9 ------------- Copyright (C) 1999 Jon S. Berndt (jsb@hal-pc.org) -------------
11 This program is free software; you can redistribute it and/or modify it under
12 the terms of the GNU General Public License as published by the Free Software
13 Foundation; either version 2 of the License, or (at your option) any later
16 This program is distributed in the hope that it will be useful, but WITHOUT
17 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21 You should have received a copy of the GNU General Public License along with
22 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
23 Place - Suite 330, Boston, MA 02111-1307, USA.
25 Further information about the GNU General Public License can also be found on
26 the world wide web at http://www.gnu.org.
28 FUNCTIONAL DESCRIPTION
29 --------------------------------------------------------------------------------
30 This class models the stability derivative coefficient lookup tables or
31 equations. Note that the coefficients need not be calculated each delta-t.
33 Note that the values in a row which index into the table must be the same value
34 for each column of data, so the first column of numbers for each altitude are
35 seen to be equal, and there are the same number of values for each altitude.
37 See the header file FGCoefficient.h for the values of the identifiers.
40 --------------------------------------------------------------------------------
43 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
45 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
47 #include "FGCoefficient.h"
49 #include "FGFDMExec.h"
52 # if defined(sgi) && !defined(__GNUC__)
61 static const char *IdSrc = "$Id$";
62 static const char *IdHdr = ID_COEFFICIENT;
64 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
66 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
68 FGCoefficient::FGCoefficient( FGFDMExec* fdex )
72 State = FDMExec->GetState();
75 if (debug_lvl & 2) cout << "Instantiated: FGCoefficient" << endl;
78 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
80 FGCoefficient::~FGCoefficient()
82 if (Table) delete Table;
83 if (debug_lvl & 2) cout << "Destroyed: FGCoefficient" << endl;
86 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
88 bool FGCoefficient::Load(FGConfigFile *AC_cfg)
94 name = AC_cfg->GetValue("NAME");
95 method = AC_cfg->GetValue("TYPE");
96 AC_cfg->GetNextConfigLine();
97 *AC_cfg >> description;
99 if (method == "EQUATION") type = EQUATION;
100 else if (method == "TABLE") type = TABLE;
101 else if (method == "VECTOR") type = VECTOR;
102 else if (method == "VALUE") type = VALUE;
105 if (type == VECTOR || type == TABLE) {
109 Table = new FGTable(rows, columns);
111 Table = new FGTable(rows);
114 *AC_cfg >> multparmsRow;
115 LookupR = State->GetParameterIndex(multparmsRow);
119 *AC_cfg >> multparmsCol;
120 LookupC = State->GetParameterIndex(multparmsCol);
123 // Here, read in the line of the form (e.g.) FG_MACH|FG_QBAR|FG_ALPHA
124 // where each non-dimensionalizing parameter for this coefficient is
125 // separated by a | character
127 *AC_cfg >> multparms;
129 end = multparms.length();
130 n = multparms.find("|");
133 if (multparms != string("FG_NONE")) {
134 while (n < end && n >= 0) {
136 mult = multparms.substr(start,n);
137 multipliers.push_back( State->GetParameterIndex(mult) );
139 n = multparms.find("|",start);
141 multipliers.push_back(State->GetParameterIndex(multparms.substr(start,n)));
142 // End of non-dimensionalizing parameter read-in
146 *AC_cfg >> StaticValue;
147 } else if (type == VECTOR || type == TABLE) {
150 cerr << "Unimplemented coefficient type: " << type << endl;
153 AC_cfg->GetNextConfigLine();
164 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
166 double FGCoefficient::Value(double rVal, double cVal)
171 SD = Value = Table->GetValue(rVal, cVal);
173 for (midx=0; midx < multipliers.size(); midx++) {
174 Value *= State->GetParameter(multipliers[midx]);
179 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
181 double FGCoefficient::Value(double Val)
185 SD = Value = Table->GetValue(Val);
187 for (unsigned int midx=0; midx < multipliers.size(); midx++)
188 Value *= State->GetParameter(multipliers[midx]);
193 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
195 double FGCoefficient::Value(void)
199 SD = Value = StaticValue;
201 for (unsigned int midx=0; midx < multipliers.size(); midx++)
202 Value *= State->GetParameter(multipliers[midx]);
207 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
209 double FGCoefficient::TotalValue()
217 return (Value(State->GetParameter(LookupR)));
219 return (Value(State->GetParameter(LookupR),State->GetParameter(LookupC)));
226 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
228 void FGCoefficient::DumpSD(void)
230 cout << " " << name << ": " << SD << endl;
233 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
235 void FGCoefficient::DisplayCoeffFactors(void)
239 cout << " Non-Dimensionalized by: ";
241 if (multipliers.size() == 0) {
242 cout << "none" << endl;
244 for (i=0; i<multipliers.size(); i++)
245 cout << FDMExec->GetState()->paramdef[multipliers[i]];
250 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
252 string FGCoefficient::GetCoefficientValues(void)
257 sprintf(buffer,"%9.6f",SD);
258 value = string(buffer);
262 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
263 // The bitmasked value choices are as follows:
264 // unset: In this case (the default) JSBSim would only print
265 // out the normally expected messages, essentially echoing
266 // the config files as they are read. If the environment
267 // variable is not set, debug_lvl is set to 1 internally
268 // 0: This requests JSBSim not to output any messages
270 // 1: This value explicity requests the normal JSBSim
272 // 2: This value asks for a message to be printed out when
273 // a class is instantiated
274 // 4: When this value is set, a message is displayed when a
275 // FGModel object executes its Run() method
276 // 8: When this value is set, various runtime state variables
277 // are printed out periodically
278 // 16: When set various parameters are sanity checked and
279 // a message is printed out when they go out of bounds
281 void FGCoefficient::Debug(int from)
283 if (debug_lvl <= 0) return;
285 if (debug_lvl & 1) { // Standard console startup message output
286 if (from == 2) { // Loading
287 cout << "\n " << highint << underon << name << underoff << normint << endl;
288 cout << " " << description << endl;
289 cout << " " << method << endl;
291 if (type == VECTOR || type == TABLE) {
292 cout << " Rows: " << rows << " ";
294 cout << "Cols: " << columns;
296 cout << endl << " Row indexing parameter: " << multparmsRow << endl;
300 cout << " Column indexing parameter: " << multparmsCol << endl;
304 cout << " Value = " << StaticValue << endl;
305 } else if (type == VECTOR || type == TABLE) {
309 DisplayCoeffFactors();
312 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
313 if (from == 0) cout << "Instantiated: FGCoefficient" << endl;
314 if (from == 1) cout << "Destroyed: FGCoefficient" << endl;
316 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
318 if (debug_lvl & 8 ) { // Runtime state variables
320 if (debug_lvl & 16) { // Sanity checking