src/FDM/JSBSim/FGNozzle.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGNozzle.cpp
   4  Author:       Jon S. Berndt
   5  Date started: 08/24/00
   6  Purpose:      Encapsulates the nozzle object
   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 HISTORY
  31 --------------------------------------------------------------------------------
  32 08/24/00  JSB  Created
  33
  34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  35 INCLUDES
  36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  37
  38 #ifdef FGFS
  39 #  include <simgear/compiler.h>
  40 #  include STL_ALGORITHM
  41 #else
  42 #  include <algorithm>
  43 #endif
  44
  45 #include "FGNozzle.h"
  46
  47 namespace JSBSim {
  48
  49 static const char *IdSrc = "$Id$";
  50 static const char *IdHdr = ID_NOZZLE;
  51
  52 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  53 CLASS IMPLEMENTATION
  54 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  55
  56
  57 FGNozzle::FGNozzle(FGFDMExec* FDMExec, FGConfigFile* Nzl_cfg) : FGThruster(FDMExec)
  58 {
  59   string token;
  60
  61   Name = Nzl_cfg->GetValue("NAME");
  62   Nzl_cfg->GetNextConfigLine();
  63   while (Nzl_cfg->GetValue() != string("/FG_NOZZLE")) {
  64     *Nzl_cfg >> token;
  65     if      (token == "PE")      *Nzl_cfg >> PE;
  66     else if (token == "EXPR")    *Nzl_cfg >> ExpR;
  67     else if (token == "NZL_EFF") *Nzl_cfg >> nzlEff;
  68     else if (token == "DIAM")    *Nzl_cfg >> Diameter;
  69     else cerr << "Unhandled token in Nozzle config file: " << token << endl;
  70   }
  71
  72   Thrust = 0;
  73   Type = ttNozzle;
  74   Area2 = (Diameter*Diameter/4.0)*M_PI;
  75   AreaT = Area2/ExpR;
  76
  77   Debug(0);
  78 }
  79
  80 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  81
  82 FGNozzle::~FGNozzle()
  83 {
  84   Debug(1);
  85 }
  86
  87 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  88
  89 double FGNozzle::Calculate(double CfPc)
  90 {
  91   double pAtm = fdmex->GetAtmosphere()->GetPressure();
  92   Thrust = max((double)0.0, (CfPc * AreaT + (PE - pAtm)*Area2) * nzlEff);
  93   vFn(1) = Thrust;
  94
  95   return Thrust;
  96 }
  97
  98 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  99
 100 double FGNozzle::GetPowerRequired(void)
 101 {
 102   return PE;
 103 }
 104
 105 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 106 //    The bitmasked value choices are as follows:
 107 //    unset: In this case (the default) JSBSim would only print
 108 //       out the normally expected messages, essentially echoing
 109 //       the config files as they are read. If the environment
 110 //       variable is not set, debug_lvl is set to 1 internally
 111 //    0: This requests JSBSim not to output any messages
 112 //       whatsoever.
 113 //    1: This value explicity requests the normal JSBSim
 114 //       startup messages
 115 //    2: This value asks for a message to be printed out when
 116 //       a class is instantiated
 117 //    4: When this value is set, a message is displayed when a
 118 //       FGModel object executes its Run() method
 119 //    8: When this value is set, various runtime state variables
 120 //       are printed out periodically
 121 //    16: When set various parameters are sanity checked and
 122 //       a message is printed out when they go out of bounds
 123
 124 void FGNozzle::Debug(int from)
 125 {
 126   if (debug_lvl <= 0) return;
 127
 128   if (debug_lvl & 1) { // Standard console startup message output
 129     if (from == 0) { // Constructor
 130       cout << "      Nozzle Name: " << Name << endl;
 131       cout << "      Nozzle Exit Pressure = " << PE << endl;
 132       cout << "      Nozzle Expansion Ratio = " << ExpR << endl;
 133       cout << "      Nozzle Efficiency = " << nzlEff << endl;
 134       cout << "      Nozzle Diameter = " << Diameter << endl;
 135     }
 136   }
 137   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 138     if (from == 0) cout << "Instantiated: FGNozzle" << endl;
 139     if (from == 1) cout << "Destroyed:    FGNozzle" << endl;
 140   }
 141   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 142   }
 143   if (debug_lvl & 8 ) { // Runtime state variables
 144   }
 145   if (debug_lvl & 16) { // Sanity checking
 146   }
 147   if (debug_lvl & 64) {
 148     if (from == 0) { // Constructor
 149       cout << IdSrc << endl;
 150       cout << IdHdr << endl;
 151     }
 152   }
 153 }
 154 }