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();
78 if (debug_lvl & 2) cout << "Instantiated: FGCoefficient" << endl;
81 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
83 FGCoefficient::~FGCoefficient()
85 if (Table) delete Table;
86 if (debug_lvl & 2) cout << "Destroyed: FGCoefficient" << endl;
89 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
91 bool FGCoefficient::Load(FGConfigFile *AC_cfg)
97 name = AC_cfg->GetValue("NAME");
98 method = AC_cfg->GetValue("TYPE");
99 AC_cfg->GetNextConfigLine();
100 *AC_cfg >> description;
102 if (method == "EQUATION") type = EQUATION;
103 else if (method == "TABLE") type = TABLE;
104 else if (method == "VECTOR") type = VECTOR;
105 else if (method == "VALUE") type = VALUE;
108 if (type == VECTOR || type == TABLE) {
112 Table = new FGTable(rows, columns);
114 Table = new FGTable(rows);
117 *AC_cfg >> multparmsRow;
118 LookupR = State->GetParameterIndex(multparmsRow);
122 *AC_cfg >> multparmsCol;
123 LookupC = State->GetParameterIndex(multparmsCol);
126 // Here, read in the line of the form (e.g.) FG_MACH|FG_QBAR|FG_ALPHA
127 // where each non-dimensionalizing parameter for this coefficient is
128 // separated by a | character
130 *AC_cfg >> multparms;
132 end = multparms.length();
133 n = multparms.find("|");
136 if (multparms != string("FG_NONE")) {
137 while (n < end && n >= 0) {
139 mult = multparms.substr(start,n);
140 multipliers.push_back( State->GetParameterIndex(mult) );
142 n = multparms.find("|",start);
144 multipliers.push_back(State->GetParameterIndex(multparms.substr(start,n)));
145 // End of non-dimensionalizing parameter read-in
149 *AC_cfg >> StaticValue;
150 } else if (type == VECTOR || type == TABLE) {
153 cerr << "Unimplemented coefficient type: " << type << endl;
156 AC_cfg->GetNextConfigLine();
157 FGCoefficient::Debug(2);
167 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
169 double FGCoefficient::Value(double rVal, double cVal)
174 SD = Value = gain*Table->GetValue(rVal, cVal) + bias;
177 for (midx=0; midx < multipliers.size(); midx++) {
178 Value *= State->GetParameter(multipliers[midx]);
183 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
185 double FGCoefficient::Value(double Val)
189 SD = Value = gain*Table->GetValue(Val) + bias;
191 for (unsigned int midx=0; midx < multipliers.size(); midx++)
192 Value *= State->GetParameter(multipliers[midx]);
197 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
199 double FGCoefficient::Value(void)
203 SD = Value = gain*StaticValue + bias;
205 for (unsigned int midx=0; midx < multipliers.size(); midx++)
206 Value *= State->GetParameter(multipliers[midx]);
211 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
213 double FGCoefficient::TotalValue()
221 return (Value(State->GetParameter(LookupR)));
223 return (Value(State->GetParameter(LookupR),State->GetParameter(LookupC)));
230 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
232 void FGCoefficient::DumpSD(void)
234 cout << " " << name << ": " << SD << endl;
237 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
239 void FGCoefficient::DisplayCoeffFactors(void)
243 cout << " Non-Dimensionalized by: ";
245 if (multipliers.size() == 0) {
246 cout << "none" << endl;
248 for (i=0; i<multipliers.size(); i++)
249 cout << FDMExec->GetState()->paramdef[multipliers[i]];
254 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
256 string FGCoefficient::GetCoefficientValues(void)
261 sprintf(buffer,"%9.6f",SD);
262 value = string(buffer);
266 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
267 // The bitmasked value choices are as follows:
268 // unset: In this case (the default) JSBSim would only print
269 // out the normally expected messages, essentially echoing
270 // the config files as they are read. If the environment
271 // variable is not set, debug_lvl is set to 1 internally
272 // 0: This requests JSBSim not to output any messages
274 // 1: This value explicity requests the normal JSBSim
276 // 2: This value asks for a message to be printed out when
277 // a class is instantiated
278 // 4: When this value is set, a message is displayed when a
279 // FGModel object executes its Run() method
280 // 8: When this value is set, various runtime state variables
281 // are printed out periodically
282 // 16: When set various parameters are sanity checked and
283 // a message is printed out when they go out of bounds
285 void FGCoefficient::Debug(int from)
287 if (debug_lvl <= 0) return;
289 if (debug_lvl & 1) { // Standard console startup message output
291 if (from == 2) { // Loading
292 cout << "\n " << highint << underon << name << underoff << normint << endl;
293 cout << " " << description << endl;
294 cout << " " << method << endl;
296 if (type == VECTOR || type == TABLE) {
297 cout << " Rows: " << rows << " ";
299 cout << "Cols: " << columns;
301 cout << endl << " Row indexing parameter: " << multparmsRow << endl;
305 cout << " Column indexing parameter: " << multparmsCol << endl;
309 cout << " Value = " << StaticValue << endl;
310 } else if (type == VECTOR || type == TABLE) {
314 DisplayCoeffFactors();
317 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
318 if (from == 0) cout << "Instantiated: FGCoefficient" << endl;
319 if (from == 1) cout << "Destroyed: FGCoefficient" << endl;
321 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
323 if (debug_lvl & 8 ) { // Runtime state variables
325 if (debug_lvl & 16) { // Sanity checking