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