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 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 General Public License for more
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.
24 Further information about the GNU 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"
43 static const char *IdSrc = "$Id$";
44 static const char *IdHdr = ID_MASSBALANCE;
46 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
48 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
51 FGMassBalance::FGMassBalance(FGFDMExec* fdmex) : FGModel(fdmex)
53 Name = "FGMassBalance";
58 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
60 FGMassBalance::~FGMassBalance()
65 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
67 bool FGMassBalance::Run(void)
69 if (!FGModel::Run()) {
71 Weight = EmptyWeight + Propulsion->GetTanksWeight() + GetPointMassWeight();
73 Mass = Weight / Inertial->gravity();
75 // Calculate new CG here.
77 vXYZcg = (Propulsion->GetTanksCG() + EmptyWeight*vbaseXYZcg
78 + GetPointMassCG() ) / Weight;
80 // Calculate new moments of inertia here
82 Ixx = baseIxx + Propulsion->GetTanksIxx(vXYZcg) + GetPMIxx();
83 Iyy = baseIyy + Propulsion->GetTanksIyy(vXYZcg) + GetPMIyy();
84 Izz = baseIzz + Propulsion->GetTanksIzz(vXYZcg) + GetPMIzz();
85 Ixy = baseIxy + Propulsion->GetTanksIxy(vXYZcg) + GetPMIxy();
86 Ixz = baseIxz + Propulsion->GetTanksIxz(vXYZcg) + GetPMIxz();
96 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
98 void FGMassBalance::AddPointMass(double weight, double X, double Y, double Z)
100 PointMassLoc.push_back(*(new FGColumnVector3(X, Y, Z)));
101 PointMassWeight.push_back(weight);
104 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
106 double FGMassBalance::GetPointMassWeight(void)
108 double PM_total_weight = 0.0;
110 for (unsigned int i=0; i<PointMassWeight.size(); i++) {
111 PM_total_weight += PointMassWeight[i];
113 return PM_total_weight;
116 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
118 FGColumnVector3& FGMassBalance::GetPointMassCG(void)
120 PointMassCG.InitMatrix();
122 for (unsigned int i=0; i<PointMassLoc.size(); i++) {
123 PointMassCG += PointMassWeight[i]*PointMassLoc[i];
128 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
130 double FGMassBalance::GetPMIxx(void)
133 for (unsigned int i=0; i<PointMassLoc.size(); i++) {
134 I += PointMassLoc[i](eX)*PointMassLoc[i](eX)*PointMassWeight[i];
136 I /= (144.0*Inertial->gravity());
140 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
142 double FGMassBalance::GetPMIyy(void)
145 for (unsigned int i=0; i<PointMassLoc.size(); i++) {
146 I += PointMassLoc[i](eY)*PointMassLoc[i](eY)*PointMassWeight[i];
148 I /= (144.0*Inertial->gravity());
152 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
154 double FGMassBalance::GetPMIzz(void)
157 for (unsigned int i=0; i<PointMassLoc.size(); i++) {
158 I += PointMassLoc[i](eZ)*PointMassLoc[i](eZ)*PointMassWeight[i];
160 I /= (144.0*Inertial->gravity());
164 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
166 double FGMassBalance::GetPMIxy(void)
169 for (unsigned int i=0; i<PointMassLoc.size(); i++) {
170 I += PointMassLoc[i](eX)*PointMassLoc[i](eY)*PointMassWeight[i];
172 I /= (144.0*Inertial->gravity());
176 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
178 double FGMassBalance::GetPMIxz(void)
181 for (unsigned int i=0; i<PointMassLoc.size(); i++) {
182 I += PointMassLoc[i](eX)*PointMassLoc[i](eZ)*PointMassWeight[i];
184 I /= (144.0*Inertial->gravity());
188 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
189 // The bitmasked value choices are as follows:
190 // unset: In this case (the default) JSBSim would only print
191 // out the normally expected messages, essentially echoing
192 // the config files as they are read. If the environment
193 // variable is not set, debug_lvl is set to 1 internally
194 // 0: This requests JSBSim not to output any messages
196 // 1: This value explicity requests the normal JSBSim
198 // 2: This value asks for a message to be printed out when
199 // a class is instantiated
200 // 4: When this value is set, a message is displayed when a
201 // FGModel object executes its Run() method
202 // 8: When this value is set, various runtime state variables
203 // are printed out periodically
204 // 16: When set various parameters are sanity checked and
205 // a message is printed out when they go out of bounds
207 void FGMassBalance::Debug(int from)
209 if (debug_lvl <= 0) return;
211 if (debug_lvl & 1) { // Standard console startup message output
212 if (from == 0) { // Constructor
216 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
217 if (from == 0) cout << "Instantiated: FGPiston" << endl;
218 if (from == 1) cout << "Destroyed: FGPiston" << endl;
220 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
222 if (debug_lvl & 8 ) { // Runtime state variables
224 if (debug_lvl & 16) { // Sanity checking
226 if (EmptyWeight <= 0.0 || EmptyWeight > 1e9)
227 cout << "MassBalance::EmptyWeight out of bounds: " << EmptyWeight << endl;
228 if (Weight <= 0.0 || Weight > 1e9)
229 cout << "MassBalance::Weight out of bounds: " << Weight << endl;
230 if (Mass <= 0.0 || Mass > 1e9)
231 cout << "MassBalance::Mass out of bounds: " << Mass << endl;
234 if (debug_lvl & 64) {
235 if (from == 0) { // Constructor
236 cout << IdSrc << endl;
237 cout << IdHdr << endl;