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