]> git.mxchange.org Git - flightgear.git/blob - src/FDM/YASim/PropEngine.cpp
Allow YASim flight models to override the hard-coded fine and coarse
[flightgear.git] / src / FDM / YASim / PropEngine.cpp
1 #include "Math.hpp"
2 #include "Propeller.hpp"
3 #include "Engine.hpp"
4 #include "PropEngine.hpp"
5 namespace yasim {
6
7 PropEngine::PropEngine(Propeller* prop, Engine* eng, float moment)
8 {
9     // Start off at 500rpm, because the start code doesn't exist yet
10     _omega = 52.3f;
11     _dir[0] = 1; _dir[1] = 0; _dir[2] = 0;
12
13     _variable = false;
14     _gearRatio = 1;
15
16     _prop = prop;
17     _eng = eng;
18     _moment = moment;
19     _fuel = true;
20     _contra = false;
21 }
22
23 PropEngine::~PropEngine()
24 {
25     delete _prop;
26     delete _eng;
27 }
28
29 void PropEngine::setMagnetos(int pos)
30 {
31     _magnetos = pos;
32 }
33
34 void PropEngine::setAdvance(float advance)
35 {
36     _advance = Math::clamp(advance, 0, 1);
37 }
38
39 void PropEngine::setPropPitch(float proppitch)
40 {
41     // update Propeller property
42     _prop->setPropPitch(proppitch);
43 }
44
45 void PropEngine::setPropFeather(int state)
46 {
47     // toggle prop feathering on/off
48     _prop->setPropFeather(state);
49 }
50
51 void PropEngine::setVariableProp(float min, float max)
52 {
53     _variable = true;
54     _minOmega = min;
55     _maxOmega = max;
56 }
57
58 bool PropEngine::isRunning()
59 {
60     return _eng->isRunning();
61 }
62
63 bool PropEngine::isCranking()
64 {
65     return _eng->isCranking();
66 }
67
68 float PropEngine::getOmega()
69 {
70     return _omega;
71 }
72
73 void PropEngine::setOmega (float omega)
74 {
75     _omega = omega;
76 }
77
78 void PropEngine::getThrust(float* out)
79 {
80     int i;
81     for(i=0; i<3; i++) out[i] = _thrust[i];    
82 }
83
84 void PropEngine::getTorque(float* out)
85 {
86     int i;
87     for(i=0; i<3; i++) out[i] = _torque[i];
88 }
89
90 void PropEngine::getGyro(float* out)
91 {
92     int i;
93     for(i=0; i<3; i++) out[i] = _gyro[i];
94 }
95
96 float PropEngine::getFuelFlow()
97 {
98     return _fuelFlow;
99 }
100
101 void PropEngine::stabilize()
102 {
103     float speed = -Math::dot3(_wind, _dir);
104     _eng->setThrottle(_throttle);
105     _eng->setMixture(_mixture);
106
107     _eng->setStarter(false);
108     _eng->setMagnetos(3);
109
110     bool running_state = _eng->isRunning();
111     _eng->setRunning(true);
112
113     if(_variable) {
114         _omega = _minOmega + _advance * (_maxOmega - _minOmega);
115         _prop->modPitch(1e6); // Start at maximum pitch and move down
116     } else {
117         _omega = 52;
118     }
119
120     bool goingUp = false;
121     float step = 10;
122
123     // If we cannot manage this in 100 iterations, give up.
124     for (int n = 0; n < 100; n++) {
125         float ptau, thrust;
126         _prop->calc(_rho, speed, _omega * _gearRatio, &thrust, &ptau);
127         _eng->calc(_pressure, _temp, _omega);
128         _eng->stabilize();
129
130         // Compute torque as seen by the engine's end of the gearbox.
131         // The propeller will be moving more slowly (for gear ratios
132         // less than one), so it's torque will be higher than the
133         // engine's, so multiply by _gearRatio to get the engine-side
134         // value.
135         ptau *= _gearRatio;
136         float etau = _eng->getTorque();
137         float tdiff = etau - ptau;
138         
139         Math::mul3(thrust, _dir, _thrust);
140
141         if(Math::abs(tdiff/(_moment * _gearRatio)) < 0.1)
142             break;
143
144         if(tdiff > 0) {
145             if(!goingUp) step *= 0.5f;
146             goingUp = true;
147             if(!_variable)  _omega += step;
148             else            _prop->modPitch(1+(step*0.005f));
149         } else {
150             if(goingUp) step *= 0.5f;
151             goingUp = false;
152             if(!_variable)  _omega -= step;
153             else            _prop->modPitch(1-(step*0.005f));
154         }
155     }
156
157     // ...and back off
158     _eng->setRunning(running_state);
159 }
160
161 void PropEngine::init()
162 {
163     _omega = 0.01f;
164     _eng->setStarter(false);
165     _eng->setMagnetos(0);
166 }
167
168 void PropEngine::integrate(float dt)
169 {
170     float speed = -Math::dot3(_wind, _dir);
171
172     float propTorque, engTorque, thrust;
173
174     _eng->setThrottle(_throttle);
175     _eng->setStarter(_starter);
176     _eng->setMagnetos(_magnetos);
177     _eng->setMixture(_mixture);
178     _eng->setFuelState(_fuel);
179     
180     _prop->calc(_rho, speed, _omega * _gearRatio, &thrust, &propTorque);
181     if(_omega == 0.0)
182         _omega = 0.001; // hack to get around reports of NaNs somewhere...
183     propTorque *= _gearRatio;
184     _eng->calc(_pressure, _temp, _omega);
185     _eng->integrate(dt);
186     engTorque = _eng->getTorque();
187     _fuelFlow = _eng->getFuelFlow();
188
189     // Turn the thrust into a vector and save it
190     Math::mul3(thrust, _dir, _thrust);
191
192     // We do our "RPM" computations on the engine's side of the
193     // world, so modify the moment value accordingly.
194     float momt = _moment * _gearRatio;
195
196     // Euler-integrate the RPM.  This doesn't need the full-on
197     // Runge-Kutta stuff.
198     float rotacc = (engTorque-propTorque)/Math::abs(momt);
199     _omega += dt * rotacc;
200     if (_omega < 0)
201         _omega = 0 - _omega;    // don't allow negative RPM
202                                 // FIXME: introduce proper windmilling
203
204     // Store the total angular momentum into _gyro, unless the
205     // propeller is a counter-rotating pair (which has zero net
206     // angular momentum, even though it *does* have an MoI for
207     // acceleration purposes).
208     Math::mul3(_contra ? 0 : _omega*momt, _dir, _gyro);
209
210     // Accumulate the engine torque, it acts on the body as a whole.
211     // (Note: engine torque, not propeller torque.  They can be
212     // different, but the difference goes to accelerating the
213     // rotation.  It is the engine torque that is felt at the shaft
214     // and works on the body.) (Note 2: contra-rotating propellers do
215     // not exert net torque on the aircraft).
216     float tau = _moment < 0 ? engTorque : -engTorque;
217     Math::mul3(_contra ? 0 : tau, _dir, _torque);
218
219     // Iterate the propeller governor, if we have one.  Since engine
220     // torque is basically constant with RPM, we want to make the
221     // propeller torque at the target RPM equal to the engine by
222     // varying the pitch.  Assume the the torque goes as the square of
223     // the RPM (roughly correct) and compute a "target" torque for the
224     // _current_ RPM.  Seek to that.  This is sort of a continuous
225     // Newton-Raphson, basically.
226     if(_variable) {
227         float targetPropSpd = _minOmega + _advance*(_maxOmega-_minOmega);
228         float targetOmega = targetPropSpd / _gearRatio; // -> "engine omega"
229         float ratio2 = (_omega*_omega)/(targetOmega*targetOmega);
230         float targetTorque = engTorque * ratio2;
231
232         float mod = propTorque < targetTorque ? 1.04f : (1.0f/1.04f);
233
234         // Convert to an acceleration here, so that big propellers
235         // don't seek faster than small ones.
236         float diff = Math::abs((propTorque - targetTorque) / momt);
237         if(diff < 10) mod = 1 + (mod-1)*(0.1f*diff);
238
239         _prop->modPitch(mod);
240     }
241 }
242
243 }; // namespace yasim