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, int num) : 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   Type = ttNozzle;
  70   Area2 = (Diameter*Diameter/4.0)*M_PI;
  71   AreaT = Area2/ExpR;
  72
  73   char property_name[80];
  74   snprintf(property_name, 80, "propulsion/c-thrust[%u]", EngineNum);
  75   PropertyManager->Tie( property_name, &ThrustCoeff );
  76
  77   Debug(0);
  78 }
  79
  80 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  81
  82 FGNozzle::~FGNozzle()
  83 {
  84   char property_name[80];
  85   snprintf(property_name, 80, "propulsion/c-thrust[%u]", EngineNum);
  86   PropertyManager->Untie( property_name );
  87
  88   Debug(1);
  89 }
  90
  91 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  92
  93 double FGNozzle::Calculate(double CfPc)
  94 {
  95   double pAtm = fdmex->GetAtmosphere()->GetPressure();
  96   Thrust = max((double)0.0, (CfPc * AreaT + (PE - pAtm)*Area2) * nzlEff);
  97   vFn(1) = Thrust;
  98
  99   ThrustCoeff = max((double)0.0, CfPc / ((pAtm - PE) * Area2));
 100
 101   return Thrust;
 102 }
 103
 104 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 105
 106 double FGNozzle::GetPowerRequired(void)
 107 {
 108   return PE;
 109 }
 110
 111 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 112
 113 string FGNozzle::GetThrusterLabels(int id, string delimeter)
 114 {
 115   std::ostringstream buf;
 116
 117   buf << Name << "_Thrust[" << id << ']';
 118
 119   return buf.str();
 120 }
 121
 122 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 123
 124 string FGNozzle::GetThrusterValues(int id, string delimeter)
 125 {
 126   std::ostringstream buf;
 127
 128   buf << Thrust;
 129
 130   return buf.str();
 131 }
 132
 133 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 134 //    The bitmasked value choices are as follows:
 135 //    unset: In this case (the default) JSBSim would only print
 136 //       out the normally expected messages, essentially echoing
 137 //       the config files as they are read. If the environment
 138 //       variable is not set, debug_lvl is set to 1 internally
 139 //    0: This requests JSBSim not to output any messages
 140 //       whatsoever.
 141 //    1: This value explicity requests the normal JSBSim
 142 //       startup messages
 143 //    2: This value asks for a message to be printed out when
 144 //       a class is instantiated
 145 //    4: When this value is set, a message is displayed when a
 146 //       FGModel object executes its Run() method
 147 //    8: When this value is set, various runtime state variables
 148 //       are printed out periodically
 149 //    16: When set various parameters are sanity checked and
 150 //       a message is printed out when they go out of bounds
 151
 152 void FGNozzle::Debug(int from)
 153 {
 154   if (debug_lvl <= 0) return;
 155
 156   if (debug_lvl & 1) { // Standard console startup message output
 157     if (from == 0) { // Constructor
 158       cout << "      Nozzle Name: " << Name << endl;
 159       cout << "      Nozzle Exit Pressure = " << PE << endl;
 160       cout << "      Nozzle Expansion Ratio = " << ExpR << endl;
 161       cout << "      Nozzle Efficiency = " << nzlEff << endl;
 162       cout << "      Nozzle Diameter = " << Diameter << endl;
 163     }
 164   }
 165   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 166     if (from == 0) cout << "Instantiated: FGNozzle" << endl;
 167     if (from == 1) cout << "Destroyed:    FGNozzle" << endl;
 168   }
 169   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 170   }
 171   if (debug_lvl & 8 ) { // Runtime state variables
 172   }
 173   if (debug_lvl & 16) { // Sanity checking
 174   }
 175   if (debug_lvl & 64) {
 176     if (from == 0) { // Constructor
 177       cout << IdSrc << endl;
 178       cout << IdHdr << endl;
 179     }
 180   }
 181 }
 182 }