1 // JSBsim.cxx -- interface to the JSBsim flight model
3 // Written by Curtis Olson, started February 1999.
5 // Copyright (C) 1999 Curtis L. Olson - curt@flightgear.org
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include <simgear/compiler.h>
26 #ifdef FG_MATH_EXCEPTION_CLASH
32 #include <simgear/constants.h>
33 #include <simgear/debug/logstream.hxx>
34 #include <simgear/math/sg_geodesy.hxx>
35 #include <simgear/misc/fgpath.hxx>
37 #include <Scenery/scenery.hxx>
39 #include <Aircraft/aircraft.hxx>
40 #include <Controls/controls.hxx>
41 #include <Main/globals.hxx>
43 #include <FDM/JSBSim/FGFDMExec.h>
44 #include <FDM/JSBSim/FGAircraft.h>
45 #include <FDM/JSBSim/FGFCS.h>
46 #include <FDM/JSBSim/FGPosition.h>
47 #include <FDM/JSBSim/FGRotation.h>
48 #include <FDM/JSBSim/FGState.h>
49 #include <FDM/JSBSim/FGTranslation.h>
50 #include <FDM/JSBSim/FGAuxiliary.h>
51 #include <FDM/JSBSim/FGDefs.h>
52 #include <FDM/JSBSim/FGInitialCondition.h>
53 #include <FDM/JSBSim/FGTrim.h>
54 #include <FDM/JSBSim/FGAtmosphere.h>
58 /******************************************************************************/
60 FGJSBsim::FGJSBsim(void) {
64 fgic=new FGInitialCondition(fdmex);
67 FGPath aircraft_path( globals->get_options()->get_fg_root() );
68 aircraft_path.append( "Aircraft" );
70 FGPath engine_path( globals->get_options()->get_fg_root() );
71 engine_path.append( "Engine" );
72 float dt = 1.0 / globals->get_options()->get_model_hz();
73 fdmex->GetState()->Setdt( dt );
75 result = fdmex->LoadModel( aircraft_path.str(),
77 globals->get_options()->get_aircraft() );
78 int Neng=fdmex->GetAircraft()->GetNumEngines();
79 FG_LOG(FG_FLIGHT,FG_INFO, "Neng: " << Neng );
80 for(int i=0;i<Neng;i++) {
81 add_engine( FGEngInterface() );
86 /******************************************************************************/
87 FGJSBsim::~FGJSBsim(void) {
94 /******************************************************************************/
96 // Initialize the JSBsim flight model, dt is the time increment for
97 // each subsequent iteration through the EOM
99 bool FGJSBsim::init( double dt ) {
103 FG_LOG( FG_FLIGHT, FG_INFO, "Starting and initializing JSBsim" );
106 FGPath aircraft_path( globals->get_options()->get_fg_root() );
107 aircraft_path.append( "Aircraft" );
109 FGPath engine_path( globals->get_options()->get_fg_root() );
110 engine_path.append( "Engine" );
112 fdmex->GetState()->Setdt( dt );
114 result = fdmex->LoadModel( aircraft_path.str(),
116 globals->get_options()->get_aircraft() );
120 FG_LOG( FG_FLIGHT, FG_INFO, " loaded aircraft" << globals->get_options()->get_aircraft() );
122 FG_LOG( FG_FLIGHT, FG_INFO, " aircraft "
123 << globals->get_options()->get_aircraft()
124 << " does not exist" );
128 fdmex->GetAtmosphere()->UseInternal();
130 FG_LOG( FG_FLIGHT, FG_INFO, " Initializing JSBSim with:" );
131 switch(fgic->GetSpeedSet()) {
133 FG_LOG(FG_FLIGHT,FG_INFO, " Vn,Ve,Vd= "
134 << fdmex->GetPosition()->GetVn()
135 << ", " << fdmex->GetPosition()->GetVe()
136 << ", " << fdmex->GetPosition()->GetVd()
140 FG_LOG(FG_FLIGHT,FG_INFO, " U,V,W= "
141 << fdmex->GetTranslation()->GetUVW()(1)
142 << ", " << fdmex->GetTranslation()->GetUVW()(2)
143 << ", " << fdmex->GetTranslation()->GetUVW()(3)
147 FG_LOG(FG_FLIGHT,FG_INFO, " Mach: "
148 << fdmex->GetTranslation()->GetMach() );
152 FG_LOG(FG_FLIGHT,FG_INFO, " Indicated Airspeed: "
153 << fdmex->GetAuxiliary()->GetVcalibratedKTS() << " knots" );
157 //FG_LOG( FG_FLIGHT, FG_INFO, " gamma: " << globals->get_options()->get_Gamma());
158 FG_LOG( FG_FLIGHT, FG_INFO, " Bank Angle: "
159 << fdmex->GetRotation()->Getphi()*RADTODEG << " deg");
160 FG_LOG( FG_FLIGHT, FG_INFO, " Pitch Angle: "
161 << fdmex->GetRotation()->Gettht()*RADTODEG << " deg" );
162 FG_LOG( FG_FLIGHT, FG_INFO, " True Heading: "
163 << fdmex->GetRotation()->Getpsi()*RADTODEG << " deg" );
164 FG_LOG( FG_FLIGHT, FG_INFO, " Latitude: "
165 << fdmex->GetPosition()->GetLatitude() << " deg" );
166 FG_LOG( FG_FLIGHT, FG_INFO, " Longitude: "
167 << fdmex->GetPosition()->GetLongitude() << " deg" );
170 /* FG_LOG( FG_FLIGHT, FG_DEBUG, " FGJSBSim::get_Altitude(): " << get_Altitude() );
171 FG_LOG( FG_FLIGHT, FG_DEBUG, " FGJSBSim::get_Sea_level_radius(): " << get_Sea_level_radius() );
172 FG_LOG( FG_FLIGHT, FG_DEBUG, " scenery.cur_radius*METER_TO_FEET: "
173 << scenery.cur_radius*METER_TO_FEET );
174 FG_LOG( FG_FLIGHT, FG_DEBUG, " Calculated Terrain ASL: " << endl
175 << " " << "scenery.cur_radius*METER_TO_FEET -get_Sea_level_radius()= "
176 << scenery.cur_radius*METER_TO_FEET - get_Sea_level_radius() );
178 FG_LOG( FG_FLIGHT, FG_DEBUG, " Calculated Aircraft AGL: " << endl
179 << " " << "get_Altitude() + get_Sea_level_radius() - scenery.cur_radius*METER_TO_FEET= "
180 << get_Altitude() + get_Sea_level_radius()- scenery.cur_radius*METER_TO_FEET );
181 FG_LOG( FG_FLIGHT, FG_DEBUG, " globals->get_options()->get_altitude(): "
182 << globals->get_options()->get_altitude() );
183 FG_LOG( FG_FLIGHT, FG_DEBUG, " FGBFI::getAltitude(): "
184 << FGBFI::getAltitude() ); */
187 FG_LOG( FG_FLIGHT, FG_INFO, " loaded initial conditions" );
189 FG_LOG( FG_FLIGHT, FG_INFO, " set dt" );
191 FG_LOG( FG_FLIGHT, FG_INFO, "Finished initializing JSBSim" );
196 /******************************************************************************/
198 // Run an iteration of the EOM (equations of motion)
200 bool FGJSBsim::update( int multiloop ) {
204 double save_alt = 0.0;
207 // lets try to avoid really screwing up the JSBsim model
208 if ( get_Altitude() < -9000 ) {
209 save_alt = get_Altitude();
216 FGTrim *fgtrim=new FGTrim(fdmex,fgic,tLongitudinal);
217 if(!fgtrim->DoTrim()) {
221 fgtrim->ReportState();
226 controls.set_elevator_trim(fdmex->GetFCS()->GetPitchTrimCmd());
227 controls.set_elevator(fdmex->GetFCS()->GetDeCmd());
228 controls.set_throttle(FGControls::ALL_ENGINES,
229 fdmex->GetFCS()->GetThrottleCmd(0)/100.0);
230 controls.set_aileron(fdmex->GetFCS()->GetDaCmd());
231 controls.set_rudder(fdmex->GetFCS()->GetDrCmd());
233 FG_LOG( FG_FLIGHT, FG_INFO, " Trim complete" );
236 for( i=0; i<get_num_engines(); i++ ) {
237 get_engine(i)->set_RPM( controls.get_throttle(i)*2700 );
238 get_engine(i)->set_Throttle( controls.get_throttle(i) );
242 for ( int i = 0; i < multiloop; i++ ) {
246 // printf("%d FG_Altitude = %.2f\n", i, FG_Altitude * 0.3048);
247 // printf("%d Altitude = %.2f\n", i, Altitude * 0.3048);
249 // translate JSBsim back to FG structure so that the
250 // autopilot (and the rest of the sim can use the updated values
254 // but lets restore our original bogus altitude when we are done
256 if ( save_alt < -9000.0 ) {
257 set_Altitude( save_alt );
260 //climb rate now set from FDM in copy_from_x()
264 /******************************************************************************/
266 // Convert from the FGInterface struct to the JSBsim generic_ struct
268 bool FGJSBsim::copy_to_JSBsim() {
269 // copy control positions into the JSBsim structure
271 fdmex->GetFCS()->SetDaCmd( controls.get_aileron());
272 fdmex->GetFCS()->SetDeCmd( controls.get_elevator());
273 fdmex->GetFCS()->SetPitchTrimCmd(controls.get_elevator_trim());
274 fdmex->GetFCS()->SetDrCmd( -1*controls.get_rudder());
275 fdmex->GetFCS()->SetDfCmd( controls.get_flaps() );
276 fdmex->GetFCS()->SetDsbCmd( 0.0 ); //speedbrakes
277 fdmex->GetFCS()->SetDspCmd( 0.0 ); //spoilers
278 fdmex->GetFCS()->SetThrottleCmd( FGControls::ALL_ENGINES,
279 controls.get_throttle( 0 ) * 100.0 );
281 fdmex->GetFCS()->SetLBrake( controls.get_brake( 0 ) );
282 fdmex->GetFCS()->SetRBrake( controls.get_brake( 1 ) );
283 fdmex->GetFCS()->SetCBrake( controls.get_brake( 2 ) );
285 fdmex->GetPosition()->SetRunwayRadius(scenery.cur_radius*METER_TO_FEET);
286 fdmex->GetPosition()->SetSeaLevelRadius(get_Sea_level_radius());
288 fdmex->GetAtmosphere()->SetExTemperature(get_Static_temperature());
289 fdmex->GetAtmosphere()->SetExPressure(get_Static_pressure());
290 fdmex->GetAtmosphere()->SetExDensity(get_Density());
291 fdmex->GetAtmosphere()->SetWindNED(get_V_north_airmass(),
292 get_V_east_airmass(),
293 get_V_down_airmass());
298 /******************************************************************************/
300 // Convert from the JSBsim generic_ struct to the FGInterface struct
302 bool FGJSBsim::copy_from_JSBsim() {
305 _set_Inertias( fdmex->GetAircraft()->GetMass(),
306 fdmex->GetAircraft()->GetIxx(),
307 fdmex->GetAircraft()->GetIyy(),
308 fdmex->GetAircraft()->GetIzz(),
309 fdmex->GetAircraft()->GetIxz() );
311 _set_CG_Position( fdmex->GetAircraft()->GetXYZcg()(1),
312 fdmex->GetAircraft()->GetXYZcg()(2),
313 fdmex->GetAircraft()->GetXYZcg()(3) );
315 _set_Accels_Body( fdmex->GetTranslation()->GetUVWdot()(1),
316 fdmex->GetTranslation()->GetUVWdot()(2),
317 fdmex->GetTranslation()->GetUVWdot()(3) );
319 _set_Accels_CG_Body( fdmex->GetTranslation()->GetUVWdot()(1),
320 fdmex->GetTranslation()->GetUVWdot()(2),
321 fdmex->GetTranslation()->GetUVWdot()(3) );
323 //_set_Accels_CG_Body_N ( fdmex->GetTranslation()->GetNcg()(1),
324 // fdmex->GetTranslation()->GetNcg()(2),
325 // fdmex->GetTranslation()->GetNcg()(3) );
327 _set_Accels_Pilot_Body( fdmex->GetAuxiliary()->GetPilotAccel()(1),
328 fdmex->GetAuxiliary()->GetPilotAccel()(2),
329 fdmex->GetAuxiliary()->GetPilotAccel()(3) );
331 //_set_Accels_Pilot_Body_N( fdmex->GetAuxiliary()->GetNpilot()(1),
332 // fdmex->GetAuxiliary()->GetNpilot()(2),
333 // fdmex->GetAuxiliary()->GetNpilot()(3) );
335 _set_Nlf( fdmex->GetAircraft()->GetNlf() );
339 _set_Velocities_Local( fdmex->GetPosition()->GetVn(),
340 fdmex->GetPosition()->GetVe(),
341 fdmex->GetPosition()->GetVd() );
343 _set_Velocities_Wind_Body( fdmex->GetTranslation()->GetUVW()(1),
344 fdmex->GetTranslation()->GetUVW()(2),
345 fdmex->GetTranslation()->GetUVW()(3) );
347 _set_V_rel_wind( fdmex->GetTranslation()->GetVt() );
349 _set_V_equiv_kts( fdmex->GetAuxiliary()->GetVequivalentKTS() );
351 // _set_V_calibrated( fdmex->GetAuxiliary()->GetVcalibratedFPS() );
353 _set_V_calibrated_kts( fdmex->GetAuxiliary()->GetVcalibratedKTS() );
355 _set_V_ground_speed( fdmex->GetPosition()->GetVground() );
357 _set_Omega_Body( fdmex->GetRotation()->GetPQR()(1),
358 fdmex->GetRotation()->GetPQR()(2),
359 fdmex->GetRotation()->GetPQR()(3) );
361 _set_Euler_Rates( fdmex->GetRotation()->GetEulerRates()(1),
362 fdmex->GetRotation()->GetEulerRates()(2),
363 fdmex->GetRotation()->GetEulerRates()(3) );
365 _set_Geocentric_Rates(fdmex->GetPosition()->GetLatitudeDot(),
366 fdmex->GetPosition()->GetLongitudeDot(),
367 fdmex->GetPosition()->Gethdot() );
369 _set_Mach_number( fdmex->GetTranslation()->GetMach() );
372 _updatePosition( fdmex->GetPosition()->GetLatitude(),
373 fdmex->GetPosition()->GetLongitude(),
374 fdmex->GetPosition()->Geth() );
376 _set_Euler_Angles( fdmex->GetRotation()->Getphi(),
377 fdmex->GetRotation()->Gettht(),
378 fdmex->GetRotation()->Getpsi() );
380 _set_Alpha( fdmex->GetTranslation()->Getalpha() );
381 _set_Beta( fdmex->GetTranslation()->Getbeta() );
383 _set_Gamma_vert_rad( fdmex->GetPosition()->GetGamma() );
384 // set_Gamma_horiz_rad( Gamma_horiz_rad );
386 _set_Earth_position_angle( fdmex->GetAuxiliary()->GetEarthPositionAngle() );
388 _set_Climb_Rate( fdmex->GetPosition()->Gethdot() );
390 for ( i = 1; i <= 3; i++ ) {
391 for ( j = 1; j <= 3; j++ ) {
392 _set_T_Local_to_Body( i, j, fdmex->GetState()->GetTl2b()(i,j) );
398 void FGJSBsim::snap_shot(void) {
399 fgic->SetLatitudeRadIC(get_Lat_geocentric() );
400 fgic->SetLongitudeRadIC( get_Longitude() );
401 fgic->SetAltitudeFtIC( get_Altitude() );
402 fgic->SetTerrainAltitudeFtIC( get_Runway_altitude() );
403 fgic->SetVtrueFpsIC( get_V_rel_wind() );
404 fgic->SetPitchAngleRadIC( get_Theta() );
405 fgic->SetRollAngleRadIC( get_Phi() );
406 fgic->SetTrueHeadingRadIC( get_Psi() );
407 fgic->SetClimbRateFpsIC( get_Climb_Rate() );
412 void FGJSBsim::set_Latitude(double lat) {
413 double sea_level_radius_meters,lat_geoc;
415 FG_LOG(FG_FLIGHT,FG_INFO,"FGJSBsim::set_Latitude: " << lat );
418 sgGeodToGeoc( lat, get_Altitude() , &sea_level_radius_meters, &lat_geoc);
419 fgic->SetSeaLevelRadiusFtIC( sea_level_radius_meters * METER_TO_FEET );
420 fgic->SetLatitudeRadIC( lat_geoc );
421 fdmex->RunIC(fgic); //loop JSBSim once
422 copy_from_JSBsim(); //update the bus
426 void FGJSBsim::set_Longitude(double lon) {
428 FG_LOG(FG_FLIGHT,FG_INFO,"FGJSBsim::set_Longitude: " << lon );
431 fgic->SetLongitudeRadIC(lon);
432 fdmex->RunIC(fgic); //loop JSBSim once
433 copy_from_JSBsim(); //update the bus
437 void FGJSBsim::set_Altitude(double alt) {
438 double sea_level_radius_meters,lat_geoc;
440 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Altitude: " << alt );
443 sgGeodToGeoc( get_Latitude(), alt , &sea_level_radius_meters, &lat_geoc);
444 fgic->SetSeaLevelRadiusFtIC( sea_level_radius_meters * METER_TO_FEET );
445 fgic->SetLatitudeRadIC( lat_geoc );
446 fgic->SetAltitudeFtIC(alt);
447 fdmex->RunIC(fgic); //loop JSBSim once
448 copy_from_JSBsim(); //update the bus
452 void FGJSBsim::set_V_calibrated_kts(double vc) {
453 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_V_calibrated_kts: " << vc );
456 fgic->SetVcalibratedKtsIC(vc);
457 fdmex->RunIC(fgic); //loop JSBSim once
458 copy_from_JSBsim(); //update the bus
462 void FGJSBsim::set_Mach_number(double mach) {
463 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Mach_number: " << mach );
466 fgic->SetMachIC(mach);
467 fdmex->RunIC(fgic); //loop JSBSim once
468 copy_from_JSBsim(); //update the bus
472 void FGJSBsim::set_Velocities_Local( double north, double east, double down ){
473 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Velocities_Local: "
474 << north << ", " << east << ", " << down );
477 fgic->SetVnorthFpsIC(north);
478 fgic->SetVeastFpsIC(east);
479 fgic->SetVdownFpsIC(down);
480 fdmex->RunIC(fgic); //loop JSBSim once
481 copy_from_JSBsim(); //update the bus
485 void FGJSBsim::set_Velocities_Wind_Body( double u, double v, double w){
486 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Velocities_Wind_Body: "
487 << u << ", " << v << ", " << w );
490 fgic->SetUBodyFpsIC(u);
491 fgic->SetVBodyFpsIC(v);
492 fgic->SetWBodyFpsIC(w);
493 fdmex->RunIC(fgic); //loop JSBSim once
494 copy_from_JSBsim(); //update the bus
499 void FGJSBsim::set_Euler_Angles( double phi, double theta, double psi ) {
500 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Euler_Angles: "
501 << phi << ", " << theta << ", " << psi );
504 fgic->SetPitchAngleRadIC(theta);
505 fgic->SetRollAngleRadIC(phi);
506 fgic->SetTrueHeadingRadIC(psi);
507 fdmex->RunIC(fgic); //loop JSBSim once
508 copy_from_JSBsim(); //update the bus
513 void FGJSBsim::set_Climb_Rate( double roc) {
514 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Climb_Rate: " << roc );
517 fgic->SetClimbRateFpsIC(roc);
518 fdmex->RunIC(fgic); //loop JSBSim once
519 copy_from_JSBsim(); //update the bus
523 void FGJSBsim::set_Gamma_vert_rad( double gamma) {
524 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Gamma_vert_rad: " << gamma );
527 fgic->SetFlightPathAngleRadIC(gamma);
528 fdmex->RunIC(fgic); //loop JSBSim once
529 copy_from_JSBsim(); //update the bus
534 void FGJSBsim::set_Sea_level_radius(double slr) {
535 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Sea_level_radius: " << slr );
538 fgic->SetSeaLevelRadiusFtIC(slr);
539 fdmex->RunIC(fgic); //loop JSBSim once
540 copy_from_JSBsim(); //update the bus
544 void FGJSBsim::set_Runway_altitude(double ralt) {
545 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Runway_altitude: " << ralt );
548 _set_Runway_altitude( ralt );
549 fdmex->RunIC(fgic); //loop JSBSim once
550 copy_from_JSBsim(); //update the bus
554 void FGJSBsim::set_Static_pressure(double p) {
555 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Static_pressure: " << p );
558 fdmex->GetAtmosphere()->SetExPressure(p);
559 if(fdmex->GetAtmosphere()->External() == true)
563 void FGJSBsim::set_Static_temperature(double T) {
564 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Static_temperature: " << T );
567 fdmex->GetAtmosphere()->SetExTemperature(T);
568 if(fdmex->GetAtmosphere()->External() == true)
573 void FGJSBsim::set_Density(double rho) {
574 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Density: " << rho );
577 fdmex->GetAtmosphere()->SetExDensity(rho);
578 if(fdmex->GetAtmosphere()->External() == true)
583 void FGJSBsim::set_Velocities_Local_Airmass (double wnorth,
586 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Velocities_Local_Airmass: "
587 << wnorth << ", " << weast << ", " << wdown );
590 fdmex->GetAtmosphere()->SetWindNED(wnorth, weast, wdown );
591 if(fdmex->GetAtmosphere()->External() == true)