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 #  if defined(sgi) && !defined(__GNUC__)
  55 #    include <iomanip.h>
  56 #  else
  57 #    include <iomanip>
  58 #  endif
  59 #else
  60 #  include STL_IOMANIP
  61 #endif
  62
  63 static const char *IdSrc = "$Id$";
  64 static const char *IdHdr = ID_FACTORGROUP;
  65
  66 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  67 CLASS IMPLEMENTATION
  68 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  69
  70 FGFactorGroup::FGFactorGroup( FGFDMExec* fdmex ) : FGCoefficient( fdmex)
  71 {
  72   FDMExec = fdmex;
  73
  74   Debug(0);
  75 }
  76
  77 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  78
  79 FGFactorGroup::~FGFactorGroup()
  80 {
  81   for (unsigned int i=0; i<sum.size(); i++) delete sum[i];
  82
  83   Debug(1);
  84 }
  85
  86 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  87
  88 bool FGFactorGroup::Load(FGConfigFile *AC_cfg)
  89 {
  90   string token;
  91
  92   if (AC_cfg) {
  93     name = AC_cfg->GetValue("NAME");
  94     AC_cfg->GetNextConfigLine();
  95     *AC_cfg >> description;
  96     token = AC_cfg->GetValue();
  97     if (token == "FACTOR") {
  98       FGCoefficient::Load(AC_cfg);
  99     }
 100     token = AC_cfg->GetValue();
 101     while (token != string("/GROUP") ) {
 102       sum.push_back( new FGCoefficient(FDMExec) );
 103       sum.back()->Load(AC_cfg);
 104       token = AC_cfg->GetValue();
 105     }
 106     AC_cfg->GetNextConfigLine();
 107     return true;
 108   } else {
 109     return false;
 110   }
 111 }
 112
 113 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 114
 115 double FGFactorGroup::TotalValue(void)
 116 {
 117   unsigned int i;
 118   double totalsum = 0;
 119   SDtotal = 0.0;
 120   for (i=0; i<sum.size(); i++) {
 121      totalsum += sum[i]->TotalValue();
 122      SDtotal += sum[i]->GetSD();
 123   }
 124   totalsum *= FGCoefficient::TotalValue();
 125   SDtotal *= FGCoefficient::GetSD();
 126   Debug(2);
 127   return totalsum;
 128 }
 129
 130 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 131 //    The bitmasked value choices are as follows:
 132 //    unset: In this case (the default) JSBSim would only print
 133 //       out the normally expected messages, essentially echoing
 134 //       the config files as they are read. If the environment
 135 //       variable is not set, debug_lvl is set to 1 internally
 136 //    0: This requests JSBSim not to output any messages
 137 //       whatsoever.
 138 //    1: This value explicity requests the normal JSBSim
 139 //       startup messages
 140 //    2: This value asks for a message to be printed out when
 141 //       a class is instantiated
 142 //    4: When this value is set, a message is displayed when a
 143 //       FGModel object executes its Run() method
 144 //    8: When this value is set, various runtime state variables
 145 //       are printed out periodically
 146 //    16: When set various parameters are sanity checked and
 147 //       a message is printed out when they go out of bounds
 148
 149 void FGFactorGroup::Debug(int from)
 150 {
 151   if (debug_lvl <= 0) return;
 152
 153   if (debug_lvl & 1) { // Standard console startup message output
 154   }
 155   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 156     if (from == 0) cout << "Instantiated: FGFactorGroup" << endl;
 157     if (from == 1) cout << "Destroyed:    FGFactorGroup" << endl;
 158   }
 159   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 160   }
 161   if (debug_lvl & 8 ) { // Runtime state variables
 162     if (from == 2) {
 163       cout << "FGCoefficient::GetSD(): " << FGCoefficient::GetSD() << endl;
 164       cout << "FGFactorGroup::SDtotal: " << SDtotal << endl;
 165     }
 166   }
 167   if (debug_lvl & 16) { // Sanity checking
 168   }
 169   if (debug_lvl & 64) {
 170     if (from == 0) { // Constructor
 171       cout << IdSrc << endl;
 172       cout << IdHdr << endl;
 173     }
 174   }
 175 }
 176