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