]> git.mxchange.org Git - flightgear.git/blob - src/FDM/JSBSim/FGEngine.cpp
Square the /environment/turbulence-norm property before scaling it for
[flightgear.git] / src / FDM / JSBSim / FGEngine.cpp
1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2  
3  Module:       FGEngine.cpp
4  Author:       Jon Berndt
5  Date started: 01/21/99
6  Called by:    FGAircraft
7  
8  ------------- Copyright (C) 1999  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 See header file.
30  
31 HISTORY
32 --------------------------------------------------------------------------------
33 01/21/99   JSB   Created
34 09/03/99   JSB   Changed Rocket thrust equation to correct -= Thrust instead of
35                  += Thrust (thanks to Tony Peden)
36  
37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
38 INCLUDES
39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
40
41 #ifdef FGFS
42 #  include <simgear/compiler.h>
43 #  ifdef SG_HAVE_STD_INCLUDES
44 #    include <fstream>
45 #  else
46 #    include <fstream.h>
47 #  endif
48 #else
49 #  if defined(sgi) && !defined(__GNUC__)
50 #    include <fstream.h>
51 #  else
52 #    include <fstream>
53 #  endif
54 #endif
55
56 #include "FGEngine.h"
57 #include "FGTank.h"
58
59 namespace JSBSim {
60
61 static const char *IdSrc = "$Id$";
62 static const char *IdHdr = ID_ENGINE;
63
64 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
65 CLASS IMPLEMENTATION
66 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
67
68
69 FGEngine::FGEngine(FGFDMExec* exec)
70   : Name(""),
71     Type(etUnknown),
72     X(0), Y(0), Z(0),
73     EnginePitch(0), EngineYaw(0),
74     SLFuelFlowMax(0), SLOxiFlowMax(0),
75     MaxThrottle(1.0), MinThrottle(0.0),
76     Thrust(0.0),
77     Throttle(0.0),
78     Mixture(1.0),
79     Magnetos(0),
80     Starter(false),
81     FuelNeed(0.0), OxidizerNeed(0.0),
82     Starved(false), Flameout(false), Running(false), Cranking(false),
83     PctPower(0.0),
84     EngineNumber(-1),
85     TrimMode(false),
86     FuelFlow_gph(0.0),
87     ManifoldPressure_inHg(0.0),
88     ExhaustGasTemp_degK(0.0),
89     CylinderHeadTemp_degK(0.0),
90     OilPressure_psi(0.0),
91     OilTemp_degK(0.0),
92     FDMExec(exec),
93     State(FDMExec->GetState()),
94     Atmosphere(FDMExec->GetAtmosphere()),
95     FCS(FDMExec->GetFCS()),
96     Propulsion(FDMExec->GetPropulsion()),
97     Aircraft(FDMExec->GetAircraft()),
98     Translation(FDMExec->GetTranslation()),
99     Rotation(FDMExec->GetRotation()),
100     Position(FDMExec->GetPosition()),
101     Auxiliary(FDMExec->GetAuxiliary()),
102     Output(FDMExec->GetOutput())
103 {
104   Debug(0);
105 }
106
107 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
108
109 FGEngine::~FGEngine()
110 {
111   Debug(1);
112 }
113
114 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
115 // This base class function should be called from within the
116 // derived class' Calculate() function before any other calculations are done.
117 // This base class method removes fuel from the fuel tanks as appropriate,
118 // and sets the starved flag if necessary.
119
120 void FGEngine::ConsumeFuel(void)
121 {
122   double Fshortage, Oshortage;
123   FGTank* Tank;
124
125   if (TrimMode) return;
126   Fshortage = Oshortage = 0.0;
127   for (unsigned int i=0; i<SourceTanks.size(); i++) {
128     Tank = Propulsion->GetTank(i);
129     if (Tank->GetType() == FGTank::ttFUEL) {
130       Fshortage += Tank->Reduce(CalcFuelNeed()/Propulsion->GetnumSelectedFuelTanks());
131     } else {
132       Oshortage += Tank->Reduce(CalcOxidizerNeed()/Propulsion->GetnumSelectedOxiTanks());
133     }
134   }
135
136   if (Fshortage < 0.00 || Oshortage < 0.00) Starved = true;
137   else Starved = false;
138 }
139
140 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
141
142 double FGEngine::CalcFuelNeed(void) {
143   FuelNeed = SLFuelFlowMax*PctPower*State->Getdt()*Propulsion->GetRate();
144   return FuelNeed;
145 }
146
147 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
148
149 double FGEngine::CalcOxidizerNeed(void) {
150   OxidizerNeed = SLOxiFlowMax*PctPower*State->Getdt()*Propulsion->GetRate();
151   return OxidizerNeed;
152 }
153
154 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
155
156 void FGEngine::SetPlacement(double x, double y, double z, double pitch, double yaw) {
157   X = x;
158   Y = y;
159   Z = z;
160   EnginePitch = pitch;
161   EngineYaw = yaw;
162 }
163
164 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
165
166 void FGEngine::AddFeedTank(int tkID)
167 {
168   SourceTanks.push_back(tkID);
169 }
170
171 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
172 //    The bitmasked value choices are as follows:
173 //    unset: In this case (the default) JSBSim would only print
174 //       out the normally expected messages, essentially echoing
175 //       the config files as they are read. If the environment
176 //       variable is not set, debug_lvl is set to 1 internally
177 //    0: This requests JSBSim not to output any messages
178 //       whatsoever.
179 //    1: This value explicity requests the normal JSBSim
180 //       startup messages
181 //    2: This value asks for a message to be printed out when
182 //       a class is instantiated
183 //    4: When this value is set, a message is displayed when a
184 //       FGModel object executes its Run() method
185 //    8: When this value is set, various runtime state variables
186 //       are printed out periodically
187 //    16: When set various parameters are sanity checked and
188 //       a message is printed out when they go out of bounds
189
190 void FGEngine::Debug(int from)
191 {
192   if (debug_lvl <= 0) return;
193
194   if (debug_lvl & 1) { // Standard console startup message output
195     if (from == 0) { // Constructor
196
197     }
198   }
199   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
200     if (from == 0) cout << "Instantiated: FGEngine" << endl;
201     if (from == 1) cout << "Destroyed:    FGEngine" << endl;
202   }
203   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
204   }
205   if (debug_lvl & 8 ) { // Runtime state variables
206   }
207   if (debug_lvl & 16) { // Sanity checking
208   }
209   if (debug_lvl & 64) {
210     if (from == 0) { // Constructor
211       cout << IdSrc << endl;
212       cout << IdHdr << endl;
213     }
214   }
215 }
216 }