-/*******************************************************************************
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Module: FGCoefficient.cpp
Author: Jon S. Berndt
--------------------------------------------------------------------------------
12/28/98 JSB Created
-********************************************************************************
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
INCLUDES
-*******************************************************************************/
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+#include <stdio.h>
#include "FGCoefficient.h"
#include "FGState.h"
#include "FGFDMExec.h"
+#include "FGPropertyManager.h"
+
+#ifndef FGFS
+# if defined(sgi) && !defined(__GNUC__) && (_COMPILER_VERSION < 740)
+# include <iomanip.h>
+# else
+# include <iomanip>
+# endif
+#else
+# include STL_IOMANIP
+#endif
-static const char *IdSrc = "$Header$";
-static const char *IdHdr = "ID_COEFFICIENT";
+namespace JSBSim {
-/*******************************************************************************
-************************************ CODE **************************************
-*******************************************************************************/
+static const char *IdSrc = "$Id$";
+static const char *IdHdr = ID_COEFFICIENT;
-FGCoefficient::FGCoefficient(FGFDMExec* fdex, FGConfigFile* AC_cfg)
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+CLASS IMPLEMENTATION
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+FGCoefficient::FGCoefficient( FGFDMExec* fdex )
{
- int r, c, start, end, n;
- float ftrashcan;
- string multparms;
+ FDMExec = fdex;
+ State = FDMExec->GetState();
+ Table = 0;
+
+ PropertyManager = FDMExec->GetPropertyManager();
+
+ Table = (FGTable*)0L;
+ LookupR = LookupC = 0;
+ numInstances = 0;
+ rows = columns = 0;
+
+ StaticValue = 0.0;
+ totalValue = 0.0;
+ bias = 0.0;
+ gain = 1.0;
+ SD = 0.0;
+
+ filename.erase();
+ description.erase();
+ name.erase();
+ method.erase();
+ multparms.erase();
+ multparmsRow.erase();
+ multparmsCol.erase();
+
+ Debug(0);
+}
- FDMExec = fdex;
- State = FDMExec->GetState();
- Table = 0;
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+FGCoefficient::~FGCoefficient()
+{
+ if (Table) delete Table;
+ Debug(1);
+}
+
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+bool FGCoefficient::Load(FGConfigFile *AC_cfg)
+{
+ int start, end, n;
+ string mult;
if (AC_cfg) {
name = AC_cfg->GetValue("NAME");
method = AC_cfg->GetValue("TYPE");
-
AC_cfg->GetNextConfigLine();
*AC_cfg >> description;
-
- cout << " " << name << endl;
- cout << " " << description << endl;
- cout << " " << method << endl;
-
if (method == "EQUATION") type = EQUATION;
else if (method == "TABLE") type = TABLE;
else if (method == "VECTOR") type = VECTOR;
if (type == VECTOR || type == TABLE) {
*AC_cfg >> rows;
- cout << " Rows: " << rows << " ";
if (type == TABLE) {
*AC_cfg >> columns;
- cout << "Cols: " << columns;
+ Table = new FGTable(rows, columns);
+ } else {
+ Table = new FGTable(rows);
}
- cout << endl;
-
- *AC_cfg >> multparms;
- LookupR = State->GetParameterIndex(multparms);
- cout << " Row indexing parameter: " << multparms << endl;
+ *AC_cfg >> multparmsRow;
+ LookupR = PropertyManager->GetNode( multparmsRow );
}
if (type == TABLE) {
- *AC_cfg >> multparms;
- LookupC = State->GetParameterIndex(multparms);
- cout << " Column indexing parameter: " << multparms << endl;
+ *AC_cfg >> multparmsCol;
+
+ LookupC = PropertyManager->GetNode( multparmsCol );
}
// Here, read in the line of the form (e.g.) FG_MACH|FG_QBAR|FG_ALPHA
// where each non-dimensionalizing parameter for this coefficient is
// separated by a | character
- *AC_cfg >> multparms;
+ string line=AC_cfg->GetCurrentLine();
+ unsigned j=0;
+ char tmp[255];
+ for(unsigned i=0;i<line.length(); i++ ) {
+ if( !isspace(line[i]) ) {
+ tmp[j]=line[i];
+ j++;
+ }
+ }
+ tmp[j]='\0'; multparms=tmp;
+ end = multparms.length();
- end = multparms.length();
n = multparms.find("|");
start = 0;
-
- while (n < end && n >= 0) {
- n -= start;
- multipliers.push_back(State->GetParameterIndex(multparms.substr(start,n)));
- start += n+1;
- n = multparms.find("|",start);
+ if (multparms != string("none")) {
+ while (n < end && n >= 0) {
+ n -= start;
+ mult = multparms.substr(start,n);
+ multipliers.push_back( resolveSymbol( mult ) );
+ start += n+1;
+ n = multparms.find("|",start);
+ }
+ mult = multparms.substr(start,n);
+ multipliers.push_back( resolveSymbol( mult ) );
+ // End of non-dimensionalizing parameter read-in
+ }
+ AC_cfg->GetNextConfigLine();
+ if (type == VALUE) {
+ *AC_cfg >> StaticValue;
+ } else if (type == VECTOR || type == TABLE) {
+ *Table << *AC_cfg;
+ } else {
+ cerr << "Unimplemented coefficient type: " << type << endl;
}
- multipliers.push_back(State->GetParameterIndex(multparms.substr(start,n)));
-
- // End of non-dimensionalizing parameter read-in
+ AC_cfg->GetNextConfigLine();
+ FGCoefficient::Debug(2);
- switch(type) {
- case VALUE:
- *AC_cfg >> StaticValue;
- cout << " Value = " << StaticValue << endl;
- break;
- case VECTOR:
- Allocate(rows,2);
-
- for (r=1;r<=rows;r++) {
- *AC_cfg >> Table[r][0];
- *AC_cfg >> Table[r][1];
- }
+ return true;
+ } else {
+ return false;
+ }
+}
- for (r=1;r<=rows;r++) {
- cout << " ";
- for (c=0;c<columns;c++) {
- cout << Table[r][c] << " ";
- }
- cout << endl;
- }
- break;
- case TABLE:
- Allocate(rows, columns);
-
- Table[0][0] = 0.0;
- for (c=1;c<=columns;c++) {
- *AC_cfg >> Table[0][c];
- for (r=1;r<=rows;r++) {
- if ( c==1 ) *AC_cfg >> Table[r][0];
- else *AC_cfg >> ftrashcan;
- *AC_cfg >> Table[r][c];
- }
- }
- for (r=0;r<=rows;r++) {
- cout << " ";
- for (c=0;c<=columns;c++) {
- cout << Table[r][c] << " ";
- }
- cout << endl;
- }
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- break;
- case EQUATION:
- case UNKNOWN:
- cerr << "Unimplemented coefficient type: " << type << endl;
- break;
- }
- AC_cfg->GetNextConfigLine();
- }
-}
+double FGCoefficient::Value(double rVal, double cVal)
+{
+ double Value;
+ unsigned int midx;
-/******************************************************************************/
+ SD = Value = gain*Table->GetValue(rVal, cVal) + bias;
-FGCoefficient::~FGCoefficient(void) {
- DeAllocate();
+ for (midx=0; midx < multipliers.size(); midx++) {
+ Value *= multipliers[midx]->getDoubleValue();
+ }
+ return Value;
}
-/******************************************************************************/
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-bool FGCoefficient::DeAllocate(void)
+double FGCoefficient::Value(double Val)
{
- if (Table != NULL ) {
- for (unsigned int i=0; i<=rows; i++) delete[] Table[i];
-
- delete[] Table;
- }
+ double Value;
+
+ SD = Value = gain*Table->GetValue(Val) + bias;
- return true;
+ for (unsigned int midx=0; midx < multipliers.size(); midx++)
+ Value *= multipliers[midx]->getDoubleValue();
+
+ return Value;
}
-/******************************************************************************/
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-bool FGCoefficient::Allocate(int r, int c)
+double FGCoefficient::Value(void)
{
- rows = r;
- columns = c;
- Table = new float*[r+1];
- for (int i=0;i<=r;i++) Table[i] = new float[c+1];
- return true;
-}
+ double Value;
-/******************************************************************************/
+ SD = Value = gain*StaticValue + bias;
-float FGCoefficient::Value(float rVal, float cVal)
-{
- float rFactor, cFactor, col1temp, col2temp, Value;
- int r, c;
- unsigned midx;
+ for (unsigned int midx=0; midx < multipliers.size(); midx++)
+ Value *= multipliers[midx]->getDoubleValue();
- if (rows < 2 || columns < 2) return 0.0;
+ return Value;
+}
- for (r=1;r<=rows;r++) if (Table[r][0] >= rVal) break;
- for (c=1;c<=columns;c++) if (Table[0][c] >= cVal) break;
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- c = c < 2 ? 2 : (c > columns ? columns : c);
- r = r < 2 ? 2 : (r > rows ? rows : r);
+double FGCoefficient::TotalValue(void)
+{
+ switch(type) {
- rFactor = (rVal - Table[r-1][0]) / (Table[r][0] - Table[r-1][0]);
- cFactor = (cVal - Table[0][c-1]) / (Table[0][c] - Table[0][c-1]);
+ case UNKNOWN:
+ totalValue = -1;
+ break;
- col1temp = rFactor*(Table[r][c-1] - Table[r-1][c-1]) + Table[r-1][c-1];
- col2temp = rFactor*(Table[r][c] - Table[r-1][c]) + Table[r-1][c];
+ case VALUE:
+ totalValue = Value();
+ break;
- SD = Value = col1temp + cFactor*(col2temp - col1temp);
+ case VECTOR:
+ totalValue = Value( LookupR->getDoubleValue() );
+ break;
- for (midx=0; midx < multipliers.size(); midx++) {
- Value *= State->GetParameter(multipliers[midx]);
- }
+ case TABLE:
+ totalValue = Value( LookupR->getDoubleValue(),
+ LookupC->getDoubleValue() );
+ break;
- return Value;
+ case EQUATION:
+ totalValue = 0.0;
+ break;
+ }
+ return totalValue;
}
-/******************************************************************************/
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-float FGCoefficient::Value(float Val)
+void FGCoefficient::DisplayCoeffFactors(void)
{
-
-
- float Factor, Value;
- int r;
- unsigned midx;
-
- if (rows < 2) return 0.0;
+ unsigned int i;
- for (r=1;r<=rows;r++) if (Table[r][0] >= Val) break;
- r = r < 2 ? 2 : (r > rows ? rows : r);
+ cout << " Non-Dimensionalized by: ";
- // make sure denominator below does not go to zero.
- if (Table[r][0] != Table[r-1][0]) {
- Factor = (Val - Table[r-1][0]) / (Table[r][0] - Table[r-1][0]);
+ if (multipliers.size() == 0) {
+ cout << "none" << endl;
} else {
- Factor = 1.0;
+ for (i=0; i<multipliers.size(); i++)
+ cout << multipliers[i]->getName() << " ";
}
+ cout << endl;
+}
- SD = Value = Factor*(Table[r][1] - Table[r-1][1]) + Table[r-1][1];
- for (midx=0; midx < multipliers.size(); midx++) {
- Value *= State->GetParameter(multipliers[midx]);
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- }
+string FGCoefficient::GetSDstring(void)
+{
+ char buffer[16];
+ string value;
- return Value;
+ sprintf(buffer,"%9.6f",SD);
+ value = string(buffer);
+ return value;
}
-/******************************************************************************/
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-float FGCoefficient::Value(void)
+void FGCoefficient::bind(FGPropertyManager *parent)
{
- float Value;
- unsigned midx;
-
- SD = Value = StaticValue;
-
- for (midx=0; midx < multipliers.size(); midx++) {
- Value *= State->GetParameter(multipliers[midx]);
+ string mult;
+ unsigned i;
+
+ node = parent->GetNode(name,true);
+
+ node->SetString("description",description);
+ if (LookupR) node->SetString("row-parm",LookupR->getName() );
+ if (LookupC) node->SetString("column-parm",LookupC->getName() );
+
+ mult="";
+ if (multipliers.size() == 0)
+ mult="none";
+
+ for (i=0; i<multipliers.size(); i++) {
+ mult += multipliers[i]->getName();
+ if ( i < multipliers.size()-1 ) mult += " ";
}
+ node->SetString("multipliers",mult);
+
+ node->Tie("SD-norm",this,&FGCoefficient::GetSD );
+ node->Tie("value-lbs",this,&FGCoefficient::GetValue );
+
+ node->Tie("bias", this, &FGCoefficient::getBias,
+ &FGCoefficient::setBias );
+
+ node->Tie("gain", this, &FGCoefficient::getGain,
+ &FGCoefficient::setGain );
- return Value;
}
-/******************************************************************************/
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-float FGCoefficient::TotalValue()
+void FGCoefficient::unbind(void)
{
- switch(type) {
- case 0:
- return -1;
- case 1:
- return (Value());
- case 2:
- return (Value(State->GetParameter(LookupR)));
- case 3:
- return (Value(State->GetParameter(LookupR),State->GetParameter(LookupC)));
- case 4:
- return 0.0;
- }
- return 0;
+ node->Untie("SD-norm");
+ node->Untie("value-lbs");
+ node->Untie("bias");
+ node->Untie("gain");
}
-/******************************************************************************/
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-void FGCoefficient::DumpSD(void)
+FGPropertyManager* FGCoefficient::resolveSymbol(string name)
{
- cout << " " << name << ": " << SD << endl;
+ FGPropertyManager* tmpn;
+
+ tmpn = PropertyManager->GetNode(name,false);
+ if ( !tmpn ) {
+ cerr << "Coefficient multipliers cannot create properties, check spelling?" << endl;
+ exit(1);
+ }
+ return tmpn;
}
-/******************************************************************************/
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+// The bitmasked value choices are as follows:
+// unset: In this case (the default) JSBSim would only print
+// out the normally expected messages, essentially echoing
+// the config files as they are read. If the environment
+// variable is not set, debug_lvl is set to 1 internally
+// 0: This requests JSBSim not to output any messages
+// whatsoever.
+// 1: This value explicity requests the normal JSBSim
+// startup messages
+// 2: This value asks for a message to be printed out when
+// a class is instantiated
+// 4: When this value is set, a message is displayed when a
+// FGModel object executes its Run() method
+// 8: When this value is set, various runtime state variables
+// are printed out periodically
+// 16: When set various parameters are sanity checked and
+// a message is printed out when they go out of bounds
+
+void FGCoefficient::Debug(int from)
+{
+ if (debug_lvl <= 0) return;
+
+ if (debug_lvl & 1) { // Standard console startup message output
+
+ if (from == 2) { // Loading
+ cout << "\n " << highint << underon << name << underoff << normint << endl;
+ cout << " " << description << endl;
+ cout << " " << method << endl;
+
+ if (type == VECTOR || type == TABLE) {
+ cout << " Rows: " << rows << " ";
+ if (type == TABLE) {
+ cout << "Cols: " << columns;
+ }
+ cout << endl << " Row indexing parameter: " << LookupR->getName() << endl;
+ }
+
+ if (type == TABLE) {
+ cout << " Column indexing parameter: " << LookupC->getName() << endl;
+ }
+
+ if (type == VALUE) {
+ cout << " Value = " << StaticValue << endl;
+ } else if (type == VECTOR || type == TABLE) {
+ Table->Print();
+ }
+
+ DisplayCoeffFactors();
+ }
+ }
+ if (debug_lvl & 2 ) { // Instantiation/Destruction notification
+ if (from == 0) cout << "Instantiated: FGCoefficient" << endl;
+ if (from == 1) cout << "Destroyed: FGCoefficient" << endl;
+ }
+ if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
+ }
+ if (debug_lvl & 8 ) { // Runtime state variables
+ }
+ if (debug_lvl & 16) { // Sanity checking
+ }
+ if (debug_lvl & 64) {
+ if (from == 0) { // Constructor
+ cout << IdSrc << endl;
+ cout << IdHdr << endl;
+ }
+ }
+}
+} // namespace JSBSim