]> git.mxchange.org Git - flightgear.git/blob - src/FDM/YASim/FGFDM.cpp
Piston engine oil temperature model from David Luff:
[flightgear.git] / src / FDM / YASim / FGFDM.cpp
1 #include <stdio.h>
2 #include <stdlib.h>
3
4 #include <Main/fg_props.hxx>
5
6 #include "Math.hpp"
7 #include "Jet.hpp"
8 #include "SimpleJet.hpp"
9 #include "Gear.hpp"
10 #include "Hook.hpp"
11 #include "Launchbar.hpp"
12 #include "Atmosphere.hpp"
13 #include "PropEngine.hpp"
14 #include "Propeller.hpp"
15 #include "PistonEngine.hpp"
16 #include "TurbineEngine.hpp"
17 #include "Rotor.hpp"
18 #include "Rotorpart.hpp"
19 #include "Rotorblade.hpp"
20
21 #include "FGFDM.hpp"
22
23 namespace yasim {
24
25 // Some conversion factors
26 static const float KTS2MPS = 0.514444444444;
27 static const float FT2M = 0.3048;
28 static const float DEG2RAD = 0.0174532925199;
29 static const float RPM2RAD = 0.10471975512;
30 static const float LBS2N = 4.44822;
31 static const float LBS2KG = 0.45359237;
32 static const float KG2LBS = 2.2046225;
33 static const float CM2GALS = 264.172037284;
34 static const float HP2W = 745.700;
35 static const float INHG2PA = 3386.389;
36 static const float K2DEGF = 1.8;
37 static const float K2DEGFOFFSET = -459.4;
38 static const float CIN2CM = 1.6387064e-5;
39 static const float YASIM_PI = 3.14159265358979323846;
40
41 static const float NM2FTLB = (1/(LBS2N*FT2M));
42
43 // Stubs, so that this can be compiled without the FlightGear
44 // binary.  What's the best way to handle this?
45
46 //     float fgGetFloat(char* name, float def) { return 0; }
47 //     void fgSetFloat(char* name, float val) {}
48
49 FGFDM::FGFDM()
50 {
51     _vehicle_radius = 0.0f;
52
53     _nextEngine = 0;
54
55     // Map /controls/flight/elevator to the approach elevator control.  This
56     // should probably be settable, but there are very few aircraft
57     // who trim their approaches using things other than elevator.
58     _airplane.setElevatorControl(parseAxis("/controls/flight/elevator-trim"));
59
60     // FIXME: read seed from somewhere?
61     int seed = 0;
62     _turb = new Turbulence(10, seed);
63 }
64
65 FGFDM::~FGFDM()
66 {
67     int i;
68     for(i=0; i<_axes.size(); i++) {
69         AxisRec* a = (AxisRec*)_axes.get(i);
70         delete[] a->name;
71         delete a;
72     }
73     for(i=0; i<_thrusters.size(); i++) {
74         EngRec* er = (EngRec*)_thrusters.get(i);
75         delete[] er->prefix;
76         delete er->eng;
77         delete er;
78     }
79     for(i=0; i<_weights.size(); i++) {
80         WeightRec* wr = (WeightRec*)_weights.get(i);
81         delete[] wr->prop;
82         delete wr;
83     }
84     for(i=0; i<_controlProps.size(); i++)
85         delete (PropOut*)_controlProps.get(i);
86 }
87
88 void FGFDM::iterate(float dt)
89 {
90     getExternalInput(dt);
91     _airplane.iterate(dt);
92
93     // Do fuel stuff (FIXME: should stash SGPropertyNode objects here)
94     char buf[256];
95     for(int i=0; i<_airplane.numThrusters(); i++) {
96         Thruster* t = _airplane.getThruster(i);
97
98         sprintf(buf, "/engines/engine[%d]/out-of-fuel", i);
99         t->setFuelState(!fgGetBool(buf));
100
101         sprintf(buf, "/engines/engine[%d]/fuel-consumed-lbs", i);
102         double consumed = fgGetDouble(buf) + dt * KG2LBS * t->getFuelFlow();
103         fgSetDouble(buf, consumed);
104     }
105     for(int i=0; i<_airplane.numTanks(); i++) {
106         sprintf(buf, "/consumables/fuel/tank[%d]/level-lbs", i);
107         _airplane.setFuel(i, LBS2KG * fgGetFloat(buf));
108     } 
109     _airplane.calcFuelWeights();
110     
111     setOutputProperties(dt);
112 }
113
114 Airplane* FGFDM::getAirplane()
115 {
116     return &_airplane;
117 }
118
119 void FGFDM::init()
120 {
121     // Allows the user to start with something other than full fuel
122     _airplane.setFuelFraction(fgGetFloat("/sim/fuel-fraction", 1));
123
124     // Read out the resulting fuel state
125     char buf[256];
126     for(int i=0; i<_airplane.numTanks(); i++) {
127         sprintf(buf, "/consumables/fuel/tank[%d]/level-lbs", i);
128         fgSetDouble(buf, _airplane.getFuel(i) * KG2LBS);
129
130         double density = _airplane.getFuelDensity(i);
131         sprintf(buf, "/consumables/fuel/tank[%d]/density-ppg", i);
132         fgSetDouble(buf, density * (KG2LBS/CM2GALS));
133
134         sprintf(buf, "/consumables/fuel/tank[%d]/level-gal_us", i);
135         fgSetDouble(buf, _airplane.getFuel(i) * CM2GALS / density);
136
137         sprintf(buf, "/consumables/fuel/tank[%d]/capacity-gal_us", i);
138         fgSetDouble(buf, CM2GALS * _airplane.getTankCapacity(i)/density);
139     }    
140
141     // This has a nasty habit of being false at startup.  That's not
142     // good.
143     fgSetBool("/controls/gear/gear-down", true);
144
145     _airplane.getModel()->setTurbulence(_turb);
146 }
147
148 // Not the worlds safest parser.  But it's short & sweet.
149 void FGFDM::startElement(const char* name, const XMLAttributes &atts)
150 {
151     XMLAttributes* a = (XMLAttributes*)&atts;
152     float v[3];
153     char buf[64];
154
155     if(eq(name, "airplane")) {
156         _airplane.setWeight(attrf(a, "mass") * LBS2KG);
157     } else if(eq(name, "approach")) {
158         float spd = attrf(a, "speed") * KTS2MPS;
159         float alt = attrf(a, "alt", 0) * FT2M;
160         float aoa = attrf(a, "aoa", 0) * DEG2RAD;
161         _airplane.setApproach(spd, alt, aoa, attrf(a, "fuel", 0.2));
162         _cruiseCurr = false;
163     } else if(eq(name, "cruise")) {
164         float spd = attrf(a, "speed") * KTS2MPS;
165         float alt = attrf(a, "alt") * FT2M;
166         _airplane.setCruise(spd, alt, attrf(a, "fuel", 0.5));
167         _cruiseCurr = true;
168     } else if(eq(name, "solve-weight")) {
169         int idx = attri(a, "idx");
170         float wgt = attrf(a, "weight") * LBS2KG;
171         _airplane.addSolutionWeight(!_cruiseCurr, idx, wgt);
172     } else if(eq(name, "cockpit")) {
173         v[0] = attrf(a, "x");
174         v[1] = attrf(a, "y");
175         v[2] = attrf(a, "z");
176         _airplane.setPilotPos(v);
177     } else if(eq(name, "rotor")) {
178         _airplane.addRotor(parseRotor(a, name));
179     } else if(eq(name, "wing")) {
180         _airplane.setWing(parseWing(a, name));
181     } else if(eq(name, "hstab")) {
182         _airplane.setTail(parseWing(a, name));
183     } else if(eq(name, "vstab") || eq(name, "mstab")) {
184         _airplane.addVStab(parseWing(a, name));
185     } else if(eq(name, "piston-engine")) {
186         parsePistonEngine(a);
187     } else if(eq(name, "turbine-engine")) {
188         parseTurbineEngine(a);
189     } else if(eq(name, "propeller")) {
190         parsePropeller(a);
191     } else if(eq(name, "thruster")) {
192         SimpleJet* j = new SimpleJet();
193         _currObj = j;
194         v[0] = attrf(a, "x"); v[1] = attrf(a, "y"); v[2] = attrf(a, "z");
195         j->setPosition(v);
196         _airplane.addThruster(j, 0, v);
197         v[0] = attrf(a, "vx"); v[1] = attrf(a, "vy"); v[2] = attrf(a, "vz");
198         j->setDirection(v);
199         j->setThrust(attrf(a, "thrust") * LBS2N);
200     } else if(eq(name, "jet")) {
201         Jet* j = new Jet();
202         _currObj = j;
203         v[0] = attrf(a, "x");
204         v[1] = attrf(a, "y");
205         v[2] = attrf(a, "z");
206         float mass = attrf(a, "mass") * LBS2KG;
207         j->setMaxThrust(attrf(a, "thrust") * LBS2N,
208                         attrf(a, "afterburner", 0) * LBS2N);
209         j->setVectorAngle(attrf(a, "rotate", 0) * DEG2RAD);
210         j->setReverseThrust(attrf(a, "reverse", 0.2));
211
212         float n1min = attrf(a, "n1-idle", 55);
213         float n1max = attrf(a, "n1-max", 102);
214         float n2min = attrf(a, "n2-idle", 73);
215         float n2max = attrf(a, "n2-max", 103);
216         j->setRPMs(n1min, n1max, n2min, n2max);
217
218         j->setTSFC(attrf(a, "tsfc", 0.8));
219         if(a->hasAttribute("egt"))  j->setEGT(attrf(a, "egt"));
220         if(a->hasAttribute("epr"))  j->setEPR(attrf(a, "epr"));
221         if(a->hasAttribute("exhaust-speed"))
222             j->setVMax(attrf(a, "exhaust-speed") * KTS2MPS);
223         
224         j->setPosition(v);
225         _airplane.addThruster(j, mass, v);
226         sprintf(buf, "/engines/engine[%d]", _nextEngine++);
227         EngRec* er = new EngRec();
228         er->eng = j;
229         er->prefix = dup(buf);
230         _thrusters.add(er);
231     } else if(eq(name, "gear")) {
232         Gear* g = new Gear();
233         _currObj = g;
234         v[0] = attrf(a, "x");
235         v[1] = attrf(a, "y");
236         v[2] = attrf(a, "z");
237         g->setPosition(v);
238         float nrm = Math::mag3(v);
239         if (_vehicle_radius < nrm)
240             _vehicle_radius = nrm;
241         if(a->hasAttribute("upx")) {
242             v[0] = attrf(a, "upx");
243             v[1] = attrf(a, "upy");
244             v[2] = attrf(a, "upz");
245             Math::unit3(v, v);
246         } else {
247             v[0] = 0;
248             v[1] = 0;
249             v[2] = 1;
250         }
251         for(int i=0; i<3; i++)
252             v[i] *= attrf(a, "compression", 1);
253         g->setCompression(v);
254         g->setBrake(attrf(a, "skid", 0));
255         g->setStaticFriction(attrf(a, "sfric", 0.8));
256         g->setDynamicFriction(attrf(a, "dfric", 0.7));
257         g->setSpring(attrf(a, "spring", 1));
258         g->setDamping(attrf(a, "damp", 1));
259         _airplane.addGear(g);
260     } else if(eq(name, "hook")) {
261         Hook* h = new Hook();
262         _currObj = h;
263         v[0] = attrf(a, "x");
264         v[1] = attrf(a, "y");
265         v[2] = attrf(a, "z");
266         h->setPosition(v);
267         float length = attrf(a, "length", 1.0);
268         h->setLength(length);
269         float nrm = length+Math::mag3(v);
270         if (_vehicle_radius < nrm)
271             _vehicle_radius = nrm;
272         h->setDownAngle(attrf(a, "down-angle", 70) * DEG2RAD);
273         h->setUpAngle(attrf(a, "up-angle", 0) * DEG2RAD);
274         _airplane.addHook(h);
275     } else if(eq(name, "launchbar")) {
276         Launchbar* l = new Launchbar();
277         _currObj = l;
278         v[0] = attrf(a, "x");
279         v[1] = attrf(a, "y");
280         v[2] = attrf(a, "z");
281         l->setLaunchbarMount(v);
282         v[0] = attrf(a, "holdback-x", v[0]);
283         v[1] = attrf(a, "holdback-y", v[1]);
284         v[2] = attrf(a, "holdback-z", v[2]);
285         l->setHoldbackMount(v);
286         float length = attrf(a, "length", 1.0);
287         l->setLength(length);
288         l->setDownAngle(attrf(a, "down-angle", 30) * DEG2RAD);
289         l->setUpAngle(attrf(a, "up-angle", -30) * DEG2RAD);
290         _airplane.addLaunchbar(l);
291     } else if(eq(name, "fuselage")) {
292         float b[3];
293         v[0] = attrf(a, "ax");
294         v[1] = attrf(a, "ay");
295         v[2] = attrf(a, "az");
296         b[0] = attrf(a, "bx");
297         b[1] = attrf(a, "by");
298         b[2] = attrf(a, "bz");
299         float taper = attrf(a, "taper", 1);
300         float mid = attrf(a, "midpoint", 0.5);
301         _airplane.addFuselage(v, b, attrf(a, "width"), taper, mid);
302     } else if(eq(name, "tank")) {
303         v[0] = attrf(a, "x");
304         v[1] = attrf(a, "y");
305         v[2] = attrf(a, "z");
306         float density = 6.0; // gasoline, in lbs/gal
307         if(a->hasAttribute("jet")) density = 6.72; 
308         density *= LBS2KG*CM2GALS;
309         _airplane.addTank(v, attrf(a, "capacity") * LBS2KG, density);
310     } else if(eq(name, "ballast")) {
311         v[0] = attrf(a, "x");
312         v[1] = attrf(a, "y");
313         v[2] = attrf(a, "z");
314         _airplane.addBallast(v, attrf(a, "mass") * LBS2KG);
315     } else if(eq(name, "weight")) {
316         parseWeight(a);
317     } else if(eq(name, "stall")) {
318         Wing* w = (Wing*)_currObj;
319         w->setStall(attrf(a, "aoa") * DEG2RAD);
320         w->setStallWidth(attrf(a, "width", 2) * DEG2RAD);
321         w->setStallPeak(attrf(a, "peak", 1.5));
322     } else if(eq(name, "flap0")) {
323         ((Wing*)_currObj)->setFlap0(attrf(a, "start"), attrf(a, "end"),
324                                     attrf(a, "lift"), attrf(a, "drag"));
325     } else if(eq(name, "flap1")) {
326         ((Wing*)_currObj)->setFlap1(attrf(a, "start"), attrf(a, "end"),
327                                     attrf(a, "lift"), attrf(a, "drag"));
328     } else if(eq(name, "slat")) {
329         ((Wing*)_currObj)->setSlat(attrf(a, "start"), attrf(a, "end"),
330                                    attrf(a, "aoa"), attrf(a, "drag"));
331     } else if(eq(name, "spoiler")) {
332         ((Wing*)_currObj)->setSpoiler(attrf(a, "start"), attrf(a, "end"),
333                                       attrf(a, "lift"), attrf(a, "drag"));
334     /* } else if(eq(name, "collective")) {
335         ((Rotor*)_currObj)->setcollective(attrf(a, "min"), attrf(a, "max"));
336     } else if(eq(name, "cyclic")) {
337         ((Rotor*)_currObj)->setcyclic(attrf(a, "ail"), attrf(a, "ele"));
338     */                               
339     } else if(eq(name, "actionpt")) {
340         v[0] = attrf(a, "x");
341         v[1] = attrf(a, "y");
342         v[2] = attrf(a, "z");
343         ((Thruster*)_currObj)->setPosition(v);
344     } else if(eq(name, "dir")) {
345         v[0] = attrf(a, "x");
346         v[1] = attrf(a, "y");
347         v[2] = attrf(a, "z");
348         ((Thruster*)_currObj)->setDirection(v);
349     } else if(eq(name, "control-setting")) {
350         // A cruise or approach control setting
351         const char* axis = a->getValue("axis");
352         float value = attrf(a, "value", 0);
353         if(_cruiseCurr)
354             _airplane.addCruiseControl(parseAxis(axis), value);
355         else
356             _airplane.addApproachControl(parseAxis(axis), value);
357     } else if(eq(name, "control-input")) {
358
359         // A mapping of input property to a control
360         int axis = parseAxis(a->getValue("axis"));
361         int control = parseOutput(a->getValue("control"));
362         int opt = 0;
363         opt |= a->hasAttribute("split") ? ControlMap::OPT_SPLIT : 0;
364         opt |= a->hasAttribute("invert") ? ControlMap::OPT_INVERT : 0;
365         opt |= a->hasAttribute("square") ? ControlMap::OPT_SQUARE : 0;
366         
367         ControlMap* cm = _airplane.getControlMap();
368         if(a->hasAttribute("src0")) {
369                            cm->addMapping(axis, control, _currObj, opt,
370                            attrf(a, "src0"), attrf(a, "src1"), 
371                            attrf(a, "dst0"), attrf(a, "dst1"));
372         } else {
373             cm->addMapping(axis, control, _currObj, opt);
374         }
375     } else if(eq(name, "control-output")) {
376         // A property output for a control on the current object
377         ControlMap* cm = _airplane.getControlMap();
378         int type = parseOutput(a->getValue("control"));
379         int handle = cm->getOutputHandle(_currObj, type);
380
381         PropOut* p = new PropOut();
382         p->prop = fgGetNode(a->getValue("prop"), true);
383         p->handle = handle;
384         p->type = type;
385         p->left = !(a->hasAttribute("side") &&
386                         eq("right", a->getValue("side")));
387         p->min = attrf(a, "min", cm->rangeMin(type));
388         p->max = attrf(a, "max", cm->rangeMax(type));
389         _controlProps.add(p);
390
391     } else if(eq(name, "control-speed")) {
392         ControlMap* cm = _airplane.getControlMap();
393         int type = parseOutput(a->getValue("control"));
394         int handle = cm->getOutputHandle(_currObj, type);
395         float time = attrf(a, "transition-time", 0);
396         
397         cm->setTransitionTime(handle, time);
398     } else {
399         SG_LOG(SG_FLIGHT,SG_ALERT,"Unexpected tag '"
400                << name << "' found in YASim aircraft description");
401         exit(1);
402     }
403 }
404
405 void FGFDM::getExternalInput(float dt)
406 {
407     char buf[256];
408
409     _turb->setMagnitude(fgGetFloat("/environment/turbulence/magnitude-norm"));
410     _turb->update(dt, fgGetFloat("/environment/turbulence/rate-hz"));
411
412     // The control axes
413     ControlMap* cm = _airplane.getControlMap();
414     cm->reset();
415     int i;
416     for(i=0; i<_axes.size(); i++) {
417         AxisRec* a = (AxisRec*)_axes.get(i);
418         float val = fgGetFloat(a->name, 0);
419         cm->setInput(a->handle, val);
420     }
421     cm->applyControls(dt);
422
423     // Weights
424     for(i=0; i<_weights.size(); i++) {
425         WeightRec* wr = (WeightRec*)_weights.get(i);
426         _airplane.setWeight(wr->handle, LBS2KG * fgGetFloat(wr->prop));
427     }
428
429     for(i=0; i<_thrusters.size(); i++) {
430         EngRec* er = (EngRec*)_thrusters.get(i);
431         Thruster* t = er->eng;
432
433         if(t->getPropEngine()) {
434             PropEngine* p = t->getPropEngine();
435             sprintf(buf, "%s/rpm", er->prefix);
436             p->setOmega(fgGetFloat(buf, 500) * RPM2RAD);
437         }
438     }
439 }
440
441 // Linearly "seeks" a property by the specified fraction of the way to
442 // the target value.  Used to emulate "slowly changing" output values.
443 static void moveprop(SGPropertyNode* node, const char* prop,
444                     float target, float frac)
445 {
446     float val = node->getFloatValue(prop);
447     if(frac > 1) frac = 1;
448     if(frac < 0) frac = 0;
449     val += (target - val) * frac;
450     node->setFloatValue(prop, val);
451 }
452
453 void FGFDM::setOutputProperties(float dt)
454 {
455     // char buf[256];
456     int i;
457
458     float grossWgt = _airplane.getModel()->getBody()->getTotalMass() * KG2LBS;
459     fgSetFloat("/yasim/gross-weight-lbs", grossWgt);
460
461     ControlMap* cm = _airplane.getControlMap();
462     for(i=0; i<_controlProps.size(); i++) {
463         PropOut* p = (PropOut*)_controlProps.get(i);
464         float val = (p->left
465                      ? cm->getOutput(p->handle)
466                      : cm->getOutputR(p->handle));
467         float rmin = cm->rangeMin(p->type);
468         float rmax = cm->rangeMax(p->type);
469         float frac = (val - rmin) / (rmax - rmin);
470         val = frac*(p->max - p->min) + p->min;
471         p->prop->setFloatValue(val);
472     }
473
474     for(i=0; i<_airplane.getNumRotors(); i++) {
475         Rotor*r=(Rotor*)_airplane.getRotor(i);
476         int j = 0;
477         float f;
478         char b[256];
479         while(j = r->getValueforFGSet(j, b, &f))
480             if(b[0]) fgSetFloat(b,f);
481         
482         for(j=0; j < r->numRotorparts(); j++) {
483             Rotorpart* s = (Rotorpart*)r->getRotorpart(j);
484             char *b;
485             int k;
486             for(k=0; k<2; k++) {
487                 b=s->getAlphaoutput(k);
488                 if(b[0]) fgSetFloat(b, s->getAlpha(k));
489             }
490         }
491         for(j=0; j < r->numRotorblades(); j++) {
492             Rotorblade* s = (Rotorblade*)r->getRotorblade(j);
493             char *b;
494             int k;
495             for (k=0; k<2; k++) {
496                 b = s->getAlphaoutput(k);
497                 if(b[0]) fgSetFloat(b, s->getAlpha(k));
498             }
499         }
500     }
501
502     float fuelDensity = _airplane.getFuelDensity(0); // HACK
503     for(i=0; i<_thrusters.size(); i++) {
504         EngRec* er = (EngRec*)_thrusters.get(i);
505         Thruster* t = er->eng;
506         SGPropertyNode * node = fgGetNode("engines/engine", i, true);
507
508         // Set: running, cranking, prop-thrust, max-hp, power-pct
509         node->setBoolValue("running", t->isRunning());
510         node->setBoolValue("cranking", t->isCranking());
511
512         float tmp[3];
513         t->getThrust(tmp);
514         float lbs = Math::mag3(tmp) * (KG2LBS/9.8);
515         node->setFloatValue("prop-thrust", lbs); // Deprecated name
516         node->setFloatValue("thrust-lbs", lbs);
517         node->setFloatValue("fuel-flow-gph",
518                             (t->getFuelFlow()/fuelDensity) * 3600 * CM2GALS);
519
520         if(t->getPropEngine()) {
521             PropEngine* p = t->getPropEngine();
522             node->setFloatValue("rpm", p->getOmega() * (1/RPM2RAD));
523             node->setFloatValue("torque-ftlb",
524                                 p->getEngine()->getTorque() * NM2FTLB);
525         
526             if(p->getEngine()->isPistonEngine()) {
527                 PistonEngine* pe = p->getEngine()->isPistonEngine();
528                 node->setFloatValue("mp-osi", pe->getMP() * (1/INHG2PA));
529                 node->setFloatValue("mp-inhg", pe->getMP() * (1/INHG2PA));
530                 node->setFloatValue("egt-degf",
531                                     pe->getEGT() * K2DEGF + K2DEGFOFFSET);
532                 node->setFloatValue("oil-temperature-degf",
533                                     pe->getOilTemp() * K2DEGF + K2DEGFOFFSET);
534                 node->setFloatValue("boost-gauge-inhg",
535                                     pe->getBoost() * (1/INHG2PA));
536             } else if(p->getEngine()->isTurbineEngine()) {
537                 TurbineEngine* te = p->getEngine()->isTurbineEngine();
538                 node->setFloatValue("n2", te->getN2());
539             }
540         }
541
542         if(t->getJet()) {
543             Jet* j = t->getJet();
544             node->setFloatValue("n1", j->getN1());
545             node->setFloatValue("n2", j->getN2());
546             node->setFloatValue("epr", j->getEPR());
547             node->setFloatValue("egr-degf",
548                                 j->getEGT() * K2DEGF + K2DEGFOFFSET);
549
550             // These are "unmodeled" values that are still needed for
551             // many cockpits.  Tie them all to the N1 speed, but
552             // normalize the numbers to the range [0:1] so the
553             // cockpit code can scale them to the right values.
554             float pnorm = j->getPerfNorm();
555             moveprop(node, "oilp-norm", pnorm, dt/3); // 3s seek time
556             moveprop(node, "oilt-norm", pnorm, dt/30); // 30s 
557             moveprop(node, "itt-norm", pnorm, dt/1); // 1s
558         }
559     }
560 }
561
562 Wing* FGFDM::parseWing(XMLAttributes* a, const char* type)
563 {
564     Wing* w = new Wing();
565
566     float defDihed = 0;
567     if(eq(type, "vstab"))
568         defDihed = 90;
569     else
570         w->setMirror(true);
571
572     float pos[3];
573     pos[0] = attrf(a, "x");
574     pos[1] = attrf(a, "y");
575     pos[2] = attrf(a, "z");
576     w->setBase(pos);
577
578     w->setLength(attrf(a, "length"));
579     w->setChord(attrf(a, "chord"));
580     w->setSweep(attrf(a, "sweep", 0) * DEG2RAD);
581     w->setTaper(attrf(a, "taper", 1));
582     w->setDihedral(attrf(a, "dihedral", defDihed) * DEG2RAD);
583     w->setCamber(attrf(a, "camber", 0));
584     w->setIncidence(attrf(a, "incidence", 0) * DEG2RAD);
585     w->setTwist(attrf(a, "twist", 0) * DEG2RAD);
586
587     // The 70% is a magic number that sorta kinda seems to match known
588     // throttle settings to approach speed.
589     w->setInducedDrag(0.7*attrf(a, "idrag", 1));
590
591     float effect = attrf(a, "effectiveness", 1);
592     w->setDragScale(w->getDragScale()*effect);
593
594     _currObj = w;
595     return w;
596 }
597
598 Rotor* FGFDM::parseRotor(XMLAttributes* a, const char* type)
599 {
600     Rotor* w = new Rotor();
601
602     // float defDihed = 0;
603
604     float pos[3];
605     pos[0] = attrf(a, "x");
606     pos[1] = attrf(a, "y");
607     pos[2] = attrf(a, "z");
608     w->setBase(pos);
609
610     float normal[3];
611     normal[0] = attrf(a, "nx");
612     normal[1] = attrf(a, "ny");
613     normal[2] = attrf(a, "nz");
614     w->setNormal(normal);
615
616     float forward[3];
617     forward[0] = attrf(a, "fx");
618     forward[1] = attrf(a, "fy");
619     forward[2] = attrf(a, "fz");
620     w->setForward(forward);
621
622     w->setMaxCyclicail(attrf(a, "maxcyclicail", 7.6));
623     w->setMaxCyclicele(attrf(a, "maxcyclicele", 4.94));
624     w->setMinCyclicail(attrf(a, "mincyclicail", -7.6));
625     w->setMinCyclicele(attrf(a, "mincyclicele", -4.94));
626     w->setMaxCollective(attrf(a, "maxcollective", 15.8));
627     w->setMinCollective(attrf(a, "mincollective", -0.2));
628     w->setDiameter(attrf(a, "diameter", 10.2));
629     w->setWeightPerBlade(attrf(a, "weightperblade", 44));
630     w->setNumberOfBlades(attrf(a, "numblades", 4));
631     w->setRelBladeCenter(attrf(a, "relbladecenter", 0.7));
632     w->setDynamic(attrf(a, "dynamic", 0.7));
633     w->setDelta3(attrf(a, "delta3", 0));
634     w->setDelta(attrf(a, "delta", 0));
635     w->setTranslift(attrf(a, "translift", 0.05));
636     w->setC2(attrf(a, "dragfactor", 1));
637     w->setStepspersecond(attrf(a, "stepspersecond", 120));
638     w->setRPM(attrf(a, "rpm", 424));
639     w->setRelLenHinge(attrf(a, "rellenflaphinge", 0.07));
640     w->setAlpha0((attrf(a, "flap0", -5))*YASIM_PI/180);
641     w->setAlphamin((attrf(a, "flapmin", -15))/180*YASIM_PI);
642     w->setAlphamax((attrf(a, "flapmax",  15))*YASIM_PI/180);
643     w->setAlpha0factor(attrf(a, "flap0factor", 1));
644     w->setTeeterdamp(attrf(a,"teeterdamp",.0001));
645     w->setMaxteeterdamp(attrf(a,"maxteeterdamp",1000));
646     w->setRelLenTeeterHinge(attrf(a,"rellenteeterhinge",0.01));
647     void setAlphamin(float f);
648     void setAlphamax(float f);
649     void setAlpha0factor(float f);
650
651     if(attrb(a,"ccw"))
652        w->setCcw(1); 
653     
654     if(a->hasAttribute("name"))
655        w->setName(a->getValue("name") );
656     if(a->hasAttribute("alphaout0"))
657        w->setAlphaoutput(0,a->getValue("alphaout0") );
658     if(a->hasAttribute("alphaout1"))  w->setAlphaoutput(1,a->getValue("alphaout1") );
659     if(a->hasAttribute("alphaout2"))  w->setAlphaoutput(2,a->getValue("alphaout2") );
660     if(a->hasAttribute("alphaout3"))  w->setAlphaoutput(3,a->getValue("alphaout3") );
661     if(a->hasAttribute("coneout"))  w->setAlphaoutput(4,a->getValue("coneout") );
662     if(a->hasAttribute("yawout"))   w->setAlphaoutput(5,a->getValue("yawout") );
663     if(a->hasAttribute("rollout"))  w->setAlphaoutput(6,a->getValue("rollout") );
664
665     w->setPitchA(attrf(a, "pitch_a", 10));
666     w->setPitchB(attrf(a, "pitch_b", 10));
667     w->setForceAtPitchA(attrf(a, "forceatpitch_a", 3000));
668     w->setPowerAtPitch0(attrf(a, "poweratpitch_0", 300));
669     w->setPowerAtPitchB(attrf(a, "poweratpitch_b", 3000));
670     if(attrb(a,"notorque"))
671        w->setNotorque(1); 
672     if(attrb(a,"simblades"))
673        w->setSimBlades(1); 
674
675     _currObj = w;
676     return w;
677 }
678
679 void FGFDM::parsePistonEngine(XMLAttributes* a)
680 {
681     float engP = attrf(a, "eng-power") * HP2W;
682     float engS = attrf(a, "eng-rpm") * RPM2RAD;
683
684     PistonEngine* eng = new PistonEngine(engP, engS);
685
686     if(a->hasAttribute("displacement"))
687         eng->setDisplacement(attrf(a, "displacement") * CIN2CM);
688
689     if(a->hasAttribute("compression"))
690         eng->setCompression(attrf(a, "compression"));        
691
692     if(a->hasAttribute("turbo-mul")) {
693         float mul = attrf(a, "turbo-mul");
694         float mp = attrf(a, "wastegate-mp", 1e6) * INHG2PA;
695         eng->setTurboParams(mul, mp);
696     }
697
698     ((PropEngine*)_currObj)->setEngine(eng);
699 }
700
701 void FGFDM::parseTurbineEngine(XMLAttributes* a)
702 {
703     float power = attrf(a, "eng-power") * HP2W;
704     float omega = attrf(a, "eng-rpm") * RPM2RAD;
705     float alt = attrf(a, "alt") * FT2M;
706     float flatRating = attrf(a, "flat-rating") * HP2W;
707     TurbineEngine* eng = new TurbineEngine(power, omega, alt, flatRating);
708
709     if(a->hasAttribute("n2-low-idle"))
710         eng->setN2Range(attrf(a, "n2-low-idle"), attrf(a, "n2-high-idle"),
711                         attrf(a, "n2-max"));
712
713     // Nasty units conversion: lbs/hr per hp -> kg/s per watt
714     if(a->hasAttribute("bsfc"))
715         eng->setFuelConsumption(attrf(a, "bsfc") * (LBS2KG/(3600*HP2W)));
716
717     ((PropEngine*)_currObj)->setEngine(eng);
718 }
719
720 void FGFDM::parsePropeller(XMLAttributes* a)
721 {
722     // Legacy Handling for the old engines syntax:
723     PistonEngine* eng = 0;
724     if(a->hasAttribute("eng-power")) {
725         SG_LOG(SG_FLIGHT,SG_ALERT, "WARNING: "
726                << "Legacy engine definition in YASim configuration file.  "
727                << "Please fix.");
728         float engP = attrf(a, "eng-power") * HP2W;
729         float engS = attrf(a, "eng-rpm") * RPM2RAD;
730         eng = new PistonEngine(engP, engS);
731         if(a->hasAttribute("displacement"))
732             eng->setDisplacement(attrf(a, "displacement") * CIN2CM);
733         if(a->hasAttribute("compression"))
734             eng->setCompression(attrf(a, "compression"));        
735         if(a->hasAttribute("turbo-mul")) {
736             float mul = attrf(a, "turbo-mul");
737             float mp = attrf(a, "wastegate-mp", 1e6) * INHG2PA;
738             eng->setTurboParams(mul, mp);
739         }
740     }
741
742     // Now parse the actual propeller definition:
743     float cg[3];
744     cg[0] = attrf(a, "x");
745     cg[1] = attrf(a, "y");
746     cg[2] = attrf(a, "z");
747     float mass = attrf(a, "mass") * LBS2KG;
748     float moment = attrf(a, "moment");
749     float radius = attrf(a, "radius");
750     float speed = attrf(a, "cruise-speed") * KTS2MPS;
751     float omega = attrf(a, "cruise-rpm") * RPM2RAD;
752     float power = attrf(a, "cruise-power") * HP2W;
753     float rho = Atmosphere::getStdDensity(attrf(a, "cruise-alt") * FT2M);
754
755     Propeller* prop = new Propeller(radius, speed, omega, rho, power);
756     PropEngine* thruster = new PropEngine(prop, eng, moment);
757     _airplane.addThruster(thruster, mass, cg);
758
759     if(a->hasAttribute("takeoff-power")) {
760         float power0 = attrf(a, "takeoff-power") * HP2W;
761         float omega0 = attrf(a, "takeoff-rpm") * RPM2RAD;
762         prop->setTakeoff(omega0, power0);
763     }
764
765     if(a->hasAttribute("max-rpm")) {
766         float max = attrf(a, "max-rpm") * RPM2RAD;
767         float min = attrf(a, "min-rpm") * RPM2RAD;
768         thruster->setVariableProp(min, max);
769     }
770
771     if(attrb(a, "contra"))
772         thruster->setContraPair(true);
773
774     if(a->hasAttribute("manual-pitch")) {
775         prop->setManualPitch();
776     }
777
778     thruster->setGearRatio(attrf(a, "gear-ratio", 1));
779
780     char buf[64];
781     sprintf(buf, "/engines/engine[%d]", _nextEngine++);
782     EngRec* er = new EngRec();
783     er->eng = thruster;
784     er->prefix = dup(buf);
785     _thrusters.add(er);
786
787     _currObj = thruster;
788 }
789
790 // Turns a string axis name into an integer for use by the
791 // ControlMap.  Creates a new axis if this one hasn't been defined
792 // yet.
793 int FGFDM::parseAxis(const char* name)
794 {
795     int i;
796     for(i=0; i<_axes.size(); i++) {
797         AxisRec* a = (AxisRec*)_axes.get(i);
798         if(eq(a->name, name))
799             return a->handle;
800     }
801
802     // Not there, make a new one.
803     AxisRec* a = new AxisRec();
804     a->name = dup(name);
805     fgGetNode( a->name, true ); // make sure the property name exists
806     a->handle = _airplane.getControlMap()->newInput();
807     _axes.add(a);
808     return a->handle;
809 }
810
811 int FGFDM::parseOutput(const char* name)
812 {
813     if(eq(name, "THROTTLE"))  return ControlMap::THROTTLE;
814     if(eq(name, "MIXTURE"))   return ControlMap::MIXTURE;
815     if(eq(name, "CONDLEVER")) return ControlMap::CONDLEVER;
816     if(eq(name, "STARTER"))   return ControlMap::STARTER;
817     if(eq(name, "MAGNETOS"))  return ControlMap::MAGNETOS;
818     if(eq(name, "ADVANCE"))   return ControlMap::ADVANCE;
819     if(eq(name, "REHEAT"))    return ControlMap::REHEAT;
820     if(eq(name, "BOOST"))     return ControlMap::BOOST;
821     if(eq(name, "VECTOR"))    return ControlMap::VECTOR;
822     if(eq(name, "PROP"))      return ControlMap::PROP;
823     if(eq(name, "BRAKE"))     return ControlMap::BRAKE;
824     if(eq(name, "STEER"))     return ControlMap::STEER;
825     if(eq(name, "EXTEND"))    return ControlMap::EXTEND;
826     if(eq(name, "HEXTEND"))   return ControlMap::HEXTEND;
827     if(eq(name, "LEXTEND"))   return ControlMap::LEXTEND;
828     if(eq(name, "INCIDENCE")) return ControlMap::INCIDENCE;
829     if(eq(name, "FLAP0"))     return ControlMap::FLAP0;
830     if(eq(name, "FLAP1"))     return ControlMap::FLAP1;
831     if(eq(name, "SLAT"))      return ControlMap::SLAT;
832     if(eq(name, "SPOILER"))   return ControlMap::SPOILER;
833     if(eq(name, "CASTERING")) return ControlMap::CASTERING;
834     if(eq(name, "PROPPITCH")) return ControlMap::PROPPITCH;
835     if(eq(name, "PROPFEATHER")) return ControlMap::PROPFEATHER;
836     if(eq(name, "COLLECTIVE")) return ControlMap::COLLECTIVE;
837     if(eq(name, "CYCLICAIL")) return ControlMap::CYCLICAIL;
838     if(eq(name, "CYCLICELE")) return ControlMap::CYCLICELE;
839     if(eq(name, "ROTORENGINEON")) return ControlMap::ROTORENGINEON;
840     if(eq(name, "REVERSE_THRUST")) return ControlMap::REVERSE_THRUST;
841     SG_LOG(SG_FLIGHT,SG_ALERT,"Unrecognized control type '"
842            << name << "' in YASim aircraft description.");
843     exit(1);
844
845 }
846
847 void FGFDM::parseWeight(XMLAttributes* a)
848 {
849     WeightRec* wr = new WeightRec();
850
851     float v[3];
852     v[0] = attrf(a, "x");
853     v[1] = attrf(a, "y");
854     v[2] = attrf(a, "z");
855
856     wr->prop = dup(a->getValue("mass-prop"));
857     wr->size = attrf(a, "size", 0);
858     wr->handle = _airplane.addWeight(v, wr->size);
859
860     _weights.add(wr);
861 }
862
863 bool FGFDM::eq(const char* a, const char* b)
864 {
865     // Figure it out for yourself. :)
866     while(*a && *b && *a == *b) { a++; b++; }
867     return !(*a || *b);
868 }
869
870 char* FGFDM::dup(const char* s)
871 {
872     int len=0;
873     while(s[len++]);
874     char* s2 = new char[len+1];
875     char* p = s2;
876     while((*p++ = *s++));
877     s2[len] = 0;
878     return s2;
879 }
880
881 int FGFDM::attri(XMLAttributes* atts, char* attr)
882 {
883     if(!atts->hasAttribute(attr)) {
884         SG_LOG(SG_FLIGHT,SG_ALERT,"Missing '" << attr <<
885                "' in YASim aircraft description");
886         exit(1);
887     }
888     return attri(atts, attr, 0);
889 }
890
891 int FGFDM::attri(XMLAttributes* atts, char* attr, int def)
892 {
893     const char* val = atts->getValue(attr);
894     if(val == 0) return def;
895     else         return atol(val);
896 }
897
898 float FGFDM::attrf(XMLAttributes* atts, char* attr)
899 {
900     if(!atts->hasAttribute(attr)) {
901         SG_LOG(SG_FLIGHT,SG_ALERT,"Missing '" << attr <<
902                "' in YASim aircraft description");
903         exit(1);
904     }
905     return attrf(atts, attr, 0);
906 }
907
908 float FGFDM::attrf(XMLAttributes* atts, char* attr, float def)
909 {
910     const char* val = atts->getValue(attr);
911     if(val == 0) return def;
912     else         return (float)atof(val);    
913 }
914
915 // ACK: the dreaded ambiguous string boolean.  Remind me to shoot Maik
916 // when I have a chance. :).  Unless you have a parser that can check
917 // symbol constants (we don't), this kind of coding is just a Bad
918 // Idea.  This implementation, for example, silently returns a boolean
919 // falsehood for values of "1", "yes", "True", and "TRUE".  Which is
920 // especially annoying preexisting boolean attributes in the same
921 // parser want to see "1" and will choke on a "true"...
922 //
923 // Unfortunately, this usage creeped into existing configuration files
924 // while I wasn't active, and it's going to be hard to remove.  Issue
925 // a warning to nag people into changing their ways for now...
926 bool FGFDM::attrb(XMLAttributes* atts, char* attr)
927 {
928     const char* val = atts->getValue(attr);
929     if(val == 0) return false;
930
931     if(eq(val,"true")) {
932         SG_LOG(SG_FLIGHT, SG_ALERT, "Warning: " <<
933                "deprecated 'true' boolean in YASim configuration file.  " <<
934                "Use numeric booleans (attribute=\"1\") instead");
935         return true;
936     }
937     return attri(atts, attr, 0) ? true : false;
938 }
939
940 }; // namespace yasim