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