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 #  include <math.h>
  42 #else
  43 #  if defined(sgi) && !defined(__GNUC__)
  44 #    include <math.h>
  45 #  else
  46 #    include <cmath>
  47 #  endif
  48 #endif
  49
  50 #ifdef _WIN32
  51 #define snprintf _snprintf
  52 #endif
  53
  54 #include "FGState.h"
  55
  56 namespace JSBSim {
  57
  58 static const char *IdSrc = "$Id$";
  59 static const char *IdHdr = ID_STATE;
  60
  61 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  62 MACROS
  63 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  64
  65 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  66 CLASS IMPLEMENTATION
  67 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  68
  69 FGState::FGState(FGFDMExec* fdex)
  70 {
  71   FDMExec = fdex;
  72
  73   a = 1000.0;
  74   sim_time = 0.0;
  75   dt = 1.0/120.0;
  76
  77   Aircraft     = FDMExec->GetAircraft();
  78   Translation  = FDMExec->GetTranslation();
  79   Rotation     = FDMExec->GetRotation();
  80   Position     = FDMExec->GetPosition();
  81   FCS          = FDMExec->GetFCS();
  82   Output       = FDMExec->GetOutput();
  83   Atmosphere   = FDMExec->GetAtmosphere();
  84   Aerodynamics = FDMExec->GetAerodynamics();
  85   GroundReactions = FDMExec->GetGroundReactions();
  86   Propulsion      = FDMExec->GetPropulsion();
  87   PropertyManager = FDMExec->GetPropertyManager();
  88
  89   for(int i=0;i<3;i++) vQdot_prev[i].InitMatrix();
  90
  91   bind();
  92
  93   Debug(0);
  94 }
  95
  96 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  97
  98 FGState::~FGState()
  99 {
 100   unbind();
 101   Debug(1);
 102 }
 103
 104 //***************************************************************************
 105 //
 106 // Initialize: Assume all angles GIVEN IN RADIANS !!
 107 //
 108
 109 void FGState::Initialize(double U, double V, double W,
 110                          double phi, double tht, double psi,
 111                          double Latitude, double Longitude, double H,
 112                          double wnorth, double weast, double wdown)
 113 {
 114   double alpha, beta;
 115   double qbar, Vt;
 116   FGColumnVector3 vAeroUVW;
 117
 118   Position->SetLatitude(Latitude);
 119   Position->SetLongitude(Longitude);
 120   Position->Seth(H);
 121
 122   Atmosphere->Run();
 123
 124   vLocalEuler << phi << tht << psi;
 125   Rotation->SetEuler(vLocalEuler);
 126
 127   InitMatrices(phi, tht, psi);
 128
 129   vUVW << U << V << W;
 130   Translation->SetUVW(vUVW);
 131
 132   Atmosphere->SetWindNED(wnorth, weast, wdown);
 133
 134   vAeroUVW = vUVW + mTl2b*Atmosphere->GetWindNED();
 135
 136   if (vAeroUVW(eW) != 0.0)
 137     alpha = vAeroUVW(eU)*vAeroUVW(eU) > 0.0 ? atan2(vAeroUVW(eW), vAeroUVW(eU)) : 0.0;
 138   else
 139     alpha = 0.0;
 140   if (vAeroUVW(eV) != 0.0)
 141     beta = vAeroUVW(eU)*vAeroUVW(eU)+vAeroUVW(eW)*vAeroUVW(eW) > 0.0 ? atan2(vAeroUVW(eV), (fabs(vAeroUVW(eU))/vAeroUVW(eU))*sqrt(vAeroUVW(eU)*vAeroUVW(eU) + vAeroUVW(eW)*vAeroUVW(eW))) : 0.0;
 142   else
 143     beta = 0.0;
 144
 145   Translation->SetAB(alpha, beta);
 146
 147   Vt = sqrt(U*U + V*V + W*W);
 148   Translation->SetVt(Vt);
 149
 150   Translation->SetMach(Vt/Atmosphere->GetSoundSpeed());
 151
 152   qbar = 0.5*(U*U + V*V + W*W)*Atmosphere->GetDensity();
 153   Translation->Setqbar(qbar);
 154
 155   vLocalVelNED = mTb2l*vUVW;
 156   Position->SetvVel(vLocalVelNED);
 157 }
 158
 159 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 160
 161 void FGState::Initialize(FGInitialCondition *FGIC)
 162 {
 163   double tht,psi,phi;
 164   double U, V, W, h;
 165   double latitude, longitude;
 166   double wnorth,weast, wdown;
 167
 168   latitude = FGIC->GetLatitudeRadIC();
 169   longitude = FGIC->GetLongitudeRadIC();
 170   h = FGIC->GetAltitudeFtIC();
 171   U = FGIC->GetUBodyFpsIC();
 172   V = FGIC->GetVBodyFpsIC();
 173   W = FGIC->GetWBodyFpsIC();
 174   tht = FGIC->GetThetaRadIC();
 175   phi = FGIC->GetPhiRadIC();
 176   psi = FGIC->GetPsiRadIC();
 177   wnorth = FGIC->GetWindNFpsIC();
 178   weast = FGIC->GetWindEFpsIC();
 179   wdown = FGIC->GetWindDFpsIC();
 180
 181   Position->SetSeaLevelRadius( FGIC->GetSeaLevelRadiusFtIC() );
 182   Position->SetRunwayRadius( FGIC->GetSeaLevelRadiusFtIC() +
 183                                              FGIC->GetTerrainAltitudeFtIC() );
 184
 185   // need to fix the wind speed args, here.
 186   Initialize(U, V, W, phi, tht, psi, latitude, longitude, h, wnorth, weast, wdown);
 187 }
 188
 189 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 190
 191 void FGState::InitMatrices(double phi, double tht, double psi)
 192 {
 193   double thtd2, psid2, phid2;
 194   double Sthtd2, Spsid2, Sphid2;
 195   double Cthtd2, Cpsid2, Cphid2;
 196   double Cphid2Cthtd2;
 197   double Cphid2Sthtd2;
 198   double Sphid2Sthtd2;
 199   double Sphid2Cthtd2;
 200
 201   thtd2 = tht/2.0;
 202   psid2 = psi/2.0;
 203   phid2 = phi/2.0;
 204
 205   Sthtd2 = sin(thtd2);
 206   Spsid2 = sin(psid2);
 207   Sphid2 = sin(phid2);
 208
 209   Cthtd2 = cos(thtd2);
 210   Cpsid2 = cos(psid2);
 211   Cphid2 = cos(phid2);
 212
 213   Cphid2Cthtd2 = Cphid2*Cthtd2;
 214   Cphid2Sthtd2 = Cphid2*Sthtd2;
 215   Sphid2Sthtd2 = Sphid2*Sthtd2;
 216   Sphid2Cthtd2 = Sphid2*Cthtd2;
 217
 218   vQtrn(1) = Cphid2Cthtd2*Cpsid2 + Sphid2Sthtd2*Spsid2;
 219   vQtrn(2) = Sphid2Cthtd2*Cpsid2 - Cphid2Sthtd2*Spsid2;
 220   vQtrn(3) = Cphid2Sthtd2*Cpsid2 + Sphid2Cthtd2*Spsid2;
 221   vQtrn(4) = Cphid2Cthtd2*Spsid2 - Sphid2Sthtd2*Cpsid2;
 222
 223   CalcMatrices();
 224 }
 225
 226 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 227
 228 void FGState::CalcMatrices(void)
 229 {
 230   double Q0Q0, Q1Q1, Q2Q2, Q3Q3;
 231   double Q0Q1, Q0Q2, Q0Q3, Q1Q2;
 232   double Q1Q3, Q2Q3;
 233
 234   Q0Q0 = vQtrn(1)*vQtrn(1);
 235   Q1Q1 = vQtrn(2)*vQtrn(2);
 236   Q2Q2 = vQtrn(3)*vQtrn(3);
 237   Q3Q3 = vQtrn(4)*vQtrn(4);
 238   Q0Q1 = vQtrn(1)*vQtrn(2);
 239   Q0Q2 = vQtrn(1)*vQtrn(3);
 240   Q0Q3 = vQtrn(1)*vQtrn(4);
 241   Q1Q2 = vQtrn(2)*vQtrn(3);
 242   Q1Q3 = vQtrn(2)*vQtrn(4);
 243   Q2Q3 = vQtrn(3)*vQtrn(4);
 244
 245   mTl2b(1,1) = Q0Q0 + Q1Q1 - Q2Q2 - Q3Q3;
 246   mTl2b(1,2) = 2*(Q1Q2 + Q0Q3);
 247   mTl2b(1,3) = 2*(Q1Q3 - Q0Q2);
 248   mTl2b(2,1) = 2*(Q1Q2 - Q0Q3);
 249   mTl2b(2,2) = Q0Q0 - Q1Q1 + Q2Q2 - Q3Q3;
 250   mTl2b(2,3) = 2*(Q2Q3 + Q0Q1);
 251   mTl2b(3,1) = 2*(Q1Q3 + Q0Q2);
 252   mTl2b(3,2) = 2*(Q2Q3 - Q0Q1);
 253   mTl2b(3,3) = Q0Q0 - Q1Q1 - Q2Q2 + Q3Q3;
 254
 255   mTb2l = mTl2b;
 256   mTb2l.T();
 257 }
 258
 259 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 260
 261 void FGState::IntegrateQuat(FGColumnVector3 vPQR, int rate)
 262 {
 263   vQdot(1) = -0.5*(vQtrn(2)*vPQR(eP) + vQtrn(3)*vPQR(eQ) + vQtrn(4)*vPQR(eR));
 264   vQdot(2) =  0.5*(vQtrn(1)*vPQR(eP) + vQtrn(3)*vPQR(eR) - vQtrn(4)*vPQR(eQ));
 265   vQdot(3) =  0.5*(vQtrn(1)*vPQR(eQ) + vQtrn(4)*vPQR(eP) - vQtrn(2)*vPQR(eR));
 266   vQdot(4) =  0.5*(vQtrn(1)*vPQR(eR) + vQtrn(2)*vPQR(eQ) - vQtrn(3)*vPQR(eP));
 267
 268   vQtrn += Integrate(TRAPZ, dt*rate, vQdot, vQdot_prev);
 269
 270   vQtrn.Normalize();
 271 }
 272
 273 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 274
 275 FGColumnVector3& FGState::CalcEuler(void)
 276 {
 277   if (mTl2b(3,3) == 0.0) mTl2b(3,3) = 0.0000001;
 278   if (mTl2b(1,1) == 0.0) mTl2b(1,1) = 0.0000001;
 279
 280   vEuler(ePhi) = atan2(mTl2b(2,3), mTl2b(3,3));
 281   vEuler(eTht) = asin(-mTl2b(1,3));
 282   vEuler(ePsi) = atan2(mTl2b(1,2), mTl2b(1,1));
 283
 284   if (vEuler(ePsi) < 0.0) vEuler(ePsi) += 2*M_PI;
 285
 286   return vEuler;
 287 }
 288
 289 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 290
 291 FGMatrix33& FGState::GetTs2b(void)
 292 {
 293   double ca, cb, sa, sb;
 294
 295   double alpha = Translation->Getalpha();
 296   double beta  = Translation->Getbeta();
 297
 298   ca = cos(alpha);
 299   sa = sin(alpha);
 300   cb = cos(beta);
 301   sb = sin(beta);
 302
 303   mTs2b(1,1) = ca*cb;
 304   mTs2b(1,2) = -ca*sb;
 305   mTs2b(1,3) = -sa;
 306   mTs2b(2,1) = sb;
 307   mTs2b(2,2) = cb;
 308   mTs2b(2,3) = 0.0;
 309   mTs2b(3,1) = sa*cb;
 310   mTs2b(3,2) = -sa*sb;
 311   mTs2b(3,3) = ca;
 312
 313   return mTs2b;
 314 }
 315
 316 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 317
 318 FGMatrix33& FGState::GetTb2s(void)
 319 {
 320   float alpha,beta;
 321   float ca, cb, sa, sb;
 322
 323   alpha = Translation->Getalpha();
 324   beta  = Translation->Getbeta();
 325
 326   ca = cos(alpha);
 327   sa = sin(alpha);
 328   cb = cos(beta);
 329   sb = sin(beta);
 330
 331   mTb2s(1,1) = ca*cb;
 332   mTb2s(1,2) = sb;
 333   mTb2s(1,3) = sa*cb;
 334   mTb2s(2,1) = -ca*sb;
 335   mTb2s(2,2) = cb;
 336   mTb2s(2,3) = -sa*sb;
 337   mTb2s(3,1) = -sa;
 338   mTb2s(3,2) = 0.0;
 339   mTb2s(3,3) = ca;
 340
 341   return mTb2s;
 342 }
 343
 344 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 345
 346 void FGState::ReportState(void)
 347 {
 348 #if !defined(__BORLANDCPP__)
 349   char out[80], flap[10], gear[12];
 350
 351   cout << endl << "  JSBSim State" << endl;
 352   snprintf(out,80,"    Weight: %7.0f lbs.  CG: %5.1f, %5.1f, %5.1f inches\n",
 353                    FDMExec->GetMassBalance()->GetWeight(),
 354                    FDMExec->GetMassBalance()->GetXYZcg(1),
 355                    FDMExec->GetMassBalance()->GetXYZcg(2),
 356                    FDMExec->GetMassBalance()->GetXYZcg(3));
 357   cout << out;
 358   if ( FCS->GetDfPos() <= 0.01)
 359     snprintf(flap,10,"Up");
 360   else
 361     snprintf(flap,10,"%2.0f",FCS->GetDfPos());
 362
 363   if (FCS->GetGearPos() < 0.01)
 364     snprintf(gear,12,"Up");
 365   else if (FCS->GetGearPos() > 0.99)
 366     snprintf(gear,12,"Down");
 367   else
 368     snprintf(gear,12,"In Transit");
 369
 370   snprintf(out,80, "    Flaps: %3s  Gear: %12s\n",flap,gear);
 371   cout << out;
 372   snprintf(out,80, "    Speed: %4.0f KCAS  Mach: %5.2f\n",
 373                     FDMExec->GetAuxiliary()->GetVcalibratedKTS(),
 374                     Translation->GetMach() );
 375   cout << out;
 376   snprintf(out,80, "    Altitude: %7.0f ft.  AGL Altitude: %7.0f ft.\n",
 377                     Position->Geth(),
 378                     Position->GetDistanceAGL() );
 379   cout << out;
 380   snprintf(out,80, "    Angle of Attack: %6.2f deg  Pitch Angle: %6.2f deg\n",
 381                     Translation->Getalpha()*radtodeg,
 382                     Rotation->Gettht()*radtodeg );
 383   cout << out;
 384   snprintf(out,80, "    Flight Path Angle: %6.2f deg  Climb Rate: %5.0f ft/min\n",
 385                     Position->GetGamma()*radtodeg,
 386                     Position->Gethdot()*60 );
 387   cout << out;
 388   snprintf(out,80, "    Normal Load Factor: %4.2f g's  Pitch Rate: %5.2f deg/s\n",
 389                     Aircraft->GetNlf(),
 390                     Rotation->GetPQR(2)*radtodeg );
 391   cout << out;
 392   snprintf(out,80, "    Heading: %3.0f deg true  Sideslip: %5.2f deg  Yaw Rate: %5.2f deg/s\n",
 393                     Rotation->Getpsi()*radtodeg,
 394                     Translation->Getbeta()*radtodeg,
 395                     Rotation->GetPQR(3)*radtodeg  );
 396   cout << out;
 397   snprintf(out,80, "    Bank Angle: %5.2f deg  Roll Rate: %5.2f deg/s\n",
 398                     Rotation->Getphi()*radtodeg,
 399                     Rotation->GetPQR(1)*radtodeg );
 400   cout << out;
 401   snprintf(out,80, "    Elevator: %5.2f deg  Left Aileron: %5.2f deg  Rudder: %5.2f deg\n",
 402                     FCS->GetDePos(ofRad)*radtodeg,
 403                     FCS->GetDaLPos(ofRad)*radtodeg,
 404                     FCS->GetDrPos(ofRad)*radtodeg );
 405   cout << out;
 406   snprintf(out,80, "    Throttle: %5.2f%c\n",
 407                     FCS->GetThrottlePos(0)*100,'%' );
 408   cout << out;
 409
 410   snprintf(out,80, "    Wind Components: %5.2f kts head wind, %5.2f kts cross wind\n",
 411                     FDMExec->GetAuxiliary()->GetHeadWind()*fpstokts,
 412                     FDMExec->GetAuxiliary()->GetCrossWind()*fpstokts );
 413   cout << out;
 414
 415   snprintf(out,80, "    Ground Speed: %4.0f knots , Ground Track: %3.0f deg true\n",
 416                     Position->GetVground()*fpstokts,
 417                     Position->GetGroundTrack()*radtodeg );
 418   cout << out;
 419 #endif
 420 }
 421
 422 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 423
 424 void FGState::bind(void)
 425 {
 426   PropertyManager->Tie("sim-time-sec",this,
 427                         &FGState::Getsim_time);
 428 }
 429
 430 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 431
 432 void FGState::unbind(void)
 433 {
 434   PropertyManager->Untie("sim-time-sec");
 435 }
 436
 437 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 438 //    The bitmasked value choices are as follows:
 439 //    unset: In this case (the default) JSBSim would only print
 440 //       out the normally expected messages, essentially echoing
 441 //       the config files as they are read. If the environment
 442 //       variable is not set, debug_lvl is set to 1 internally
 443 //    0: This requests JSBSim not to output any messages
 444 //       whatsoever.
 445 //    1: This value explicity requests the normal JSBSim
 446 //       startup messages
 447 //    2: This value asks for a message to be printed out when
 448 //       a class is instantiated
 449 //    4: When this value is set, a message is displayed when a
 450 //       FGModel object executes its Run() method
 451 //    8: When this value is set, various runtime state variables
 452 //       are printed out periodically
 453 //    16: When set various parameters are sanity checked and
 454 //       a message is printed out when they go out of bounds
 455
 456 void FGState::Debug(int from)
 457 {
 458   if (debug_lvl <= 0) return;
 459
 460   if (debug_lvl & 1) { // Standard console startup message output
 461     if (from == 0) { // Constructor
 462
 463     }
 464   }
 465   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 466     if (from == 0) cout << "Instantiated: FGState" << endl;
 467     if (from == 1) cout << "Destroyed:    FGState" << endl;
 468   }
 469   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 470   }
 471   if (debug_lvl & 8 ) { // Runtime state variables
 472   }
 473   if (debug_lvl & 16) { // Sanity checking
 474   }
 475   if (debug_lvl & 64) {
 476     if (from == 0) { // Constructor
 477       cout << IdSrc << endl;
 478       cout << IdHdr << endl;
 479     }
 480   }
 481 }
 482 }