src/FDM/JSBSim/FGState.cpp

   1 /*******************************************************************************
   2
   3  Module:       FGState.cpp
   4  Author:       Jon Berndt
   5  Date started: 11/17/98
   6  Called by:    FGFDMExec and accessed by all models.
   7
   8  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
   9
  10  This program is free software; you can redistribute it and/or modify it under
  11  the terms of the GNU General Public License as published by the Free Software
  12  Foundation; either version 2 of the License, or (at your option) any later
  13  version.
  14
  15  This program is distributed in the hope that it will be useful, but WITHOUT
  16  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  18  details.
  19
  20  You should have received a copy of the GNU General Public License along with
  21  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  22  Place - Suite 330, Boston, MA  02111-1307, USA.
  23
  24  Further information about the GNU General Public License can also be found on
  25  the world wide web at http://www.gnu.org.
  26
  27 FUNCTIONAL DESCRIPTION
  28 --------------------------------------------------------------------------------
  29 See header file.
  30
  31 HISTORY
  32 --------------------------------------------------------------------------------
  33 11/17/98   JSB   Created
  34
  35 ********************************************************************************
  36 INCLUDES
  37 *******************************************************************************/
  38
  39 #ifdef FGFS
  40 #  include <simgear/compiler.h>
  41 #  ifdef FG_HAVE_STD_INCLUDES
  42 #    include <cmath>
  43 #  else
  44 #    include <math.h>
  45 #  endif
  46 #else
  47 #  include <cmath>
  48 #endif
  49
  50 #ifndef M_PI
  51 #  include <simgear/constants.h>
  52 #  define M_PI FG_PI
  53 #endif
  54
  55 #include "FGState.h"
  56 #include "FGFDMExec.h"
  57 #include "FGAtmosphere.h"
  58 #include "FGFCS.h"
  59 #include "FGAircraft.h"
  60 #include "FGTranslation.h"
  61 #include "FGRotation.h"
  62 #include "FGPosition.h"
  63 #include "FGAuxiliary.h"
  64 #include "FGOutput.h"
  65
  66 /*******************************************************************************
  67 MACROS
  68 *******************************************************************************/
  69
  70 #define RegisterVariable(ID,DEF) coeffdef[#ID] = ID; paramdef[ID] = DEF
  71
  72 /*******************************************************************************
  73 ************************************ CODE **************************************
  74 *******************************************************************************/
  75
  76 /******************************************************************************/
  77 //
  78 // For every term registered here there must be a corresponding handler in
  79 // GetParameter() below that retrieves that parameter. Also, there must be an
  80 // entry in the enum eParam definition in FGDefs.h. The ID is what must be used
  81 // in any config file entry which references that item.
  82
  83 FGState::FGState(FGFDMExec* fdex) : mTb2l(3,3),
  84     mTl2b(3,3),
  85     mTs2b(3,3),
  86     vQtrn(4)
  87 {
  88   FDMExec = fdex;
  89
  90   adot = bdot = 0.0;
  91   a = 1000.0;
  92   sim_time = 0.0;
  93   dt = 1.0/120.0;
  94
  95   RegisterVariable(FG_QBAR,           " qbar "           );
  96   RegisterVariable(FG_WINGAREA,       " wing_area "      );
  97   RegisterVariable(FG_WINGSPAN,       " wingspan "       );
  98   RegisterVariable(FG_CBAR,           " cbar "           );
  99   RegisterVariable(FG_ALPHA,          " alpha "          );
 100   RegisterVariable(FG_ALPHADOT,       " alphadot "       );
 101   RegisterVariable(FG_BETA,           " beta "           );
 102   RegisterVariable(FG_BETADOT,        " betadot "        );
 103   RegisterVariable(FG_PITCHRATE,      " pitch_rate "     );
 104   RegisterVariable(FG_ROLLRATE,       " roll_rate "      );
 105   RegisterVariable(FG_YAWRATE,        " yaw_rate "       );
 106   RegisterVariable(FG_MACH,           " mach "           );
 107   RegisterVariable(FG_ALTITUDE,       " altitude "       );
 108   RegisterVariable(FG_BI2VEL,         " BI2Vel "         );
 109   RegisterVariable(FG_CI2VEL,         " CI2Vel "         );
 110   RegisterVariable(FG_ELEVATOR_POS,   " elevator_pos "   );
 111   RegisterVariable(FG_AILERON_POS,    " aileron_pos "    );
 112   RegisterVariable(FG_RUDDER_POS,     " rudder_pos "     );
 113   RegisterVariable(FG_SPDBRAKE_POS,   " speedbrake_pos " );
 114   RegisterVariable(FG_SPOILERS_POS,   " spoiler_pos "    );
 115   RegisterVariable(FG_FLAPS_POS,      " flaps_pos "      );
 116   RegisterVariable(FG_ELEVATOR_CMD,   " elevator_cmd "   );
 117   RegisterVariable(FG_AILERON_CMD,    " aileron_cmd "    );
 118   RegisterVariable(FG_RUDDER_CMD,     " rudder_cmd "     );
 119   RegisterVariable(FG_SPDBRAKE_CMD,   " speedbrake_cmd " );
 120   RegisterVariable(FG_SPOILERS_CMD,   " spoiler_cmd "    );
 121   RegisterVariable(FG_FLAPS_CMD,      " flaps_cmd "      );
 122   RegisterVariable(FG_THROTTLE_CMD,   " throttle_cmd "   );
 123   RegisterVariable(FG_THROTTLE_POS,   " throttle_pos "   );
 124   RegisterVariable(FG_HOVERB,         " height/span "    );
 125   RegisterVariable(FG_PITCH_TRIM_CMD, " pitch_trim_cmd " );
 126 }
 127
 128 /******************************************************************************/
 129
 130 FGState::~FGState(void) {}
 131
 132 /******************************************************************************/
 133
 134 float FGState::GetParameter(eParam val_idx) {
 135   switch(val_idx) {
 136   case FG_QBAR:
 137     return FDMExec->GetTranslation()->Getqbar();
 138   case FG_WINGAREA:
 139     return FDMExec->GetAircraft()->GetWingArea();
 140   case FG_WINGSPAN:
 141     return FDMExec->GetAircraft()->GetWingSpan();
 142   case FG_CBAR:
 143     return FDMExec->GetAircraft()->Getcbar();
 144   case FG_ALPHA:
 145     return FDMExec->GetTranslation()->Getalpha();
 146   case FG_ALPHADOT:
 147     return Getadot();
 148   case FG_BETA:
 149     return FDMExec->GetTranslation()->Getbeta();
 150   case FG_BETADOT:
 151     return Getbdot();
 152   case FG_PITCHRATE:
 153     return (FDMExec->GetRotation()->GetPQR())(2);
 154   case FG_ROLLRATE:
 155     return (FDMExec->GetRotation()->GetPQR())(1);
 156   case FG_YAWRATE:
 157     return (FDMExec->GetRotation()->GetPQR())(3);
 158   case FG_ELEVATOR_POS:
 159     return FDMExec->GetFCS()->GetDePos();
 160   case FG_AILERON_POS:
 161     return FDMExec->GetFCS()->GetDaPos();
 162   case FG_RUDDER_POS:
 163     return FDMExec->GetFCS()->GetDrPos();
 164   case FG_SPDBRAKE_POS:
 165     return FDMExec->GetFCS()->GetDsbPos();
 166   case FG_SPOILERS_POS:
 167     return FDMExec->GetFCS()->GetDspPos();
 168   case FG_FLAPS_POS:
 169     return FDMExec->GetFCS()->GetDfPos();
 170   case FG_ELEVATOR_CMD:
 171     return FDMExec->GetFCS()->GetDeCmd();
 172   case FG_AILERON_CMD:
 173     return FDMExec->GetFCS()->GetDaCmd();
 174   case FG_RUDDER_CMD:
 175     return FDMExec->GetFCS()->GetDrCmd();
 176   case FG_SPDBRAKE_CMD:
 177     return FDMExec->GetFCS()->GetDsbCmd();
 178   case FG_SPOILERS_CMD:
 179     return FDMExec->GetFCS()->GetDspCmd();
 180   case FG_FLAPS_CMD:
 181     return FDMExec->GetFCS()->GetDfCmd();
 182   case FG_MACH:
 183     return FDMExec->GetTranslation()->GetMach();
 184   case FG_ALTITUDE:
 185     return FDMExec->GetPosition()->Geth();
 186   case FG_BI2VEL:
 187     if(FDMExec->GetTranslation()->GetVt() > 0)
 188         return FDMExec->GetAircraft()->GetWingSpan()/(2.0 * FDMExec->GetTranslation()->GetVt());
 189     else
 190         return 0;
 191   case FG_CI2VEL:
 192     if(FDMExec->GetTranslation()->GetVt() > 0)
 193         return FDMExec->GetAircraft()->Getcbar()/(2.0 * FDMExec->GetTranslation()->GetVt());
 194     else
 195         return 0;
 196   case FG_THROTTLE_CMD:
 197     return FDMExec->GetFCS()->GetThrottleCmd(0);
 198   case FG_THROTTLE_POS:
 199     return FDMExec->GetFCS()->GetThrottlePos(0);
 200   case FG_HOVERB:
 201     return FDMExec->GetPosition()->GetHOverB();
 202   case FG_PITCH_TRIM_CMD:
 203     return FDMExec->GetFCS()->GetPitchTrimCmd();
 204   default:
 205     cerr << "FGState::GetParameter() - No handler for parameter " << val_idx << endl;
 206     return 0.0;
 207   }
 208   return 0;
 209 }
 210
 211 /******************************************************************************/
 212
 213 float FGState::GetParameter(string val_string) {
 214   return GetParameter(coeffdef[val_string]);
 215 }
 216
 217 /******************************************************************************/
 218
 219 eParam FGState::GetParameterIndex(string val_string) {
 220   return coeffdef[val_string];
 221 }
 222
 223 /******************************************************************************/
 224
 225 void FGState::SetParameter(eParam val_idx, float val) {
 226   switch(val_idx) {
 227   case FG_ELEVATOR_POS:
 228     FDMExec->GetFCS()->SetDePos(val);
 229     break;
 230   case FG_AILERON_POS:
 231     FDMExec->GetFCS()->SetDaPos(val);
 232     break;
 233   case FG_RUDDER_POS:
 234     FDMExec->GetFCS()->SetDrPos(val);
 235     break;
 236   case FG_SPDBRAKE_POS:
 237     FDMExec->GetFCS()->SetDsbPos(val);
 238     break;
 239   case FG_SPOILERS_POS:
 240     FDMExec->GetFCS()->SetDspPos(val);
 241     break;
 242   case FG_FLAPS_POS:
 243     FDMExec->GetFCS()->SetDfPos(val);
 244     break;
 245   case FG_THROTTLE_POS:
 246     FDMExec->GetFCS()->SetThrottlePos(-1,val);
 247   }
 248 }
 249
 250 //***************************************************************************
 251 //
 252 // Reset: Assume all angles READ FROM FILE IN DEGREES !!
 253 //
 254
 255 bool FGState::Reset(string path, string acname, string fname) {
 256   string resetDef;
 257   float U, V, W;
 258   float phi, tht, psi;
 259   float latitude, longitude, h;
 260
 261   resetDef = path + "/" + acname + "/" + fname;
 262
 263   ifstream resetfile(resetDef.c_str());
 264
 265   if (resetfile) {
 266     resetfile >> U;
 267     resetfile >> V;
 268     resetfile >> W;
 269     resetfile >> latitude;
 270     resetfile >> longitude;
 271     resetfile >> phi;
 272     resetfile >> tht;
 273     resetfile >> psi;
 274     resetfile >> h;
 275     resetfile.close();
 276
 277     FDMExec->GetPosition()->SetLatitude(latitude*DEGTORAD);
 278     FDMExec->GetPosition()->SetLongitude(longitude*DEGTORAD);
 279     FDMExec->GetPosition()->Seth(h);
 280
 281     Initialize(U, V, W, phi*DEGTORAD, tht*DEGTORAD, psi*DEGTORAD,
 282                latitude*DEGTORAD, longitude*DEGTORAD, h);
 283
 284     return true;
 285   } else {
 286     cerr << "Unable to load reset file " << fname << endl;
 287     return false;
 288   }
 289 }
 290
 291 //***************************************************************************
 292 //
 293 // Initialize: Assume all angles GIVEN IN RADIANS !!
 294 //
 295
 296 void FGState::Initialize(float U, float V, float W,
 297                          float phi, float tht, float psi,
 298                          float Latitude, float Longitude, float H) {
 299   FGColumnVector vUVW(3);
 300   FGColumnVector vLocalVelNED(3);
 301   FGColumnVector vEuler(3);
 302   float alpha, beta;
 303   float qbar, Vt;
 304
 305   FDMExec->GetPosition()->SetLatitude(Latitude);
 306   FDMExec->GetPosition()->SetLongitude(Longitude);
 307   FDMExec->GetPosition()->Seth(H);
 308
 309   FDMExec->GetAtmosphere()->Run();
 310
 311   if (W != 0.0)
 312     alpha = U*U > 0.0 ? atan2(W, U) : 0.0;
 313   else
 314     alpha = 0.0;
 315   if (V != 0.0)
 316     beta = U*U+W*W > 0.0 ? atan2(V, (fabs(U)/U)*sqrt(U*U + W*W)) : 0.0;
 317   else
 318     beta = 0.0;
 319
 320   vUVW << U << V << W;
 321   FDMExec->GetTranslation()->SetUVW(vUVW);
 322
 323   vEuler << phi << tht << psi;
 324   FDMExec->GetRotation()->SetEuler(vEuler);
 325
 326   FDMExec->GetTranslation()->SetAB(alpha, beta);
 327
 328   Vt = sqrt(U*U + V*V + W*W);
 329   FDMExec->GetTranslation()->SetVt(Vt);
 330
 331   FDMExec->GetTranslation()->SetMach(Vt/FDMExec->GetAtmosphere()->GetSoundSpeed());
 332
 333   qbar = 0.5*(U*U + V*V + W*W)*FDMExec->GetAtmosphere()->GetDensity();
 334   FDMExec->GetTranslation()->Setqbar(qbar);
 335
 336   InitMatrices(phi, tht, psi);
 337
 338   vLocalVelNED = mTb2l*vUVW;
 339   FDMExec->GetPosition()->SetvVel(vLocalVelNED);
 340 }
 341
 342 /******************************************************************************/
 343
 344 void FGState::Initialize(FGInitialCondition *FGIC) {
 345
 346   float tht,psi,phi;
 347   float U, V, W, h;
 348   float latitude, longitude;
 349
 350   latitude = FGIC->GetLatitudeRadIC();
 351   longitude = FGIC->GetLongitudeRadIC();
 352   h = FGIC->GetAltitudeFtIC();
 353   U = FGIC->GetUBodyFpsIC();
 354   V = FGIC->GetVBodyFpsIC();
 355   W = FGIC->GetWBodyFpsIC();
 356   tht = FGIC->GetThetaRadIC();
 357   phi = FGIC->GetPhiRadIC();
 358   psi = FGIC->GetPsiRadIC();
 359
 360   Initialize(U, V, W, phi, tht, psi, latitude, longitude, h);
 361 }
 362
 363 /******************************************************************************/
 364
 365 bool FGState::StoreData(string fname) {
 366   ofstream datafile(fname.c_str());
 367
 368   if (datafile) {
 369     datafile << (FDMExec->GetTranslation()->GetUVW())(1);
 370     datafile << (FDMExec->GetTranslation()->GetUVW())(2);
 371     datafile << (FDMExec->GetTranslation()->GetUVW())(3);
 372     datafile << FDMExec->GetPosition()->GetLatitude();
 373     datafile << FDMExec->GetPosition()->GetLongitude();
 374     datafile << (FDMExec->GetRotation()->GetEuler())(1);
 375     datafile << (FDMExec->GetRotation()->GetEuler())(2);
 376     datafile << (FDMExec->GetRotation()->GetEuler())(3);
 377     datafile << FDMExec->GetPosition()->Geth();
 378     datafile.close();
 379     return true;
 380   } else {
 381     cerr << "Could not open dump file " << fname << endl;
 382     return false;
 383   }
 384 }
 385
 386 /******************************************************************************/
 387
 388 void FGState::InitMatrices(float phi, float tht, float psi) {
 389   float thtd2, psid2, phid2;
 390   float Sthtd2, Spsid2, Sphid2;
 391   float Cthtd2, Cpsid2, Cphid2;
 392   float Cphid2Cthtd2;
 393   float Cphid2Sthtd2;
 394   float Sphid2Sthtd2;
 395   float Sphid2Cthtd2;
 396
 397   thtd2 = tht/2.0;
 398   psid2 = psi/2.0;
 399   phid2 = phi/2.0;
 400
 401   Sthtd2 = sin(thtd2);
 402   Spsid2 = sin(psid2);
 403   Sphid2 = sin(phid2);
 404
 405   Cthtd2 = cos(thtd2);
 406   Cpsid2 = cos(psid2);
 407   Cphid2 = cos(phid2);
 408
 409   Cphid2Cthtd2 = Cphid2*Cthtd2;
 410   Cphid2Sthtd2 = Cphid2*Sthtd2;
 411   Sphid2Sthtd2 = Sphid2*Sthtd2;
 412   Sphid2Cthtd2 = Sphid2*Cthtd2;
 413
 414   vQtrn(1) = Cphid2Cthtd2*Cpsid2 + Sphid2Sthtd2*Spsid2;
 415   vQtrn(2) = Sphid2Cthtd2*Cpsid2 - Cphid2Sthtd2*Spsid2;
 416   vQtrn(3) = Cphid2Sthtd2*Cpsid2 + Sphid2Cthtd2*Spsid2;
 417   vQtrn(4) = Cphid2Cthtd2*Spsid2 - Sphid2Sthtd2*Cpsid2;
 418
 419   CalcMatrices();
 420 }
 421
 422 /******************************************************************************/
 423
 424 void FGState::CalcMatrices(void) {
 425   float Q0Q0, Q1Q1, Q2Q2, Q3Q3;
 426   float Q0Q1, Q0Q2, Q0Q3, Q1Q2;
 427   float Q1Q3, Q2Q3;
 428
 429   Q0Q0 = vQtrn(1)*vQtrn(1);
 430   Q1Q1 = vQtrn(2)*vQtrn(2);
 431   Q2Q2 = vQtrn(3)*vQtrn(3);
 432   Q3Q3 = vQtrn(4)*vQtrn(4);
 433   Q0Q1 = vQtrn(1)*vQtrn(2);
 434   Q0Q2 = vQtrn(1)*vQtrn(3);
 435   Q0Q3 = vQtrn(1)*vQtrn(4);
 436   Q1Q2 = vQtrn(2)*vQtrn(3);
 437   Q1Q3 = vQtrn(2)*vQtrn(4);
 438   Q2Q3 = vQtrn(3)*vQtrn(4);
 439
 440   mTl2b(1,1) = Q0Q0 + Q1Q1 - Q2Q2 - Q3Q3;
 441   mTl2b(1,2) = 2*(Q1Q2 + Q0Q3);
 442   mTl2b(1,3) = 2*(Q1Q3 - Q0Q2);
 443   mTl2b(2,1) = 2*(Q1Q2 - Q0Q3);
 444   mTl2b(2,2) = Q0Q0 - Q1Q1 + Q2Q2 - Q3Q3;
 445   mTl2b(2,3) = 2*(Q2Q3 + Q0Q1);
 446   mTl2b(3,1) = 2*(Q1Q3 + Q0Q2);
 447   mTl2b(3,2) = 2*(Q2Q3 - Q0Q1);
 448   mTl2b(3,3) = Q0Q0 - Q1Q1 - Q2Q2 + Q3Q3;
 449
 450   mTb2l = mTl2b;
 451   mTb2l.T();
 452 }
 453
 454 /******************************************************************************/
 455
 456 void FGState::IntegrateQuat(FGColumnVector vPQR, int rate) {
 457   static FGColumnVector vlastQdot(4);
 458   static FGColumnVector vQdot(4);
 459
 460   vQdot(1) = -0.5*(vQtrn(2)*vPQR(eP) + vQtrn(3)*vPQR(eQ) + vQtrn(4)*vPQR(eR));
 461   vQdot(2) =  0.5*(vQtrn(1)*vPQR(eP) + vQtrn(3)*vPQR(eR) - vQtrn(4)*vPQR(eQ));
 462   vQdot(3) =  0.5*(vQtrn(1)*vPQR(eQ) + vQtrn(4)*vPQR(eP) - vQtrn(2)*vPQR(eR));
 463   vQdot(4) =  0.5*(vQtrn(1)*vPQR(eR) + vQtrn(2)*vPQR(eQ) - vQtrn(3)*vPQR(eP));
 464
 465   vQtrn += 0.5*dt*rate*(vlastQdot + vQdot);
 466
 467   vQtrn.Normalize();
 468
 469   vlastQdot = vQdot;
 470 }
 471
 472 /******************************************************************************/
 473
 474 FGColumnVector FGState::CalcEuler(void) {
 475   static FGColumnVector vEuler(3);
 476
 477   if (mTl2b(3,3) == 0.0) mTl2b(3,3) = 0.0000001;
 478   if (mTl2b(1,1) == 0.0) mTl2b(1,1) = 0.0000001;
 479
 480   vEuler(ePhi) = atan2(mTl2b(2,3), mTl2b(3,3));
 481   vEuler(eTht) = asin(-mTl2b(1,3));
 482   vEuler(ePsi) = atan2(mTl2b(1,2), mTl2b(1,1));
 483
 484   if (vEuler(ePsi) < 0.0) vEuler(ePsi) += 2*M_PI;
 485
 486   return vEuler;
 487 }
 488
 489 /******************************************************************************/
 490
 491 FGMatrix FGState::GetTs2b(float alpha, float beta) {
 492   float ca, cb, sa, sb;
 493
 494   ca = cos(alpha);
 495   sa = sin(alpha);
 496   cb = cos(beta);
 497   sb = sin(beta);
 498
 499   mTs2b(1,1) = -ca*cb;
 500   mTs2b(1,2) = -ca*sb;
 501   mTs2b(1,3) = sa;
 502   mTs2b(2,1) = -sb;
 503   mTs2b(2,2) = cb;
 504   mTs2b(2,3) = 0.0;
 505   mTs2b(3,1) = -sa*cb;
 506   mTs2b(3,2) = -sa*sb;
 507   mTs2b(3,3) = -ca;
 508
 509   return mTs2b;
 510 }
 511
 512 /******************************************************************************/
 513