]> git.mxchange.org Git - flightgear.git/blob - src/FDM/JSBSim/FGPosition.cpp
Added FGTurbine.[ch]*
[flightgear.git] / src / FDM / JSBSim / FGPosition.cpp
1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2  
3  Module:       FGPosition.cpp
4  Author:       Jon S. Berndt
5  Date started: 01/05/99
6  Purpose:      Integrate the EOM to determine instantaneous position
7  Called by:    FGFDMExec
8  
9  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
10  
11  This program is free software; you can redistribute it and/or modify it under
12  the terms of the GNU General Public License as published by the Free Software
13  Foundation; either version 2 of the License, or (at your option) any later
14  version.
15  
16  This program is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
19  details.
20  
21  You should have received a copy of the GNU General Public License along with
22  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
23  Place - Suite 330, Boston, MA  02111-1307, USA.
24  
25  Further information about the GNU General Public License can also be found on
26  the world wide web at http://www.gnu.org.
27  
28 FUNCTIONAL DESCRIPTION
29 --------------------------------------------------------------------------------
30 This class encapsulates the integration of rates and accelerations to get the
31 current position of the aircraft.
32
33 HISTORY
34 --------------------------------------------------------------------------------
35 01/05/99   JSB   Created
36
37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
38 COMMENTS, REFERENCES,  and NOTES
39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
40 [1] Cooke, Zyda, Pratt, and McGhee, "NPSNET: Flight Simulation Dynamic Modeling
41     Using Quaternions", Presence, Vol. 1, No. 4, pp. 404-420  Naval Postgraduate
42     School, January 1994
43 [2] D. M. Henderson, "Euler Angles, Quaternions, and Transformation Matrices",
44     JSC 12960, July 1977
45 [3] Richard E. McFarland, "A Standard Kinematic Model for Flight Simulation at
46     NASA-Ames", NASA CR-2497, January 1975
47 [4] Barnes W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics",
48     Wiley & Sons, 1979 ISBN 0-471-03032-5
49 [5] Bernard Etkin, "Dynamics of Flight, Stability and Control", Wiley & Sons,
50     1982 ISBN 0-471-08936-2
51
52 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
53 INCLUDES
54 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
55
56 #ifdef FGFS
57 #  include <simgear/compiler.h>
58 #  ifdef SG_HAVE_STD_INCLUDES
59 #    include <cmath>
60 #    include <iomanip>
61 #  else
62 #    include <math.h>
63 #    include <iomanip.h>
64 #  endif
65 #else
66 #  if defined(sgi) && !defined(__GNUC__)
67 #    include <math.h>
68 #    include <iomanip.h>
69 #  else
70 #    include <cmath>
71 #    include <iomanip>
72 #  endif
73 #endif
74
75 #include "FGPosition.h"
76 #include "FGAtmosphere.h"
77 #include "FGState.h"
78 #include "FGFDMExec.h"
79 #include "FGFCS.h"
80 #include "FGAircraft.h"
81 #include "FGMassBalance.h"
82 #include "FGTranslation.h"
83 #include "FGRotation.h"
84 #include "FGAuxiliary.h"
85 #include "FGOutput.h"
86 #include "FGPropertyManager.h"
87
88
89 static const char *IdSrc = "$Id$";
90 static const char *IdHdr = ID_POSITION;
91
92 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
93 CLASS IMPLEMENTATION
94 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
95
96 extern double globalTriNormal[3];
97 extern double globalSceneryAltitude;
98 extern double globalSeaLevelRadius;
99
100 FGPosition::FGPosition(FGFDMExec* fdmex) : FGModel(fdmex)
101 {
102   Name = "FGPosition";
103   LongitudeDot = LatitudeDot = RadiusDot = 0.0;
104   
105   for (int i=0;i<3;i++) {
106     LatitudeDot_prev[i]  = 0.0;
107     LongitudeDot_prev[i] = 0.0;
108     RadiusDot_prev[i]    = 0.0;
109   }
110   
111   Longitude = Latitude = 0.0;
112   gamma = Vt = Vground = 0.0;
113   hoverbmac = hoverbcg = 0.0;
114   psigt = 0.0;
115   bind();
116   Debug(0);
117 }
118
119 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
120
121 FGPosition::~FGPosition(void)
122 {
123   unbind();
124   Debug(1);
125 }
126
127 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
128
129 bool FGPosition::InitModel(void)
130 {
131   FGModel::InitModel();
132
133   h = 3.0;                                 // Est. height of aircraft cg off runway
134   SeaLevelRadius = Inertial->RefRadius();  // For initialization ONLY
135   Radius         = SeaLevelRadius + h;
136   RunwayRadius   = SeaLevelRadius;
137   DistanceAGL    = Radius - RunwayRadius;  // Geocentric
138   vRunwayNormal(3) = -1.0;                 // Initialized for standalone mode
139   b = 1;
140   return true;
141 }
142
143 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
144 /*
145 Purpose: Called on a schedule to perform Positioning algorithms
146 Notes:   [TP] Make sure that -Vt <= hdot <= Vt, which, of course, should always
147          be the case
148          [JB] Run in standalone mode, SeaLevelRadius will be reference radius.
149                In FGFS, SeaLevelRadius is stuffed from FGJSBSim in JSBSim.cxx each pass.
150 */
151
152 bool FGPosition::Run(void)
153 {
154   double cosLat;
155   double hdot_Vt;
156   FGColumnVector3 vMac;
157
158   if (!FGModel::Run()) {
159     GetState();
160
161     Vground = sqrt( vVel(eNorth)*vVel(eNorth) + vVel(eEast)*vVel(eEast) );
162     psigt =  atan2(vVel(eEast), vVel(eNorth));
163     if (psigt < 0.0)
164       psigt += 2*M_PI;
165
166     Radius    = h + SeaLevelRadius;
167
168     cosLat = cos(Latitude);
169     if (cosLat != 0) LongitudeDot = vVel(eEast) / (Radius * cosLat);
170     LatitudeDot = vVel(eNorth) / Radius;
171     RadiusDot   = -vVel(eDown);
172
173     Longitude += State->Integrate(FGState::TRAPZ, dt*rate, LongitudeDot, LongitudeDot_prev);
174     Latitude  += State->Integrate(FGState::TRAPZ, dt*rate, LatitudeDot, LatitudeDot_prev);
175     Radius    += State->Integrate(FGState::TRAPZ, dt*rate, RadiusDot, RadiusDot_prev);
176
177     h = Radius - SeaLevelRadius;           // Geocentric
178
179     DistanceAGL = Radius - RunwayRadius;   // Geocentric
180     
181     hoverbcg = DistanceAGL/b;
182     
183     vMac = State->GetTb2l()*Aircraft->GetXYZrp();
184     
185     vMac *= inchtoft;
186     hoverbmac = (DistanceAGL + vMac(3))/b;
187
188     if (Vt > 0) {
189       hdot_Vt = RadiusDot/Vt;
190       if (fabs(hdot_Vt) <= 1) gamma = asin(hdot_Vt);
191     } else {
192       gamma = 0.0;
193     }
194
195     return false;
196
197   } else {
198     return true;
199   }
200 }
201
202 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
203
204 void FGPosition::GetState(void)
205 {
206   dt = State->Getdt();
207
208   Vt        = Translation->GetVt();
209   vVel      = State->GetTb2l() * Translation->GetUVW();
210   vVelDot   = State->GetTb2l() * Translation->GetUVWdot();
211   
212   b = Aircraft->GetWingSpan();
213 }
214
215 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
216
217 void FGPosition::Seth(double tt)
218 {
219  h = tt;
220  Radius    = h + SeaLevelRadius;
221  DistanceAGL = Radius - RunwayRadius;   // Geocentric
222  hoverbcg = DistanceAGL/b;
223 }
224
225 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
226
227 void FGPosition::SetDistanceAGL(double tt)
228 {
229   DistanceAGL=tt;
230   Radius = RunwayRadius + DistanceAGL;
231   h = Radius - SeaLevelRadius;
232   hoverbcg = DistanceAGL/b;
233 }
234
235 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
236
237 void FGPosition::bind(void)
238 {
239   PropertyManager->Tie("velocities/v-north-fps", this,
240                        &FGPosition::GetVn);
241   PropertyManager->Tie("velocities/v-east-fps", this,
242                        &FGPosition::GetVe);
243   PropertyManager->Tie("velocities/v-down-fps", this,
244                        &FGPosition::GetVd);
245   PropertyManager->Tie("velocities/vg-fps", this,
246                        &FGPosition::GetVground);
247   PropertyManager->Tie("flight-path/psi-gt-rad", this,
248                        &FGPosition::GetGroundTrack);
249   PropertyManager->Tie("position/h-sl-ft", this,
250                        &FGPosition::Geth,
251                        &FGPosition::Seth,
252                        true);
253   PropertyManager->Tie("velocities/h-dot-fps", this,
254                        &FGPosition::Gethdot);
255   PropertyManager->Tie("position/lat-gc-rad", this,
256                        &FGPosition::GetLatitude,
257                        &FGPosition::SetLatitude);
258   PropertyManager->Tie("position/lat-dot-gc-rad", this,
259                        &FGPosition::GetLatitudeDot);
260   PropertyManager->Tie("position/long-gc-rad", this,
261                        &FGPosition::GetLongitude,
262                        &FGPosition::SetLongitude,
263                        true);
264   PropertyManager->Tie("position/long-dot-gc-rad", this,
265                        &FGPosition::GetLongitudeDot);
266   PropertyManager->Tie("metrics/runway-radius", this,
267                        &FGPosition::GetRunwayRadius,
268                        &FGPosition::SetRunwayRadius);
269   PropertyManager->Tie("position/h-agl-ft", this,
270                        &FGPosition::GetDistanceAGL,
271                        &FGPosition::SetDistanceAGL);
272   PropertyManager->Tie("position/radius-to-vehicle-ft", this,
273                        &FGPosition::GetRadius);
274   PropertyManager->Tie("flight-path/gamma-rad", this,
275                        &FGPosition::GetGamma,
276                        &FGPosition::SetGamma);
277   PropertyManager->Tie("aero/h_b-cg-ft", this,
278                        &FGPosition::GetHOverBCG);
279   PropertyManager->Tie("aero/h_b-mac-ft", this,
280                        &FGPosition::GetHOverBMAC);
281 }
282
283 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
284
285 void FGPosition::unbind(void)
286 {
287   PropertyManager->Untie("velocities/v-north-fps");
288   PropertyManager->Untie("velocities/v-east-fps");
289   PropertyManager->Untie("velocities/v-down-fps");
290   PropertyManager->Untie("velocities/vg-fps");
291   PropertyManager->Untie("flight-path/psi-gt-rad");
292   PropertyManager->Untie("position/h-sl-ft");
293   PropertyManager->Untie("velocities/h-dot-fps");
294   PropertyManager->Untie("position/lat-gc-rad");
295   PropertyManager->Untie("position/lat-dot-gc-rad");
296   PropertyManager->Untie("position/long-gc-rad");
297   PropertyManager->Untie("position/long-dot-gc-rad");
298   PropertyManager->Untie("metrics/runway-radius");
299   PropertyManager->Untie("position/h-agl-ft");
300   PropertyManager->Untie("position/radius-to-vehicle-ft");
301   PropertyManager->Untie("flight-path/gamma-rad");
302   PropertyManager->Untie("aero/h_b-cg-ft");
303   PropertyManager->Untie("aero/h_b-mac-ft");
304 }
305
306 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
307 //    The bitmasked value choices are as follows:
308 //    unset: In this case (the default) JSBSim would only print
309 //       out the normally expected messages, essentially echoing
310 //       the config files as they are read. If the environment
311 //       variable is not set, debug_lvl is set to 1 internally
312 //    0: This requests JSBSim not to output any messages
313 //       whatsoever.
314 //    1: This value explicity requests the normal JSBSim
315 //       startup messages
316 //    2: This value asks for a message to be printed out when
317 //       a class is instantiated
318 //    4: When this value is set, a message is displayed when a
319 //       FGModel object executes its Run() method
320 //    8: When this value is set, various runtime state variables
321 //       are printed out periodically
322 //    16: When set various parameters are sanity checked and
323 //       a message is printed out when they go out of bounds
324
325 void FGPosition::Debug(int from)
326 {
327   if (debug_lvl <= 0) return;
328
329   if (debug_lvl & 1) { // Standard console startup message output
330     if (from == 0) { // Constructor
331
332     }
333   }
334   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
335     if (from == 0) cout << "Instantiated: FGPosition" << endl;
336     if (from == 1) cout << "Destroyed:    FGPosition" << endl;
337   }
338   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
339   }
340   if (debug_lvl & 8 ) { // Runtime state variables
341   }
342   if (debug_lvl & 16) { // Sanity checking
343   }
344   if (debug_lvl & 64) {
345     if (from == 0) { // Constructor
346       cout << IdSrc << endl;
347       cout << IdHdr << endl;
348     }
349   }
350 }
351