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