1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 Module: FGTurboProp.cpp
4 Author: Jiri "Javky" Javurek
5 based on SimTurbine and Turbine engine from David Culp
6 Date started: 05/14/2004
7 Purpose: This module models a turbo propeller engine.
9 ------------- Copyright (C) 2004 (javky@email.cz) ---------
11 This program is free software; you can redistribute it and/or modify it under
12 the terms of the GNU Lesser General Public License as published by the Free Software
13 Foundation; either version 2 of the License, or (at your option) any later
16 This program is distributed in the hope that it will be useful, but WITHOUT
17 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
21 You should have received a copy of the GNU Lesser General Public License along with
22 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
23 Place - Suite 330, Boston, MA 02111-1307, USA.
25 Further information about the GNU Lesser General Public License can also be found on
26 the world wide web at http://www.gnu.org.
28 FUNCTIONAL DESCRIPTION
29 --------------------------------------------------------------------------------
31 This class descends from the FGEngine class and models a Turbo propeller engine
32 based on parameters given in the engine config file for this class
35 --------------------------------------------------------------------------------
37 02/08/2011 T. Kreitler, added rotor support
41 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
43 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
48 #include "FGTurboProp.h"
49 #include "FGPropeller.h"
56 static const char *IdSrc = "$Id: FGTurboProp.cpp,v 1.22 2011/08/04 13:45:42 jberndt Exp $";
57 static const char *IdHdr = ID_TURBOPROP;
59 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
61 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
63 FGTurboProp::FGTurboProp(FGFDMExec* exec, Element *el, int engine_number, struct Inputs& input)
64 : FGEngine(exec, el, engine_number, input),
65 ITT_N1(NULL), EnginePowerRPM_N1(NULL), EnginePowerVC(NULL)
68 thrusterType = Thruster->GetType();
75 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
77 FGTurboProp::~FGTurboProp()
80 delete EnginePowerRPM_N1;
85 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
87 bool FGTurboProp::Load(FGFDMExec* exec, Element *el)
90 MaxStartingTime = 999999; //very big timeout -> infinite
93 // ToDo: Need to make sure units are properly accounted for below.
95 if (el->FindElement("milthrust"))
96 MilThrust = el->FindElementValueAsNumberConvertTo("milthrust","LBS");
97 if (el->FindElement("idlen1"))
98 IdleN1 = el->FindElementValueAsNumber("idlen1");
99 if (el->FindElement("idlen2"))
100 IdleN2 = el->FindElementValueAsNumber("idlen2");
101 if (el->FindElement("maxn1"))
102 MaxN1 = el->FindElementValueAsNumber("maxn1");
103 if (el->FindElement("maxn2"))
104 MaxN2 = el->FindElementValueAsNumber("maxn2");
105 if (el->FindElement("betarangeend"))
106 BetaRangeThrottleEnd = el->FindElementValueAsNumber("betarangeend")/100.0;
107 BetaRangeThrottleEnd = Constrain(0.0, BetaRangeThrottleEnd, 0.99999);
108 if (el->FindElement("reversemaxpower"))
109 ReverseMaxPower = el->FindElementValueAsNumber("reversemaxpower")/100.0;
111 if (el->FindElement("maxpower"))
112 MaxPower = el->FindElementValueAsNumber("maxpower");
113 if (el->FindElement("idlefuelflow"))
114 IdleFF = el->FindElementValueAsNumber("idlefuelflow");
115 if (el->FindElement("psfc"))
116 PSFC = el->FindElementValueAsNumber("psfc");
117 if (el->FindElement("n1idle_max_delay"))
118 Idle_Max_Delay = el->FindElementValueAsNumber("n1idle_max_delay");
119 if (el->FindElement("maxstartingtime"))
120 MaxStartingTime = el->FindElementValueAsNumber("maxstartingtime");
121 if (el->FindElement("startern1"))
122 StarterN1 = el->FindElementValueAsNumber("startern1");
123 if (el->FindElement("ielumaxtorque"))
124 Ielu_max_torque = el->FindElementValueAsNumber("ielumaxtorque");
125 if (el->FindElement("itt_delay"))
126 ITT_Delay = el->FindElementValueAsNumber("itt_delay");
128 Element *table_element;
130 FGPropertyManager* PropertyManager = exec->GetPropertyManager();
133 table_element = el->FindNextElement("table");
134 if (!table_element) break;
135 name = table_element->GetAttributeValue("name");
136 if (name == "EnginePowerVC") {
137 EnginePowerVC = new FGTable(PropertyManager, table_element);
138 } else if (name == "EnginePowerRPM_N1") {
139 EnginePowerRPM_N1 = new FGTable(PropertyManager, table_element);
140 } else if (name == "ITT_N1") {
141 ITT_N1 = new FGTable(PropertyManager, table_element);
143 cerr << "Unknown table type: " << name << " in turbine definition." <<
148 // Pre-calculations and initializations
151 N1_factor = MaxN1 - IdleN1;
152 N2_factor = MaxN2 - IdleN2;
153 OilTemp_degK = in.TAT_c + 273.0;
154 if (IdleFF==-1) IdleFF = pow(MilThrust, 0.2) * 107.0; // just an estimate
156 // cout << "ENG POWER:" << EnginePowerRPM_N1->GetValue(1200,90) << endl;
161 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
162 // The main purpose of Calculate() is to determine what phase the engine should
163 // be in, then call the corresponding function.
165 void FGTurboProp::Calculate(void)
171 ThrottlePos = in.ThrottlePos[EngineNumber];
173 RPM = Thruster->GetRPM() * Thruster->GetGearRatio();
174 if (thrusterType == FGThruster::ttPropeller) {
175 ((FGPropeller*)Thruster)->SetAdvance(in.PropAdvance[EngineNumber]);
176 ((FGPropeller*)Thruster)->SetFeather(in.PropFeather[EngineNumber]);
177 ((FGPropeller*)Thruster)->SetReverse(Reversed);
179 ((FGPropeller*)Thruster)->SetReverseCoef(ThrottlePos);
181 ((FGPropeller*)Thruster)->SetReverseCoef(0.0);
185 if (ThrottlePos < BetaRangeThrottleEnd) {
186 ThrottlePos = 0.0; // idle when in Beta-range
189 ThrottlePos = (ThrottlePos-BetaRangeThrottleEnd)/(1-BetaRangeThrottleEnd) * ReverseMaxPower;
194 // When trimming is finished check if user wants engine OFF or RUNNING
195 if ((phase == tpTrim) && (in.TotalDeltaT > 0)) {
196 if (Running && !Starved) {
200 OilTemp_degK = 366.0;
206 Eng_Temperature = TAT;
207 OilTemp_degK = TAT+273.15;
211 if (!Running && Starter) {
212 if (phase == tpOff) {
214 if (StartTime < 0) StartTime=0;
217 if (!Running && !Cutoff && (N1 > 15.0)) {
221 if (Cutoff && (phase != tpSpinUp)) phase = tpOff;
222 if (in.TotalDeltaT == 0) phase = tpTrim;
223 if (Starved) phase = tpOff;
224 if (Condition >= 10) {
229 // limiter intervention wanted?
230 if (Ielu_max_torque > 0.0) {
233 if (thrusterType == FGThruster::ttPropeller) {
234 torque = ((FGPropeller*)(Thruster))->GetTorque();
235 } else if (thrusterType == FGThruster::ttRotor) {
236 torque = ((FGRotor*)(Thruster))->GetTorque();
240 if ( abs(torque) > Ielu_max_torque && ThrottlePos >= OldThrottle ) {
241 ThrottlePos = OldThrottle - 0.1 * in.TotalDeltaT; //IELU down
242 Ielu_intervent = true;
243 } else if ( Ielu_intervent && ThrottlePos >= OldThrottle) {
244 ThrottlePos = OldThrottle + 0.05 * in.TotalDeltaT; //IELU up
245 Ielu_intervent = true;
247 Ielu_intervent = false;
250 Ielu_intervent = false;
252 OldThrottle = ThrottlePos;
256 case tpOff: HP = Off(); break;
257 case tpRun: HP = Run(); break;
258 case tpSpinUp: HP = SpinUp(); break;
259 case tpStart: HP = Start(); break;
263 LoadThrusterInputs();
264 Thruster->Calculate(HP * hptoftlbssec);
269 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
271 double FGTurboProp::Off(void)
273 Running = false; EngStarting = false;
275 FuelFlow_pph = Seek(&FuelFlow_pph, 0, 800.0, 800.0);
277 //allow the air turn with generator
278 N1 = ExpSeek(&N1, in.qbar/15.0, Idle_Max_Delay*2.5, Idle_Max_Delay * 5);
280 OilTemp_degK = ExpSeek(&OilTemp_degK,273.15 + TAT, 400 , 400);
282 Eng_Temperature = ExpSeek(&Eng_Temperature,TAT,300,400);
283 double ITT_goal = ITT_N1->GetValue(N1,0.1) + ((N1>20) ? 0.0 : (20-N1)/20.0 * Eng_Temperature);
284 Eng_ITT_degC = ExpSeek(&Eng_ITT_degC,ITT_goal,ITT_Delay,ITT_Delay*1.2);
286 OilPressure_psi = (N1/100.0*0.25+(0.1-(OilTemp_degK-273.15)*0.1/80.0)*N1/100.0) / 7692.0e-6; //from MPa to psi
288 if (RPM>5) return -0.012; // friction in engine when propeller spining (estimate)
292 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
294 double FGTurboProp::Run(void)
296 double thrust = 0.0, EngPower_HP, eff_coef;
297 Running = true; Starter = false; EngStarting = false;
301 N1 = ExpSeek(&N1, IdleN1 + ThrottlePos * N1_factor, Idle_Max_Delay, Idle_Max_Delay * 2.4);
303 EngPower_HP = EnginePowerRPM_N1->GetValue(RPM,N1);
304 EngPower_HP *= EnginePowerVC->GetValue();
305 if (EngPower_HP > MaxPower) EngPower_HP = MaxPower;
307 eff_coef = 9.333 - (N1)/12; // 430%Fuel at 60%N1
308 FuelFlow_pph = PSFC * EngPower_HP * eff_coef;
310 Eng_Temperature = ExpSeek(&Eng_Temperature,Eng_ITT_degC,300,400);
311 double ITT_goal = ITT_N1->GetValue((N1-old_N1)*300+N1,1);
312 Eng_ITT_degC = ExpSeek(&Eng_ITT_degC,ITT_goal,ITT_Delay,ITT_Delay*1.2);
314 OilPressure_psi = (N1/100.0*0.25+(0.1-(OilTemp_degK-273.15)*0.1/80.0)*N1/100.0) / 7692.0e-6; //from MPa to psi
316 EPR = 1.0 + thrust/MilThrust;
318 OilTemp_degK = Seek(&OilTemp_degK, 353.15, 0.4-N1*0.001, 0.04);
320 if (Cutoff) phase = tpOff;
321 if (Starved) phase = tpOff;
326 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
328 double FGTurboProp::SpinUp(void)
331 Running = false; EngStarting = true;
334 if (!GeneratorPower) {
341 N1 = ExpSeek(&N1, StarterN1, Idle_Max_Delay * 6, Idle_Max_Delay * 2.4);
343 Eng_Temperature = ExpSeek(&Eng_Temperature,TAT,300,400);
344 double ITT_goal = ITT_N1->GetValue(N1,0.1) + ((N1>20) ? 0.0 : (20-N1)/20.0 * Eng_Temperature);
345 Eng_ITT_degC = ExpSeek(&Eng_ITT_degC,ITT_goal,ITT_Delay,ITT_Delay*1.2);
347 OilTemp_degK = ExpSeek(&OilTemp_degK,273.15 + TAT, 400 , 400);
349 OilPressure_psi = (N1/100.0*0.25+(0.1-(OilTemp_degK-273.15)*0.1/80.0)*N1/100.0) / 7692.0e-6; //from MPa to psi
350 NozzlePosition = 1.0;
352 EngPower_HP = EnginePowerRPM_N1->GetValue(RPM,N1);
353 EngPower_HP *= EnginePowerVC->GetValue();
354 if (EngPower_HP > MaxPower) EngPower_HP = MaxPower;
356 if (StartTime>=0) StartTime+=in.TotalDeltaT;
357 if (StartTime > MaxStartingTime && MaxStartingTime > 0) { //start failed due timeout
365 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
367 double FGTurboProp::Start(void)
369 double EngPower_HP = 0.0;
373 if ((N1 > 15.0) && !Starved) { // minimum 15% N2 needed for start
375 Cranking = true; // provided for sound effects signal
377 EngPower_HP = EnginePowerRPM_N1->GetValue(RPM,N1);
378 EngPower_HP *= EnginePowerVC->GetValue();
379 if (EngPower_HP > MaxPower) EngPower_HP = MaxPower;
380 N1 = ExpSeek(&N1, IdleN1*1.1, Idle_Max_Delay*4, Idle_Max_Delay * 2.4);
381 eff_coef = 9.333 - (N1)/12; // 430%Fuel at 60%N1
382 FuelFlow_pph = PSFC * EngPower_HP * eff_coef;
383 Eng_Temperature = ExpSeek(&Eng_Temperature,Eng_ITT_degC,300,400);
384 double ITT_goal = ITT_N1->GetValue((N1-old_N1)*300+N1,1);
385 Eng_ITT_degC = ExpSeek(&Eng_ITT_degC,ITT_goal,ITT_Delay,ITT_Delay*1.2);
387 OilPressure_psi = (N1/100.0*0.25+(0.1-(OilTemp_degK-273.15)*0.1/80.0)*N1/100.0) / 7692.0e-6; //from MPa to psi
388 OilTemp_degK = Seek(&OilTemp_degK, 353.15, 0.4-N1*0.001, 0.04);
397 } else { // no start if N2 < 15% or Starved
406 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
408 double FGTurboProp::CalcFuelNeed(void)
410 FuelFlowRate = FuelFlow_pph / 3600.0;
411 FuelExpended = FuelFlowRate * in.TotalDeltaT;
415 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
417 double FGTurboProp::Seek(double *var, double target, double accel, double decel)
421 v -= in.TotalDeltaT * decel;
422 if (v < target) v = target;
423 } else if (v < target) {
424 v += in.TotalDeltaT * accel;
425 if (v > target) v = target;
430 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
432 double FGTurboProp::ExpSeek(double *var, double target, double accel_tau, double decel_tau)
434 // exponential delay instead of the linear delay used in Seek
437 v = (v - target) * exp ( -in.TotalDeltaT / decel_tau) + target;
438 } else if (v < target) {
439 v = (target - v) * (1 - exp ( -in.TotalDeltaT / accel_tau)) + v;
444 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
446 void FGTurboProp::SetDefaults(void)
448 // Name = "Not defined";
458 NozzlePosition = 1.0;
470 Ielu_intervent=false;
472 Idle_Max_Delay = 1.0;
474 ThrottlePos = OldThrottle = 0.0;
476 ReverseMaxPower = 0.0;
477 BetaRangeThrottleEnd = 0.0;
480 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
483 string FGTurboProp::GetEngineLabels(const string& delimiter)
485 std::ostringstream buf;
487 buf << Name << "_N1[" << EngineNumber << "]" << delimiter
488 << Name << "_N2[" << EngineNumber << "]" << delimiter
489 << Name << "_PwrAvail[" << EngineNumber << "]" << delimiter
490 << Thruster->GetThrusterLabels(EngineNumber, delimiter);
495 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
497 string FGTurboProp::GetEngineValues(const string& delimiter)
499 std::ostringstream buf;
501 buf << N1 << delimiter
504 << Thruster->GetThrusterValues(EngineNumber,delimiter);
509 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
511 int FGTurboProp::InitRunning(void)
513 FDMExec->SuspendIntegration();
518 FDMExec->ResumeIntegration();
522 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
524 void FGTurboProp::bindmodel()
526 string property_name, base_property_name;
527 base_property_name = CreateIndexedPropertyName("propulsion/engine", EngineNumber);
528 property_name = base_property_name + "/n1";
529 PropertyManager->Tie( property_name.c_str(), &N1);
530 // property_name = base_property_name + "/n2";
531 // PropertyManager->Tie( property_name.c_str(), &N2);
532 property_name = base_property_name + "/reverser";
533 PropertyManager->Tie( property_name.c_str(), &Reversed);
534 property_name = base_property_name + "/power-hp";
535 PropertyManager->Tie( property_name.c_str(), &HP);
536 property_name = base_property_name + "/itt-c";
537 PropertyManager->Tie( property_name.c_str(), &Eng_ITT_degC);
538 property_name = base_property_name + "/engtemp-c";
539 PropertyManager->Tie( property_name.c_str(), &Eng_Temperature);
540 property_name = base_property_name + "/ielu_intervent";
541 PropertyManager->Tie( property_name.c_str(), &Ielu_intervent);
544 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
545 // The bitmasked value choices are as follows:
546 // unset: In this case (the default) JSBSim would only print
547 // out the normally expected messages, essentially echoing
548 // the config files as they are read. If the environment
549 // variable is not set, debug_lvl is set to 1 internally
550 // 0: This requests JSBSim not to output any messages
552 // 1: This value explicity requests the normal JSBSim
554 // 2: This value asks for a message to be printed out when
555 // a class is instantiated
556 // 4: When this value is set, a message is displayed when a
557 // FGModel object executes its Run() method
558 // 8: When this value is set, various runtime state variables
559 // are printed out periodically
560 // 16: When set various parameters are sanity checked and
561 // a message is printed out when they go out of bounds
563 void FGTurboProp::Debug(int from)
565 if (debug_lvl <= 0) return;
567 if (debug_lvl & 1) { // Standard console startup message output
568 if (from == 0) { // Constructor
571 if (from == 2) { // called from Load()
572 cout << "\n ****MUJ MOTOR TURBOPROP****\n";
573 cout << "\n Engine Name: " << Name << endl;
574 cout << " MilThrust: " << MilThrust << endl;
575 cout << " IdleN1: " << IdleN1 << endl;
576 cout << " MaxN1: " << MaxN1 << endl;
581 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
582 if (from == 0) cout << "Instantiated: FGTurboProp" << endl;
583 if (from == 1) cout << "Destroyed: FGTurboProp" << endl;
585 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
587 if (debug_lvl & 8 ) { // Runtime state variables
589 if (debug_lvl & 16) { // Sanity checking
591 if (debug_lvl & 64) {
592 if (from == 0) { // Constructor
593 cout << IdSrc << endl;
594 cout << IdHdr << endl;