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