1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 Module: FGMassBalance.cpp
5 Date started: 09/12/2000
6 Purpose: This module models weight and balance
8 ------------- Copyright (C) 2000 Jon S. Berndt (jsb@hal-pc.org) --------------
10 This program is free software; you can redistribute it and/or modify it under
11 the terms of the GNU Lesser General Public License as published by the Free Software
12 Foundation; either version 2 of the License, or (at your option) any later
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 Lesser General Public License for more
20 You should have received a copy of the GNU Lesser 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.
24 Further information about the GNU Lesser General Public License can also be found on
25 the world wide web at http://www.gnu.org.
27 FUNCTIONAL DESCRIPTION
28 --------------------------------------------------------------------------------
30 This class models the change in weight and balance of the aircraft due to fuel
34 --------------------------------------------------------------------------------
35 09/12/2000 JSB Created
37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
41 #include "FGMassBalance.h"
42 #include "FGPropulsion.h"
43 #include "FGBuoyantForces.h"
44 #include <input_output/FGPropertyManager.h>
48 static const char *IdSrc = "$Id$";
49 static const char *IdHdr = ID_MASSBALANCE;
51 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
53 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
56 FGMassBalance::FGMassBalance(FGFDMExec* fdmex) : FGModel(fdmex)
58 Name = "FGMassBalance";
59 Weight = EmptyWeight = Mass = 0.0;
61 vbaseXYZcg.InitMatrix(0.0);
72 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
74 FGMassBalance::~FGMassBalance()
76 for (unsigned int i=0; i<PointMasses.size(); i++) delete PointMasses[i];
82 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
84 bool FGMassBalance::InitModel(void)
86 if (!FGModel::InitModel()) return false;
91 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
93 bool FGMassBalance::Load(Element* el)
96 string element_name = "";
97 double bixx, biyy, bizz, bixy, bixz, biyz;
99 bixx = biyy = bizz = bixy = bixz = biyz = 0.0;
100 if (el->FindElement("ixx"))
101 bixx = el->FindElementValueAsNumberConvertTo("ixx", "SLUG*FT2");
102 if (el->FindElement("iyy"))
103 biyy = el->FindElementValueAsNumberConvertTo("iyy", "SLUG*FT2");
104 if (el->FindElement("izz"))
105 bizz = el->FindElementValueAsNumberConvertTo("izz", "SLUG*FT2");
106 if (el->FindElement("ixy"))
107 bixy = el->FindElementValueAsNumberConvertTo("ixy", "SLUG*FT2");
108 if (el->FindElement("ixz"))
109 bixz = el->FindElementValueAsNumberConvertTo("ixz", "SLUG*FT2");
110 if (el->FindElement("iyz"))
111 biyz = el->FindElementValueAsNumberConvertTo("iyz", "SLUG*FT2");
112 SetAircraftBaseInertias(FGMatrix33( bixx, -bixy, bixz,
114 bixz, -biyz, bizz ));
115 EmptyWeight = el->FindElementValueAsNumberConvertTo("emptywt", "LBS");
117 element = el->FindElement("location");
119 element_name = element->GetAttributeValue("name");
120 if (element_name == "CG") vbaseXYZcg = element->FindElementTripletConvertTo("IN");
121 element = el->FindNextElement("location");
124 // Find all POINTMASS elements that descend from this METRICS branch of the
127 element = el->FindElement("pointmass");
129 AddPointMass(element);
130 element = el->FindNextElement("pointmass");
133 Weight = EmptyWeight + Propulsion->GetTanksWeight() + GetPointMassWeight()
134 + BuoyantForces->GetGasMass()*slugtolb;
136 Mass = lbtoslug*Weight;
142 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
144 bool FGMassBalance::Run(void)
146 double denom, k1, k2, k3, k4, k5, k6;
147 double Ixx, Iyy, Izz, Ixy, Ixz, Iyz;
149 if (FGModel::Run()) return true;
150 if (FDMExec->Holding()) return false;
152 Weight = EmptyWeight + Propulsion->GetTanksWeight() + GetPointMassWeight()
153 + BuoyantForces->GetGasMass()*slugtolb;
155 Mass = lbtoslug*Weight;
159 vXYZcg = (Propulsion->GetTanksMoment() + EmptyWeight*vbaseXYZcg
160 + GetPointMassMoment()
161 + BuoyantForces->GetGasMassMoment()) / Weight;
163 // Calculate new total moments of inertia
165 // At first it is the base configuration inertia matrix ...
167 // ... with the additional term originating from the parallel axis theorem.
168 mJ += GetPointmassInertia( lbtoslug * EmptyWeight, vbaseXYZcg );
169 // Then add the contributions from the additional pointmasses.
170 mJ += CalculatePMInertias();
171 mJ += Propulsion->CalculateTankInertias();
172 mJ += BuoyantForces->GetGasMassInertia();
181 // Calculate inertia matrix inverse (ref. Stevens and Lewis, "Flight Control & Simulation")
183 k1 = (Iyy*Izz - Iyz*Iyz);
184 k2 = (Iyz*Ixz + Ixy*Izz);
185 k3 = (Ixy*Iyz + Iyy*Ixz);
187 denom = 1.0/(Ixx*k1 - Ixy*k2 - Ixz*k3 );
191 k4 = (Izz*Ixx - Ixz*Ixz)*denom;
192 k5 = (Ixy*Ixz + Iyz*Ixx)*denom;
193 k6 = (Ixx*Iyy - Ixy*Ixy)*denom;
195 mJinv.InitMatrix( k1, k2, k3,
204 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
206 void FGMassBalance::AddPointMass(Element* el)
210 Element* loc_element = el->FindElement("location");
211 string pointmass_name = el->GetAttributeValue("name");
213 cerr << "Pointmass " << pointmass_name << " has no location." << endl;
217 double w = el->FindElementValueAsNumberConvertTo("weight", "LBS");
218 FGColumnVector3 vXYZ = loc_element->FindElementTripletConvertTo("IN");
219 PointMasses.push_back(new PointMass(w, vXYZ));
221 int num = PointMasses.size()-1;
223 snprintf(tmp, 80, "inertia/pointmass-weight-lbs[%u]", num);
224 PropertyManager->Tie( tmp, this, num, &FGMassBalance::GetPointMassWeight,
225 &FGMassBalance::SetPointMassWeight);
228 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
230 double FGMassBalance::GetPointMassWeight(void)
232 double PM_total_weight = 0.0;
234 for (unsigned int i=0; i<PointMasses.size(); i++) {
235 PM_total_weight += PointMasses[i]->Weight;
237 return PM_total_weight;
240 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
242 FGColumnVector3& FGMassBalance::GetPointMassMoment(void)
244 PointMassCG.InitMatrix();
246 for (unsigned int i=0; i<PointMasses.size(); i++) {
247 PointMassCG += PointMasses[i]->Weight*PointMasses[i]->Location;
252 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
254 FGMatrix33& FGMassBalance::CalculatePMInertias(void)
258 size = PointMasses.size();
259 if (size == 0) return pmJ;
263 for (unsigned int i=0; i<size; i++)
264 pmJ += GetPointmassInertia( lbtoslug * PointMasses[i]->Weight, PointMasses[i]->Location );
269 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
271 FGColumnVector3 FGMassBalance::StructuralToBody(const FGColumnVector3& r) const
273 // Under the assumption that in the structural frame the:
275 // - X-axis is directed afterwards,
276 // - Y-axis is directed towards the right,
277 // - Z-axis is directed upwards,
279 // (as documented in http://jsbsim.sourceforge.net/JSBSimCoordinates.pdf)
280 // we have to subtract first the center of gravity of the plane which
281 // is also defined in the structural frame:
283 // FGColumnVector3 cgOff = r - vXYZcg;
285 // Next, we do a change of units:
287 // cgOff *= inchtoft;
289 // And then a 180 degree rotation is done about the Y axis so that the:
291 // - X-axis is directed forward,
292 // - Y-axis is directed towards the right,
293 // - Z-axis is directed downward.
295 // This is needed because the structural and body frames are 180 degrees apart.
297 return FGColumnVector3(inchtoft*(vXYZcg(1)-r(1)),
298 inchtoft*(r(2)-vXYZcg(2)),
299 inchtoft*(vXYZcg(3)-r(3)));
302 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
304 void FGMassBalance::bind(void)
306 typedef double (FGMassBalance::*PMF)(int) const;
307 PropertyManager->Tie("inertia/mass-slugs", this,
308 &FGMassBalance::GetMass);
309 PropertyManager->Tie("inertia/weight-lbs", this,
310 &FGMassBalance::GetWeight);
311 PropertyManager->Tie("inertia/empty-weight-lbs", this,
312 &FGMassBalance::GetWeight, &FGMassBalance::SetEmptyWeight);
313 PropertyManager->Tie("inertia/cg-x-in", this,1,
314 (PMF)&FGMassBalance::GetXYZcg);
315 PropertyManager->Tie("inertia/cg-y-in", this,2,
316 (PMF)&FGMassBalance::GetXYZcg);
317 PropertyManager->Tie("inertia/cg-z-in", this,3,
318 (PMF)&FGMassBalance::GetXYZcg);
321 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
322 // The bitmasked value choices are as follows:
323 // unset: In this case (the default) JSBSim would only print
324 // out the normally expected messages, essentially echoing
325 // the config files as they are read. If the environment
326 // variable is not set, debug_lvl is set to 1 internally
327 // 0: This requests JSBSim not to output any messages
329 // 1: This value explicity requests the normal JSBSim
331 // 2: This value asks for a message to be printed out when
332 // a class is instantiated
333 // 4: When this value is set, a message is displayed when a
334 // FGModel object executes its Run() method
335 // 8: When this value is set, various runtime state variables
336 // are printed out periodically
337 // 16: When set various parameters are sanity checked and
338 // a message is printed out when they go out of bounds
340 void FGMassBalance::Debug(int from)
342 if (debug_lvl <= 0) return;
344 if (debug_lvl & 1) { // Standard console startup message output
345 if (from == 2) { // Loading
346 cout << endl << " Mass and Balance:" << endl;
347 cout << " baseIxx: " << baseJ(1,1) << " slug-ft2" << endl;
348 cout << " baseIyy: " << baseJ(2,2) << " slug-ft2" << endl;
349 cout << " baseIzz: " << baseJ(3,3) << " slug-ft2" << endl;
350 cout << " baseIxy: " << baseJ(1,2) << " slug-ft2" << endl;
351 cout << " baseIxz: " << baseJ(1,3) << " slug-ft2" << endl;
352 cout << " baseIyz: " << baseJ(2,3) << " slug-ft2" << endl;
353 cout << " EmptyWeight: " << EmptyWeight << " lbm" << endl;
354 cout << " CG (x, y, z): " << vbaseXYZcg << endl;
355 // ToDo: Need to add point mass outputs here
356 for (unsigned int i=0; i<PointMasses.size(); i++) {
357 cout << " Point Mass Object: " << PointMasses[i]->Weight << " lbs. at "
358 << "X, Y, Z (in.): " << PointMasses[i]->Location(eX) << " "
359 << PointMasses[i]->Location(eY) << " "
360 << PointMasses[i]->Location(eZ) << endl;
364 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
365 if (from == 0) cout << "Instantiated: FGMassBalance" << endl;
366 if (from == 1) cout << "Destroyed: FGMassBalance" << endl;
368 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
370 if (debug_lvl & 8 ) { // Runtime state variables
372 if (debug_lvl & 16) { // Sanity checking
374 if (EmptyWeight <= 0.0 || EmptyWeight > 1e9)
375 cout << "MassBalance::EmptyWeight out of bounds: " << EmptyWeight << endl;
376 if (Weight <= 0.0 || Weight > 1e9)
377 cout << "MassBalance::Weight out of bounds: " << Weight << endl;
378 if (Mass <= 0.0 || Mass > 1e9)
379 cout << "MassBalance::Mass out of bounds: " << Mass << endl;
382 if (debug_lvl & 64) {
383 if (from == 0) { // Constructor
384 cout << IdSrc << endl;
385 cout << IdHdr << endl;