1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7 ------------- Copyright (C) 1999 Jon S. Berndt (jon@jsbsim.org) -------------
9 This program is free software; you can redistribute it and/or modify it under
10 the terms of the GNU Lesser General Public License as published by the Free Software
11 Foundation; either version 2 of the License, or (at your option) any later
14 This program is distributed in the hope that it will be useful, but WITHOUT
15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License along with
19 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
20 Place - Suite 330, Boston, MA 02111-1307, USA.
22 Further information about the GNU Lesser General Public License can also be found on
23 the world wide web at http://www.gnu.org.
25 FUNCTIONAL DESCRIPTION
26 --------------------------------------------------------------------------------
28 Based on Flightgear code, which is based on LaRCSim. This class simulates
32 --------------------------------------------------------------------------------
35 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
42 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
44 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
46 #include "FGJSBBase.h"
47 #include "input_output/FGXMLFileRead.h"
48 #include "math/FGColumnVector3.h"
52 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
54 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
56 #define ID_ENGINE "$Id$"
58 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
60 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
74 class FGPropertyManager;
76 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
78 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
80 /** Base class for all engines.
81 This base class contains methods and members common to all engines, such as
82 logic to drain fuel from the appropriate tank, etc.
84 <h3>Configuration File Format:</h3>
86 <engine file="{string}">
87 <location unit="{IN | M}">
92 <!-- optional orientation definition -->
93 <orient unit="{RAD | DEG}">
94 <roll> {number} </roll>
95 <pitch> {number} </pitch>
98 <feed> {integer} </feed>
99 ... optional more feed tank index numbers ...
100 <thruster file="{string}">
101 <location unit="{IN | M}">
106 <orient unit="{RAD | DEG}">
107 <roll> {number} </roll>
108 <pitch> {number} </pitch>
109 <yaw> {number} </yaw>
117 Not all thruster types can be matched with a given engine type. See the class
118 documentation for engine and thruster classes.
120 @author Jon S. Berndt
124 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
126 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
128 class FGEngine : public FGJSBBase, public FGXMLFileRead
131 FGEngine(FGFDMExec* exec, Element* el, int engine_number);
134 enum EngineType {etUnknown, etRocket, etPiston, etTurbine, etTurboprop, etElectric};
136 EngineType GetType(void) { return Type; }
137 virtual string GetName(void) { return Name; }
140 virtual double GetThrottleMin(void) { return MinThrottle; }
141 virtual double GetThrottleMax(void) { return MaxThrottle; }
142 virtual double GetThrottle(void) { return Throttle; }
143 virtual double GetMixture(void) { return Mixture; }
144 virtual bool GetStarter(void) { return Starter; }
146 virtual double getFuelFlow_gph () const {return FuelFlow_gph;}
147 virtual double getFuelFlow_pph () const {return FuelFlow_pph;}
148 virtual double GetFuelFlowRate(void) const {return FuelFlowRate;}
149 virtual bool GetStarved(void) { return Starved; }
150 virtual bool GetRunning(void) const { return Running; }
151 virtual bool GetCranking(void) { return Cranking; }
153 virtual void SetStarved(bool tt) { Starved = tt; }
154 virtual void SetStarved(void) { Starved = true; }
156 virtual void SetRunning(bool bb) { Running=bb; }
157 virtual void SetName(string name) { Name = name; }
158 virtual void AddFeedTank(int tkID, int priority);
159 virtual void SetFuelFreeze(bool f) { FuelFreeze = f; }
161 virtual void SetStarter(bool s) { Starter = s; }
163 virtual int InitRunning(void){ return 1; }
165 /** Resets the Engine parameters to the initial conditions */
166 void ResetToIC(void);
168 /** Calculates the thrust of the engine, and other engine functions.
169 @return Thrust in pounds */
170 virtual double Calculate(void) {return 0.0;}
172 /// Sets engine placement information
173 virtual void SetPlacement(FGColumnVector3& location, FGColumnVector3& orientation);
175 virtual double GetPowerAvailable(void) {return 0.0;};
177 virtual bool GetTrimMode(void) {return TrimMode;}
178 virtual void SetTrimMode(bool state) {TrimMode = state;}
180 virtual FGColumnVector3& GetBodyForces(void);
181 virtual FGColumnVector3& GetMoments(void);
183 bool LoadThruster(Element *el);
184 FGThruster* GetThruster(void) {return Thruster;}
186 virtual std::string GetEngineLabels(const std::string& delimiter) = 0;
187 virtual std::string GetEngineValues(const std::string& delimiter) = 0;
190 /** Reduces the fuel in the active tanks by the amount required.
191 This function should be called from within the
192 derived class' Calculate() function before any other calculations are
193 done. This base class method removes fuel from the fuel tanks as
194 appropriate, and sets the starved flag if necessary. */
195 virtual void ConsumeFuel(void);
197 /** The fuel need is calculated based on power levels and flow rate for that
198 power level. It is also turned from a rate into an actual amount (pounds)
199 by multiplying it by the delta T and the rate.
200 @return Total fuel requirement for this engine in pounds. */
201 virtual double CalcFuelNeed(void);
203 FGPropertyManager* PropertyManager;
205 const int EngineNumber;
210 double SLFuelFlowMax;
232 FGAtmosphere* Atmosphere;
234 FGPropulsion* Propulsion;
235 FGAircraft* Aircraft;
236 FGPropagate* Propagate;
237 FGAuxiliary* Auxiliary;
238 FGThruster* Thruster;
240 std::vector <int> SourceTanks;
241 void Debug(int from);
245 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%