src/FDM/JSBSim/FGRocket.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGRocket.cpp
   4  Author:       Jon S. Berndt
   5  Date started: 09/12/2000
   6  Purpose:      This module models a rocket engine
   7
   8  ------------- Copyright (C) 2000  Jon S. Berndt (jsb@hal-pc.org) --------------
   9
  10  This program is free software; you can redistribute it and/or modify it under
  11  the terms of the GNU General Public License as published by the Free Software
  12  Foundation; either version 2 of the License, or (at your option) any later
  13  version.
  14
  15  This program is distributed in the hope that it will be useful, but WITHOUT
  16  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  18  details.
  19
  20  You should have received a copy of the GNU General Public License along with
  21  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  22  Place - Suite 330, Boston, MA  02111-1307, USA.
  23
  24  Further information about the GNU General Public License can also be found on
  25  the world wide web at http://www.gnu.org.
  26
  27 FUNCTIONAL DESCRIPTION
  28 --------------------------------------------------------------------------------
  29
  30 This class descends from the FGEngine class and models a rocket engine based on
  31 parameters given in the engine config file for this class
  32
  33 HISTORY
  34 --------------------------------------------------------------------------------
  35 09/12/2000  JSB  Created
  36
  37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #include <sstream>
  42
  43 #include "FGRocket.h"
  44
  45 namespace JSBSim {
  46
  47 static const char *IdSrc = "$Id$";
  48 static const char *IdHdr = ID_ROCKET;
  49
  50 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  51 CLASS IMPLEMENTATION
  52 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  53
  54 FGRocket::FGRocket(FGFDMExec* exec, FGConfigFile* Eng_cfg, int engine_number)
  55   : FGEngine(exec, engine_number)
  56 {
  57   string token;
  58
  59   Name = Eng_cfg->GetValue("NAME");
  60   Eng_cfg->GetNextConfigLine();
  61
  62   while (Eng_cfg->GetValue() != string("/FG_ROCKET")) {
  63     *Eng_cfg >> token;
  64     if      (token == "SHR")           *Eng_cfg >> SHR;
  65     else if (token == "MAX_PC")        *Eng_cfg >> maxPC;
  66     else if (token == "PROP_EFF")      *Eng_cfg >> propEff;
  67     else if (token == "MAXTHROTTLE")   *Eng_cfg >> MaxThrottle;
  68     else if (token == "MINTHROTTLE")   *Eng_cfg >> MinThrottle;
  69     else if (token == "SLFUELFLOWMAX") *Eng_cfg >> SLFuelFlowMax;
  70     else if (token == "SLOXIFLOWMAX")  *Eng_cfg >> SLOxiFlowMax;
  71     else if (token == "VARIANCE")      *Eng_cfg >> Variance;
  72     else cerr << "Unhandled token in Engine config file: " << token << endl;
  73   }
  74
  75   Debug(0);
  76
  77   Type = etRocket;
  78   Flameout = false;
  79
  80   PC = 0.0;
  81   kFactor = (2.0*SHR*SHR/(SHR-1.0))*pow(2.0/(SHR+1), (SHR+1)/(SHR-1));
  82 }
  83
  84 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  85
  86 FGRocket::~FGRocket(void)
  87 {
  88   Debug(1);
  89 }
  90
  91 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  92
  93 double FGRocket::Calculate(void)
  94 {
  95   double Cf=0;
  96
  97   if (!Flameout && !Starved) ConsumeFuel();
  98
  99   Throttle = FCS->GetThrottlePos(EngineNumber);
 100
 101   if (Throttle < MinThrottle || Starved) {
 102     PctPower = Thrust = 0.0; // desired thrust
 103     Flameout = true;
 104     PC = 0.0;
 105   } else {
 106     PctPower = Throttle / MaxThrottle;
 107     PC = maxPC*PctPower * (1.0 + Variance * ((double)rand()/(double)RAND_MAX - 0.5));
 108     // The Cf (below) is CF from Eqn. 3-30, "Rocket Propulsion Elements", Fifth Edition,
 109     // George P. Sutton. Note that the thruster function GetPowerRequired() might
 110     // be better called GetResistance() or something; this function returns the
 111     // nozzle exit pressure.
 112     Cf = sqrt(kFactor*(1 - pow(Thruster->GetPowerRequired()/(PC), (SHR-1)/SHR)));
 113     Flameout = false;
 114   }
 115
 116   return Thrust = Thruster->Calculate(Cf*maxPC*PctPower*propEff);
 117 }
 118
 119 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 120
 121 string FGRocket::GetEngineLabels(string delimeter)
 122 {
 123   std::ostringstream buf;
 124
 125   buf << Name << "_ChamberPress[" << EngineNumber << "]" << delimeter
 126       << Thruster->GetThrusterLabels(EngineNumber, delimeter);
 127
 128   return buf.str();
 129 }
 130
 131 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 132
 133 string FGRocket::GetEngineValues(string delimeter)
 134 {
 135   std::ostringstream buf;
 136
 137   buf << PC << delimeter << Thruster->GetThrusterValues(EngineNumber, delimeter);
 138
 139   return buf.str();
 140 }
 141
 142 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 143 //    The bitmasked value choices are as follows:
 144 //    unset: In this case (the default) JSBSim would only print
 145 //       out the normally expected messages, essentially echoing
 146 //       the config files as they are read. If the environment
 147 //       variable is not set, debug_lvl is set to 1 internally
 148 //    0: This requests JSBSim not to output any messages
 149 //       whatsoever.
 150 //    1: This value explicity requests the normal JSBSim
 151 //       startup messages
 152 //    2: This value asks for a message to be printed out when
 153 //       a class is instantiated
 154 //    4: When this value is set, a message is displayed when a
 155 //       FGModel object executes its Run() method
 156 //    8: When this value is set, various runtime state variables
 157 //       are printed out periodically
 158 //    16: When set various parameters are sanity checked and
 159 //       a message is printed out when they go out of bounds
 160
 161 void FGRocket::Debug(int from)
 162 {
 163   if (debug_lvl <= 0) return;
 164
 165   if (debug_lvl & 1) { // Standard console startup message output
 166     if (from == 0) { // Constructor
 167       cout << "      Engine Name: " << Name << endl;
 168       cout << "      Specific Heat Ratio = " << SHR << endl;
 169       cout << "      Maximum Chamber Pressure = " << maxPC << endl;
 170       cout << "      Propulsive Efficiency = " << propEff << endl;
 171       cout << "      MaxThrottle = " << MaxThrottle << endl;
 172       cout << "      MinThrottle = " << MinThrottle << endl;
 173       cout << "      FuelFlowMax = " << SLFuelFlowMax << endl;
 174       cout << "      OxiFlowMax = " << SLOxiFlowMax << endl;
 175       cout << "      Variance = " << Variance << endl;
 176     }
 177   }
 178   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 179     if (from == 0) cout << "Instantiated: FGRocket" << endl;
 180     if (from == 1) cout << "Destroyed:    FGRocket" << endl;
 181   }
 182   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 183   }
 184   if (debug_lvl & 8 ) { // Runtime state variables
 185   }
 186   if (debug_lvl & 16) { // Sanity checking
 187   }
 188   if (debug_lvl & 64) {
 189     if (from == 0) { // Constructor
 190       cout << IdSrc << endl;
 191       cout << IdHdr << endl;
 192     }
 193   }
 194 }
 195 }