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();
213 if(needTrim && (globals->get_options()->get_trim_mode() > 0)) {
215 if(fgic->GetVcalibratedKtsIC() < 10 ) {
216 fgic->SetVcalibratedKtsIC(0.0);
217 fgtrim=new FGTrim(fdmex,fgic,tGround);
219 fgtrim=new FGTrim(fdmex,fgic,tLongitudinal);
221 if(!fgtrim->DoTrim()) {
225 fgtrim->ReportState();
231 controls.set_elevator_trim(fdmex->GetFCS()->GetPitchTrimCmd());
232 controls.set_elevator(fdmex->GetFCS()->GetDeCmd());
233 controls.set_throttle(FGControls::ALL_ENGINES,
234 fdmex->GetFCS()->GetThrottleCmd(0)/100.0);
235 controls.set_aileron(fdmex->GetFCS()->GetDaCmd());
236 controls.set_rudder(fdmex->GetFCS()->GetDrCmd());
238 FG_LOG( FG_FLIGHT, FG_INFO, " Trim complete" );
241 for( i=0; i<get_num_engines(); i++ ) {
242 get_engine(i)->set_RPM( controls.get_throttle(i)*2700 );
243 get_engine(i)->set_Throttle( controls.get_throttle(i) );
247 for ( int i = 0; i < multiloop; i++ ) {
251 // printf("%d FG_Altitude = %.2f\n", i, FG_Altitude * 0.3048);
252 // printf("%d Altitude = %.2f\n", i, Altitude * 0.3048);
254 // translate JSBsim back to FG structure so that the
255 // autopilot (and the rest of the sim can use the updated values
261 // but lets restore our original bogus altitude when we are done
263 if ( save_alt < -9000.0 ) {
264 set_Altitude( save_alt );
267 //climb rate now set from FDM in copy_from_x()
271 /******************************************************************************/
273 // Convert from the FGInterface struct to the JSBsim generic_ struct
275 bool FGJSBsim::copy_to_JSBsim() {
276 // copy control positions into the JSBsim structure
278 fdmex->GetFCS()->SetDaCmd( controls.get_aileron());
279 fdmex->GetFCS()->SetDeCmd( controls.get_elevator());
280 fdmex->GetFCS()->SetPitchTrimCmd(controls.get_elevator_trim());
281 fdmex->GetFCS()->SetDrCmd( -1*controls.get_rudder());
282 fdmex->GetFCS()->SetDfCmd( controls.get_flaps() );
283 fdmex->GetFCS()->SetDsbCmd( 0.0 ); //speedbrakes
284 fdmex->GetFCS()->SetDspCmd( 0.0 ); //spoilers
285 fdmex->GetFCS()->SetThrottleCmd( FGControls::ALL_ENGINES,
286 controls.get_throttle( 0 ) * 100.0 );
288 fdmex->GetFCS()->SetLBrake( controls.get_brake( 0 ) );
289 fdmex->GetFCS()->SetRBrake( controls.get_brake( 1 ) );
290 fdmex->GetFCS()->SetCBrake( controls.get_brake( 2 ) );
292 fdmex->GetPosition()->SetRunwayRadius(scenery.cur_radius*METER_TO_FEET);
293 fdmex->GetPosition()->SetSeaLevelRadius(get_Sea_level_radius());
295 fdmex->GetAtmosphere()->SetExTemperature(get_Static_temperature());
296 fdmex->GetAtmosphere()->SetExPressure(get_Static_pressure());
297 fdmex->GetAtmosphere()->SetExDensity(get_Density());
298 fdmex->GetAtmosphere()->SetWindNED(get_V_north_airmass(),
299 get_V_east_airmass(),
300 get_V_down_airmass());
305 /******************************************************************************/
307 // Convert from the JSBsim generic_ struct to the FGInterface struct
309 bool FGJSBsim::copy_from_JSBsim() {
312 _set_Inertias( fdmex->GetAircraft()->GetMass(),
313 fdmex->GetAircraft()->GetIxx(),
314 fdmex->GetAircraft()->GetIyy(),
315 fdmex->GetAircraft()->GetIzz(),
316 fdmex->GetAircraft()->GetIxz() );
318 _set_CG_Position( fdmex->GetAircraft()->GetXYZcg()(1),
319 fdmex->GetAircraft()->GetXYZcg()(2),
320 fdmex->GetAircraft()->GetXYZcg()(3) );
322 _set_Accels_Body( fdmex->GetTranslation()->GetUVWdot()(1),
323 fdmex->GetTranslation()->GetUVWdot()(2),
324 fdmex->GetTranslation()->GetUVWdot()(3) );
326 _set_Accels_CG_Body( fdmex->GetTranslation()->GetUVWdot()(1),
327 fdmex->GetTranslation()->GetUVWdot()(2),
328 fdmex->GetTranslation()->GetUVWdot()(3) );
330 //_set_Accels_CG_Body_N ( fdmex->GetTranslation()->GetNcg()(1),
331 // fdmex->GetTranslation()->GetNcg()(2),
332 // fdmex->GetTranslation()->GetNcg()(3) );
334 _set_Accels_Pilot_Body( fdmex->GetAuxiliary()->GetPilotAccel()(1),
335 fdmex->GetAuxiliary()->GetPilotAccel()(2),
336 fdmex->GetAuxiliary()->GetPilotAccel()(3) );
338 //_set_Accels_Pilot_Body_N( fdmex->GetAuxiliary()->GetNpilot()(1),
339 // fdmex->GetAuxiliary()->GetNpilot()(2),
340 // fdmex->GetAuxiliary()->GetNpilot()(3) );
342 _set_Nlf( fdmex->GetAircraft()->GetNlf() );
346 _set_Velocities_Local( fdmex->GetPosition()->GetVn(),
347 fdmex->GetPosition()->GetVe(),
348 fdmex->GetPosition()->GetVd() );
350 _set_Velocities_Wind_Body( fdmex->GetTranslation()->GetUVW()(1),
351 fdmex->GetTranslation()->GetUVW()(2),
352 fdmex->GetTranslation()->GetUVW()(3) );
354 _set_V_rel_wind( fdmex->GetTranslation()->GetVt() );
356 _set_V_equiv_kts( fdmex->GetAuxiliary()->GetVequivalentKTS() );
358 // _set_V_calibrated( fdmex->GetAuxiliary()->GetVcalibratedFPS() );
360 _set_V_calibrated_kts( fdmex->GetAuxiliary()->GetVcalibratedKTS() );
362 _set_V_ground_speed( fdmex->GetPosition()->GetVground() );
364 _set_Omega_Body( fdmex->GetRotation()->GetPQR()(1),
365 fdmex->GetRotation()->GetPQR()(2),
366 fdmex->GetRotation()->GetPQR()(3) );
368 _set_Euler_Rates( fdmex->GetRotation()->GetEulerRates()(1),
369 fdmex->GetRotation()->GetEulerRates()(2),
370 fdmex->GetRotation()->GetEulerRates()(3) );
372 _set_Geocentric_Rates(fdmex->GetPosition()->GetLatitudeDot(),
373 fdmex->GetPosition()->GetLongitudeDot(),
374 fdmex->GetPosition()->Gethdot() );
376 _set_Mach_number( fdmex->GetTranslation()->GetMach() );
379 _updatePosition( fdmex->GetPosition()->GetLatitude(),
380 fdmex->GetPosition()->GetLongitude(),
381 fdmex->GetPosition()->Geth() );
383 _set_Euler_Angles( fdmex->GetRotation()->Getphi(),
384 fdmex->GetRotation()->Gettht(),
385 fdmex->GetRotation()->Getpsi() );
387 _set_Alpha( fdmex->GetTranslation()->Getalpha() );
388 _set_Beta( fdmex->GetTranslation()->Getbeta() );
391 _set_Gamma_vert_rad( fdmex->GetPosition()->GetGamma() );
392 // set_Gamma_horiz_rad( Gamma_horiz_rad );
394 _set_Earth_position_angle( fdmex->GetAuxiliary()->GetEarthPositionAngle() );
396 _set_Climb_Rate( fdmex->GetPosition()->Gethdot() );
399 for ( i = 1; i <= 3; i++ ) {
400 for ( j = 1; j <= 3; j++ ) {
401 _set_T_Local_to_Body( i, j, fdmex->GetState()->GetTl2b()(i,j) );
407 void FGJSBsim::snap_shot(void) {
408 fgic->SetLatitudeRadIC(get_Lat_geocentric() );
409 fgic->SetLongitudeRadIC( get_Longitude() );
410 fgic->SetAltitudeFtIC( get_Altitude() );
411 fgic->SetTerrainAltitudeFtIC( get_Runway_altitude() );
412 fgic->SetVtrueFpsIC( get_V_rel_wind() );
413 fgic->SetPitchAngleRadIC( get_Theta() );
414 fgic->SetRollAngleRadIC( get_Phi() );
415 fgic->SetTrueHeadingRadIC( get_Psi() );
416 fgic->SetClimbRateFpsIC( get_Climb_Rate() );
421 void FGJSBsim::set_Latitude(double lat) {
422 double sea_level_radius_meters,lat_geoc;
424 FG_LOG(FG_FLIGHT,FG_INFO,"FGJSBsim::set_Latitude: " << lat );
427 sgGeodToGeoc( lat, get_Altitude() , &sea_level_radius_meters, &lat_geoc);
428 fgic->SetSeaLevelRadiusFtIC( sea_level_radius_meters * METER_TO_FEET );
429 fgic->SetLatitudeRadIC( lat_geoc );
430 fdmex->RunIC(fgic); //loop JSBSim once
431 copy_from_JSBsim(); //update the bus
435 void FGJSBsim::set_Longitude(double lon) {
437 FG_LOG(FG_FLIGHT,FG_INFO,"FGJSBsim::set_Longitude: " << lon );
440 fgic->SetLongitudeRadIC(lon);
441 fdmex->RunIC(fgic); //loop JSBSim once
442 copy_from_JSBsim(); //update the bus
446 void FGJSBsim::set_Altitude(double alt) {
447 double sea_level_radius_meters,lat_geoc;
449 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Altitude: " << alt );
452 sgGeodToGeoc( get_Latitude(), alt , &sea_level_radius_meters, &lat_geoc);
453 fgic->SetSeaLevelRadiusFtIC( sea_level_radius_meters * METER_TO_FEET );
454 fgic->SetLatitudeRadIC( lat_geoc );
455 fgic->SetAltitudeFtIC(alt);
456 fdmex->RunIC(fgic); //loop JSBSim once
457 copy_from_JSBsim(); //update the bus
461 void FGJSBsim::set_V_calibrated_kts(double vc) {
462 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_V_calibrated_kts: " << vc );
465 fgic->SetVcalibratedKtsIC(vc);
466 fdmex->RunIC(fgic); //loop JSBSim once
467 copy_from_JSBsim(); //update the bus
471 void FGJSBsim::set_Mach_number(double mach) {
472 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Mach_number: " << mach );
475 fgic->SetMachIC(mach);
476 fdmex->RunIC(fgic); //loop JSBSim once
477 copy_from_JSBsim(); //update the bus
481 void FGJSBsim::set_Velocities_Local( double north, double east, double down ){
482 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Velocities_Local: "
483 << north << ", " << east << ", " << down );
486 fgic->SetVnorthFpsIC(north);
487 fgic->SetVeastFpsIC(east);
488 fgic->SetVdownFpsIC(down);
489 fdmex->RunIC(fgic); //loop JSBSim once
490 copy_from_JSBsim(); //update the bus
494 void FGJSBsim::set_Velocities_Wind_Body( double u, double v, double w){
495 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Velocities_Wind_Body: "
496 << u << ", " << v << ", " << w );
499 fgic->SetUBodyFpsIC(u);
500 fgic->SetVBodyFpsIC(v);
501 fgic->SetWBodyFpsIC(w);
502 fdmex->RunIC(fgic); //loop JSBSim once
503 copy_from_JSBsim(); //update the bus
508 void FGJSBsim::set_Euler_Angles( double phi, double theta, double psi ) {
509 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Euler_Angles: "
510 << phi << ", " << theta << ", " << psi );
513 fgic->SetPitchAngleRadIC(theta);
514 fgic->SetRollAngleRadIC(phi);
515 fgic->SetTrueHeadingRadIC(psi);
516 fdmex->RunIC(fgic); //loop JSBSim once
517 copy_from_JSBsim(); //update the bus
522 void FGJSBsim::set_Climb_Rate( double roc) {
523 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Climb_Rate: " << roc );
526 fgic->SetClimbRateFpsIC(roc);
527 fdmex->RunIC(fgic); //loop JSBSim once
528 copy_from_JSBsim(); //update the bus
532 void FGJSBsim::set_Gamma_vert_rad( double gamma) {
533 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Gamma_vert_rad: " << gamma );
536 fgic->SetFlightPathAngleRadIC(gamma);
537 fdmex->RunIC(fgic); //loop JSBSim once
538 copy_from_JSBsim(); //update the bus
543 void FGJSBsim::set_Sea_level_radius(double slr) {
544 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Sea_level_radius: " << slr );
547 fgic->SetSeaLevelRadiusFtIC(slr);
548 fdmex->RunIC(fgic); //loop JSBSim once
549 copy_from_JSBsim(); //update the bus
553 void FGJSBsim::set_Runway_altitude(double ralt) {
554 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Runway_altitude: " << ralt );
557 _set_Runway_altitude( ralt );
558 fdmex->RunIC(fgic); //loop JSBSim once
559 copy_from_JSBsim(); //update the bus
563 void FGJSBsim::set_Static_pressure(double p) {
564 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Static_pressure: " << p );
567 fdmex->GetAtmosphere()->SetExPressure(p);
568 if(fdmex->GetAtmosphere()->External() == true)
572 void FGJSBsim::set_Static_temperature(double T) {
573 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Static_temperature: " << T );
576 fdmex->GetAtmosphere()->SetExTemperature(T);
577 if(fdmex->GetAtmosphere()->External() == true)
582 void FGJSBsim::set_Density(double rho) {
583 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Density: " << rho );
586 fdmex->GetAtmosphere()->SetExDensity(rho);
587 if(fdmex->GetAtmosphere()->External() == true)
592 void FGJSBsim::set_Velocities_Local_Airmass (double wnorth,
595 FG_LOG(FG_FLIGHT,FG_INFO, "FGJSBsim::set_Velocities_Local_Airmass: "
596 << wnorth << ", " << weast << ", " << wdown );
599 fdmex->GetAtmosphere()->SetWindNED(wnorth, weast, wdown );
600 if(fdmex->GetAtmosphere()->External() == true)