]> git.mxchange.org Git - flightgear.git/blob - src/FDM/JSBSim/FGAuxiliary.cpp
#include <config.h> where needed for cygwin/gcc-3.2.
[flightgear.git] / src / FDM / JSBSim / FGAuxiliary.cpp
1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2  
3  Module:       FGAuxiliary.cpp
4  Author:       Tony Peden, Jon Berndt
5  Date started: 01/26/99
6  Purpose:      Calculates additional parameters needed by the visual system, etc.
7  Called by:    FGSimExec
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 calculates various auxiliary parameters.
31
32 REFERENCES
33   Anderson, John D. "Introduction to Flight", 3rd Edition, McGraw-Hill, 1989
34                     pgs. 112-126
35 HISTORY
36 --------------------------------------------------------------------------------
37 01/26/99   JSB   Created
38
39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
40 INCLUDES
41 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
42
43 #include "FGAuxiliary.h"
44 #include "FGAerodynamics.h"
45 #include "FGTranslation.h"
46 #include "FGRotation.h"
47 #include "FGAtmosphere.h"
48 #include "FGState.h"
49 #include "FGFDMExec.h"
50 #include "FGFCS.h"
51 #include "FGAircraft.h"
52 #include "FGPosition.h"
53 #include "FGOutput.h"
54 #include "FGInertial.h"
55 #include "FGMatrix33.h"
56 #include "FGColumnVector3.h"
57 #include "FGColumnVector4.h"
58 #include "FGPropertyManager.h"
59
60 static const char *IdSrc = "$Id$";
61 static const char *IdHdr = ID_AUXILIARY;
62
63 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
64 CLASS IMPLEMENTATION
65 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
66
67
68 FGAuxiliary::FGAuxiliary(FGFDMExec* fdmex) : FGModel(fdmex)
69 {
70   Name = "FGAuxiliary";
71   vcas = veas = mach = qbar = pt = 0;
72   psl = rhosl = 1;
73   earthPosAngle = 0.0;
74   
75   vPilotAccelN.InitMatrix();
76   
77   bind();
78   
79   Debug(0);
80 }
81
82 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
83
84 FGAuxiliary::~FGAuxiliary()
85 {
86   unbind();
87   Debug(1);
88 }
89
90 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
91
92 bool FGAuxiliary::Run()
93 {
94   double A,B,D;
95
96   if (!FGModel::Run()) {
97     GetState();
98     if (mach < 1) {   //calculate total pressure assuming isentropic flow
99       pt=p*pow((1 + 0.2*mach*mach),3.5);
100     } else {
101       // shock in front of pitot tube, we'll assume its normal and use
102       // the Rayleigh Pitot Tube Formula, i.e. the ratio of total
103       // pressure behind the shock to the static pressure in front
104
105       B = 5.76*mach*mach/(5.6*mach*mach - 0.8);
106
107       // The denominator above is zero for Mach ~ 0.38, for which
108       // we'll never be here, so we're safe
109
110       D = (2.8*mach*mach-0.4)*0.4167;
111       pt = p*pow(B,3.5)*D;
112     }
113
114     A = pow(((pt-p)/psl+1),0.28571);
115     vcas = sqrt(7*psl/rhosl*(A-1));
116     veas = sqrt(2*qbar/rhosl);
117
118     // Pilot sensed accelerations are calculated here. This is used
119     // for the coordinated turn ball instrument. Motion base platforms sometimes
120     // use the derivative of pilot sensed accelerations as the driving parameter,
121     // rather than straight accelerations.
122     //
123     // The theory behind pilot-sensed calculations is presented:
124     //
125     // For purposes of discussion and calculation, assume for a minute that the
126     // pilot is in space and motionless in inertial space. She will feel
127     // no accelerations. If the aircraft begins to accelerate along any axis or
128     // axes (without rotating), the pilot will sense those accelerations. If
129     // any rotational moment is applied, the pilot will sense an acceleration
130     // due to that motion in the amount:
131     //
132     // [wdot X R]  +  [w X (w X R)]
133     //   Term I          Term II
134     //
135     // where:
136     //
137     // wdot = omegadot, the rotational acceleration rate vector
138     // w    = omega, the rotational rate vector
139     // R    = the vector from the aircraft CG to the pilot eyepoint
140     //
141     // The sum total of these two terms plus the acceleration of the aircraft
142     // body axis gives the acceleration the pilot senses in inertial space.
143     // In the presence of a large body such as a planet, a gravity field also
144     // provides an accelerating attraction. This acceleration can be transformed
145     // from the reference frame of the planet so as to be expressed in the frame
146     // of reference of the aircraft. This gravity field accelerating attraction
147     // is felt by the pilot as a force on her tushie as she sits in her aircraft
148     // on the runway awaiting takeoff clearance.
149     //
150     // In JSBSim the acceleration of the body frame in inertial space is given
151     // by the F = ma relation. If the vForces vector is divided by the aircraft
152     // mass, the acceleration vector is calculated. The term wdot is equivalent
153     // to the JSBSim vPQRdot vector, and the w parameter is equivalent to vPQR.
154     // The radius R is calculated below in the vector vToEyePt.
155     
156     vPilotAccel.InitMatrix();   
157     if ( Translation->GetVt() > 1 ) {
158        vPilotAccel =  Aerodynamics->GetForces() 
159                   +  Propulsion->GetForces()
160                   +  GroundReactions->GetForces();
161        vPilotAccel /= MassBalance->GetMass();
162        vToEyePt = Aircraft->GetXYZep() - MassBalance->GetXYZcg();
163        vToEyePt *= inchtoft;
164        vPilotAccel += Rotation->GetPQRdot() * vToEyePt;
165        vPilotAccel += Rotation->GetPQR() * (Rotation->GetPQR() * vToEyePt);
166     } else {
167        vPilotAccel = -1*( State->GetTl2b() * Inertial->GetGravity() );
168     }   
169
170     vPilotAccelN = vPilotAccel/Inertial->gravity();
171       
172     
173     earthPosAngle += State->Getdt()*Inertial->omega();
174     return false;
175   } else {
176     return true;
177   }
178 }
179
180 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
181
182 double FGAuxiliary::GetHeadWind(void)
183 {
184   double psiw,vw,psi;
185
186   psiw = Atmosphere->GetWindPsi();
187   psi = Rotation->Getpsi();
188   vw = Atmosphere->GetWindNED().Magnitude();
189
190   return vw*cos(psiw - psi);
191 }
192
193 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
194
195 double FGAuxiliary::GetCrossWind(void)
196 {
197   double psiw,vw,psi;
198
199   psiw = Atmosphere->GetWindPsi();
200   psi = Rotation->Getpsi();
201   vw = Atmosphere->GetWindNED().Magnitude();
202
203   return  vw*sin(psiw - psi);
204 }
205
206 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
207
208 void FGAuxiliary::bind(void)
209 {
210   typedef double (FGAuxiliary::*PMF)(int) const;
211   PropertyManager->Tie("velocities/vc-fps", this,
212                        &FGAuxiliary::GetVcalibratedFPS);
213   PropertyManager->Tie("velocities/vc-kts", this,
214                        &FGAuxiliary::GetVcalibratedKTS);
215   PropertyManager->Tie("velocities/ve-fps", this,
216                        &FGAuxiliary::GetVequivalentFPS);
217   PropertyManager->Tie("velocities/ve-kts", this,
218                        &FGAuxiliary::GetVequivalentKTS);
219   PropertyManager->Tie("accelerations/a-pilot-x-ft_sec2", this,1,
220                        (PMF)&FGAuxiliary::GetPilotAccel);
221   PropertyManager->Tie("accelerations/a-pilot-y-ft_sec2", this,2,
222                        (PMF)&FGAuxiliary::GetPilotAccel);
223   PropertyManager->Tie("accelerations/a-pilot-z-ft_sec2", this,3,
224                        (PMF)&FGAuxiliary::GetPilotAccel);
225   PropertyManager->Tie("accelerations/n-pilot-x-norm", this,1,
226                        (PMF)&FGAuxiliary::GetNpilot);
227   PropertyManager->Tie("accelerations/n-pilot-y-norm", this,2,
228                        (PMF)&FGAuxiliary::GetNpilot);
229   PropertyManager->Tie("accelerations/n-pilot-z-norm", this,3,
230                        (PMF)&FGAuxiliary::GetNpilot);
231   PropertyManager->Tie("position/epa-rad", this,
232                        &FGAuxiliary::GetEarthPositionAngle);
233   /* PropertyManager->Tie("atmosphere/headwind-fps", this,
234                        &FGAuxiliary::GetHeadWind,
235                        true);
236   PropertyManager->Tie("atmosphere/crosswind-fps", this,
237                        &FGAuxiliary::GetCrossWind,
238                        true); */
239 }
240
241 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
242
243 void FGAuxiliary::unbind(void)
244 {
245   PropertyManager->Untie("velocities/vc-fps");
246   PropertyManager->Untie("velocities/vc-kts");
247   PropertyManager->Untie("velocities/ve-fps");
248   PropertyManager->Untie("velocities/ve-kts");
249   PropertyManager->Untie("accelerations/a-pilot-x-ft_sec2");
250   PropertyManager->Untie("accelerations/a-pilot-y-ft_sec2");
251   PropertyManager->Untie("accelerations/a-pilot-z-ft_sec2");
252   PropertyManager->Untie("accelerations/n-pilot-x-norm");
253   PropertyManager->Untie("accelerations/n-pilot-y-norm");
254   PropertyManager->Untie("accelerations/n-pilot-z-norm");
255   PropertyManager->Untie("position/epa-rad");
256   /* PropertyManager->Untie("atmosphere/headwind-fps");
257   PropertyManager->Untie("atmosphere/crosswind-fps"); */
258
259 }
260
261 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
262
263 void FGAuxiliary::GetState(void)
264 {
265   qbar = Translation->Getqbar();
266   mach = Translation->GetMach();
267   p = Atmosphere->GetPressure();
268   rhosl = Atmosphere->GetDensitySL();
269   psl = Atmosphere->GetPressureSL();
270 }
271
272 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
273 //    The bitmasked value choices are as follows:
274 //    unset: In this case (the default) JSBSim would only print
275 //       out the normally expected messages, essentially echoing
276 //       the config files as they are read. If the environment
277 //       variable is not set, debug_lvl is set to 1 internally
278 //    0: This requests JSBSim not to output any messages
279 //       whatsoever.
280 //    1: This value explicity requests the normal JSBSim
281 //       startup messages
282 //    2: This value asks for a message to be printed out when
283 //       a class is instantiated
284 //    4: When this value is set, a message is displayed when a
285 //       FGModel object executes its Run() method
286 //    8: When this value is set, various runtime state variables
287 //       are printed out periodically
288 //    16: When set various parameters are sanity checked and
289 //       a message is printed out when they go out of bounds
290
291 void FGAuxiliary::Debug(int from)
292 {
293   if (debug_lvl <= 0) return;
294
295   if (debug_lvl & 1) { // Standard console startup message output
296     if (from == 0) { // Constructor
297
298     }
299   }
300   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
301     if (from == 0) cout << "Instantiated: FGAuxiliary" << endl;
302     if (from == 1) cout << "Destroyed:    FGAuxiliary" << endl;
303   }
304   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
305   }
306   if (debug_lvl & 8 ) { // Runtime state variables
307   }
308   if (debug_lvl & 16) { // Sanity checking
309   }
310   if (debug_lvl & 64) {
311     if (from == 0) { // Constructor
312       cout << IdSrc << endl;
313       cout << IdHdr << endl;
314     }
315   }
316 }
317