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