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 "FGRocket.h"
  42
  43 static const char *IdSrc = "$Id$";
  44 static const char *IdHdr = ID_ROCKET;
  45
  46 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  47 CLASS IMPLEMENTATION
  48 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  49
  50 FGRocket::FGRocket(FGFDMExec* exec, FGConfigFile* Eng_cfg) : FGEngine(exec)
  51 {
  52   string token;
  53
  54   Name = Eng_cfg->GetValue("NAME");
  55   Eng_cfg->GetNextConfigLine();
  56
  57   while (Eng_cfg->GetValue() != string("/FG_ROCKET")) {
  58     *Eng_cfg >> token;
  59     if      (token == "SHR")           *Eng_cfg >> SHR;
  60     else if (token == "MAX_PC")        *Eng_cfg >> maxPC;
  61     else if (token == "PROP_EFF")      *Eng_cfg >> propEff;
  62     else if (token == "MAXTHROTTLE")   *Eng_cfg >> MaxThrottle;
  63     else if (token == "MINTHROTTLE")   *Eng_cfg >> MinThrottle;
  64     else if (token == "SLFUELFLOWMAX") *Eng_cfg >> SLFuelFlowMax;
  65     else if (token == "SLOXIFLOWMAX")  *Eng_cfg >> SLOxiFlowMax;
  66     else if (token == "VARIANCE")      *Eng_cfg >> Variance;
  67     else cerr << "Unhandled token in Engine config file: " << token << endl;
  68   }
  69
  70   Debug(0);
  71
  72   EngineNumber = 0;
  73   Type = etRocket;
  74
  75   PC = 0.0;
  76   kFactor = (2.0*SHR*SHR/(SHR-1.0))*pow(2.0/(SHR+1), (SHR+1)/(SHR-1));
  77 }
  78
  79 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  80
  81 FGRocket::~FGRocket()
  82 {
  83   Debug(1);
  84 }
  85
  86 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  87
  88 double FGRocket::Calculate(double pe)
  89 {
  90   double Cf=0;
  91
  92   ConsumeFuel();
  93
  94   Throttle = FCS->GetThrottlePos(EngineNumber);
  95
  96   if (Throttle < MinThrottle || Starved) {
  97     PctPower = Thrust = 0.0; // desired thrust
  98     Flameout = true;
  99     PC = 0.0;
 100   } else {
 101     PctPower = Throttle / MaxThrottle;
 102     PC = maxPC*PctPower * (1.0 + Variance * ((double)rand()/(double)RAND_MAX - 0.5));
 103     Cf = sqrt(kFactor*(1 - pow(pe/(PC), (SHR-1)/SHR)));
 104     Flameout = false;
 105   }
 106
 107   return Cf*maxPC*PctPower*propEff;
 108 }
 109
 110 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 111 //    The bitmasked value choices are as follows:
 112 //    unset: In this case (the default) JSBSim would only print
 113 //       out the normally expected messages, essentially echoing
 114 //       the config files as they are read. If the environment
 115 //       variable is not set, debug_lvl is set to 1 internally
 116 //    0: This requests JSBSim not to output any messages
 117 //       whatsoever.
 118 //    1: This value explicity requests the normal JSBSim
 119 //       startup messages
 120 //    2: This value asks for a message to be printed out when
 121 //       a class is instantiated
 122 //    4: When this value is set, a message is displayed when a
 123 //       FGModel object executes its Run() method
 124 //    8: When this value is set, various runtime state variables
 125 //       are printed out periodically
 126 //    16: When set various parameters are sanity checked and
 127 //       a message is printed out when they go out of bounds
 128
 129 void FGRocket::Debug(int from)
 130 {
 131   if (debug_lvl <= 0) return;
 132
 133   if (debug_lvl & 1) { // Standard console startup message output
 134     if (from == 0) { // Constructor
 135       cout << "      Engine Name: " << Name << endl;
 136       cout << "      Specific Heat Ratio = " << SHR << endl;
 137       cout << "      Maximum Chamber Pressure = " << maxPC << endl;
 138       cout << "      Propulsive Efficiency = " << propEff << endl;
 139       cout << "      MaxThrottle = " << MaxThrottle << endl;
 140       cout << "      MinThrottle = " << MinThrottle << endl;
 141       cout << "      FuelFlowMax = " << SLFuelFlowMax << endl;
 142       cout << "      OxiFlowMax = " << SLOxiFlowMax << endl;
 143       cout << "      Variance = " << Variance << endl;
 144     }
 145   }
 146   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 147     if (from == 0) cout << "Instantiated: FGRocket" << endl;
 148     if (from == 1) cout << "Destroyed:    FGRocket" << endl;
 149   }
 150   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 151   }
 152   if (debug_lvl & 8 ) { // Runtime state variables
 153   }
 154   if (debug_lvl & 16) { // Sanity checking
 155   }
 156   if (debug_lvl & 64) {
 157     if (from == 0) { // Constructor
 158       cout << IdSrc << endl;
 159       cout << IdHdr << endl;
 160     }
 161   }
 162 }
 163