src/FDM/JSBSim/FGFactorGroup.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGFactorGroup.cpp
   4  Author:       Tony Peden
   5  Date started: 7/21/01
   6  Purpose:      Encapsulates coefficients in the mathematical construct:
   7                factor*(coeff1 + coeff2 + coeff3 + ... + coeffn)
   8  Called by:    FGAerodynamics
   9
  10  ------------- Copyright (C) 2001 Tony Peden (apeden@earthlink.net) -----------
  11
  12  This program is free software; you can redistribute it and/or modify it under
  13  the terms of the GNU General Public License as published by the Free Software
  14  Foundation; either version 2 of the License, or (at your option) any later
  15  version.
  16
  17  This program is distributed in the hope that it will be useful, but WITHOUT
  18  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  19  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  20  details.
  21
  22  You should have received a copy of the GNU General Public License along with
  23  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  24  Place - Suite 330, Boston, MA  02111-1307, USA.
  25
  26  Further information about the GNU General Public License can also be found on
  27  the world wide web at http://www.gnu.org.
  28
  29 FUNCTIONAL DESCRIPTION
  30 --------------------------------------------------------------------------------
  31 This class models the stability derivative coefficient lookup tables or
  32 equations. Note that the coefficients need not be calculated each delta-t.
  33
  34 Note that the values in a row which index into the table must be the same value
  35 for each column of data, so the first column of numbers for each altitude are
  36 seen to be equal, and there are the same number of values for each altitude.
  37
  38 See the header file FGFactorGroup.h for the values of the identifiers.
  39
  40 HISTORY
  41 --------------------------------------------------------------------------------
  42 7/21/01   TP  Created
  43
  44 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  45 INCLUDES
  46 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  47
  48 #include "FGCoefficient.h"
  49 #include "FGFactorGroup.h"
  50 #include "FGState.h"
  51 #include "FGFDMExec.h"
  52
  53 #ifndef FGFS
  54 #  include <iomanip>
  55 #else
  56 #  include STL_IOMANIP
  57 #endif
  58
  59 extern short debug_lvl;
  60
  61 static const char *IdSrc = "$Id$";
  62 static const char *IdHdr = ID_FACTORGROUP;
  63
  64 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  65 CLASS IMPLEMENTATION
  66 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  67
  68 FGFactorGroup::FGFactorGroup( FGFDMExec* fdmex ) : FGCoefficient( fdmex) {
  69   FDMExec=fdmex;
  70 }
  71
  72 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  73
  74 FGFactorGroup::~FGFactorGroup() {
  75     int i;
  76     for (i=0; i<sum.size(); i++) {
  77       delete sum[i];
  78     }
  79 }
  80
  81 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  82
  83 bool FGFactorGroup::Load(FGConfigFile *AC_cfg) {
  84   string token;
  85
  86   if(AC_cfg) {
  87     name = AC_cfg->GetValue("NAME");
  88     AC_cfg->GetNextConfigLine();
  89     *AC_cfg >> description;
  90     token = AC_cfg->GetValue();
  91     if( token == "FACTOR") {
  92       FGCoefficient::Load(AC_cfg);
  93       //if (debug_lvl > 0) DisplayCoeffFactors(ca.back()->Getmultipliers());
  94     }
  95     token = AC_cfg->GetValue();
  96     while ( token != "/GROUP" ) {
  97           sum.push_back( new FGCoefficient(FDMExec) );
  98           sum.back()->Load(AC_cfg);
  99           //if (debug_lvl > 0) DisplayCoeffFactors(ca.back()->Getmultipliers());
 100           token = AC_cfg->GetValue();
 101     }
 102     AC_cfg->GetNextConfigLine();
 103     return true;
 104   } else {
 105     return false;
 106   }
 107 }
 108
 109 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 110
 111 float FGFactorGroup::TotalValue(void) {
 112   int i;
 113   float totalsum=0;
 114   SDtotal=0.0;
 115   for(i=0;i<sum.size();i++) {
 116      totalsum+=sum[i]->TotalValue();
 117      SDtotal += sum[i]->GetSD();
 118   }
 119   totalsum *= FGCoefficient::TotalValue();
 120   SDtotal *= FGCoefficient::GetSD();
 121 //   cout << "FGCoefficient::GetSD(): " << FGCoefficient::GetSD() << endl;
 122 //   cout << "FGFactorGroup::SDtotal: " << SDtotal << endl;
 123   return totalsum;
 124 }
 125
 126 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 127
 128 string FGFactorGroup::GetCoefficientStrings(void) {
 129   int i;
 130   string CoeffStrings;
 131
 132   CoeffStrings += name;
 133   CoeffStrings += ", ";
 134   CoeffStrings += FGCoefficient::Getname();
 135   for(i=0;i<sum.size();i++) {
 136     CoeffStrings += ", ";
 137     CoeffStrings += sum[i]->Getname();
 138   }
 139   return CoeffStrings;
 140 }
 141
 142 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 143
 144 string FGFactorGroup::GetCoefficientValues(void) {
 145     int i;
 146     char buffer[10];
 147     string values;
 148
 149     snprintf(buffer,10,"%9.6f",SDtotal);
 150     values += string(buffer);
 151     values += ", ";
 152     snprintf(buffer,10,"%9.6f",FGCoefficient::GetSD() );
 153     values += string(buffer);
 154     values += ", ";
 155     for(i=0;i<sum.size();i++) {
 156        values += sum[i]->GetCoefficientValues();
 157     }
 158     return values;
 159 }
 160