src/FDM/JSBSim/models/propulsion/FGTank.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGTank.cpp
   4  Author:       Jon Berndt
   5  Date started: 01/21/99
   6  Called by:    FGAircraft
   7
   8  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
   9
  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
  13  version.
  14
  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
  18  details.
  19
  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.
  23
  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.
  26
  27 FUNCTIONAL DESCRIPTION
  28 --------------------------------------------------------------------------------
  29 See header file.
  30
  31 HISTORY
  32 --------------------------------------------------------------------------------
  33 01/21/99   JSB   Created
  34
  35 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  36 INCLUDES
  37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  38
  39 #include "FGTank.h"
  40
  41 using std::cerr;
  42 using std::endl;
  43 using std::cout;
  44
  45 namespace JSBSim {
  46
  47 static const char *IdSrc = "$Id$";
  48 static const char *IdHdr = ID_TANK;
  49
  50 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  51 CLASS IMPLEMENTATION
  52 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  53
  54 FGTank::FGTank(FGFDMExec* exec, Element* el, int tank_number)
  55                   : TankNumber(tank_number)
  56 {
  57   string token;
  58   Element* element;
  59   Element* element_Grain;
  60   Area = 1.0;
  61   Temperature = -9999.0;
  62   Ixx = Iyy = Izz = 0.0;
  63   Auxiliary = exec->GetAuxiliary();
  64   Radius = Capacity = Contents = Standpipe = Length = InnerRadius = 0.0;
  65   PropertyManager = exec->GetPropertyManager();
  66   vXYZ.InitMatrix();
  67   vXYZ_drain.InitMatrix();
  68
  69   type = el->GetAttributeValue("type");
  70   if      (type == "FUEL")     Type = ttFUEL;
  71   else if (type == "OXIDIZER") Type = ttOXIDIZER;
  72   else                         Type = ttUNKNOWN;
  73
  74   element = el->FindElement("location");
  75   if (element)  vXYZ = element->FindElementTripletConvertTo("IN");
  76   else          cerr << "No location found for this tank." << endl;
  77
  78   vXYZ_drain = vXYZ; // Set initial drain location to initial tank CG
  79
  80   element = el->FindElement("drain_location");
  81   if (element)  {
  82     vXYZ_drain = element->FindElementTripletConvertTo("IN");
  83   }
  84
  85   if (el->FindElement("radius"))
  86     Radius = el->FindElementValueAsNumberConvertTo("radius", "IN");
  87   if (el->FindElement("capacity"))
  88     Capacity = el->FindElementValueAsNumberConvertTo("capacity", "LBS");
  89   if (el->FindElement("contents"))
  90     InitialContents = Contents = el->FindElementValueAsNumberConvertTo("contents", "LBS");
  91   if (el->FindElement("temperature"))
  92     InitialTemperature = Temperature = el->FindElementValueAsNumber("temperature");
  93   if (el->FindElement("standpipe"))
  94     InitialStandpipe = Standpipe = el->FindElementValueAsNumberConvertTo("standpipe", "LBS");
  95
  96   Selected = true;
  97
  98   if (Capacity != 0) {
  99     PctFull = 100.0*Contents/Capacity;            // percent full; 0 to 100.0
 100   } else {
 101     Contents = 0;
 102     PctFull  = 0;
 103   }
 104
 105   // Check whether this is a solid propellant "tank". Initialize it if true.
 106
 107   grainType = gtUNKNOWN; // This is the default
 108
 109   element_Grain = el->FindElement("grain_config");
 110   if (element_Grain) {
 111
 112     strGType = element_Grain->GetAttributeValue("type");
 113     if (strGType == "CYLINDRICAL")     grainType = gtCYLINDRICAL;
 114     else if (strGType == "ENDBURNING") grainType = gtENDBURNING;
 115     else                               cerr << "Unknown propellant grain type specified" << endl;
 116
 117     if (element_Grain->FindElement("length"))
 118       Length = element_Grain->FindElementValueAsNumberConvertTo("length", "IN");
 119     if (element_Grain->FindElement("bore_diameter"))
 120       InnerRadius = element_Grain->FindElementValueAsNumberConvertTo("bore_diameter", "IN")/2.0;
 121
 122     // Initialize solid propellant values for debug and runtime use.
 123
 124     switch (grainType) {
 125       case gtCYLINDRICAL:
 126         if (Radius <= InnerRadius) {
 127           cerr << "The bore diameter should be smaller than the total grain diameter!" << endl;
 128           exit(-1);
 129         }
 130         Volume = M_PI * Length * (Radius*Radius - InnerRadius*InnerRadius); // cubic inches
 131         break;
 132       case gtENDBURNING:
 133         Volume = M_PI * Length * Radius * Radius; // cubic inches
 134         break;
 135       case gtUNKNOWN:
 136         cerr << "Unknown grain type found in this rocket engine definition." << endl;
 137         exit(-1);
 138     }
 139     Density = (Contents*lbtoslug)/Volume; // slugs/in^3
 140
 141   }
 142
 143   char property_name[80];
 144   snprintf(property_name, 80, "propulsion/tank[%d]/contents-lbs", TankNumber);
 145   PropertyManager->Tie( property_name, (FGTank*)this, &FGTank::GetContents,
 146                                        &FGTank::SetContents );
 147
 148   if (Temperature != -9999.0)  InitialTemperature = Temperature = FahrenheitToCelsius(Temperature);
 149   Area = 40.0 * pow(Capacity/1975, 0.666666667);
 150
 151   Debug(0);
 152 }
 153
 154 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 155
 156 FGTank::~FGTank()
 157 {
 158   Debug(1);
 159 }
 160
 161 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 162
 163 void FGTank::ResetToIC(void)
 164 {
 165   Temperature = InitialTemperature;
 166   Standpipe = InitialStandpipe;
 167   Contents = InitialContents;
 168   PctFull = 100.0*Contents/Capacity;
 169   Selected = true;
 170 }
 171
 172 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 173
 174 const FGColumnVector3 FGTank::GetXYZ(void)
 175 {
 176   return vXYZ_drain + (Contents/Capacity)*(vXYZ - vXYZ_drain);
 177 }
 178
 179 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 180
 181 const double FGTank::GetXYZ(int idx)
 182 {
 183   return vXYZ_drain(idx) + (Contents/Capacity)*(vXYZ(idx)-vXYZ_drain(idx));
 184 }
 185
 186 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 187
 188 double FGTank::Drain(double used)
 189 {
 190   double remaining = Contents - used;
 191
 192   if (remaining >= 0) { // Reduce contents by amount used.
 193
 194     Contents -= used;
 195     PctFull = 100.0*Contents/Capacity;
 196
 197   } else { // This tank must be empty.
 198
 199     Contents = 0.0;
 200     PctFull = 0.0;
 201     Selected = false;
 202   }
 203
 204   if (grainType != gtUNKNOWN) CalculateInertias();
 205
 206   return remaining;
 207 }
 208
 209 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 210
 211 double FGTank::Fill(double amount)
 212 {
 213   double overage = 0.0;
 214
 215   Contents += amount;
 216
 217   if (Contents > Capacity) {
 218     overage = Contents - Capacity;
 219     Contents = Capacity;
 220     PctFull = 100.0;
 221   } else {
 222     PctFull = Contents/Capacity*100.0;
 223   }
 224   return overage;
 225 }
 226
 227 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 228
 229 void FGTank::SetContents(double amount)
 230 {
 231   Contents = amount;
 232   if (Contents > Capacity) {
 233     Contents = Capacity;
 234     PctFull = 100.0;
 235   } else {
 236     PctFull = Contents/Capacity*100.0;
 237   }
 238 }
 239
 240 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 241
 242 double FGTank::Calculate(double dt)
 243 {
 244   if (Temperature == -9999.0) return 0.0;
 245   double HeatCapacity = 900.0;        // Joules/lbm/C
 246   double TempFlowFactor = 1.115;      // Watts/sqft/C
 247   double TAT = Auxiliary->GetTAT_C();
 248   double Tdiff = TAT - Temperature;
 249   double dTemp = 0.0;                 // Temp change due to one surface
 250   if (fabs(Tdiff) > 0.1) {
 251     dTemp = (TempFlowFactor * Area * Tdiff * dt) / (Contents * HeatCapacity);
 252   }
 253   return Temperature += (dTemp + dTemp);    // For now, assume upper/lower the same
 254 }
 255
 256 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 257 //  This function calculates the moments of inertia for a solid propellant
 258 //  grain - either an end burning cylindrical grain or a bored cylindrical
 259 //  grain.
 260
 261 void FGTank::CalculateInertias(void)
 262 {
 263   double Mass = Contents*lbtoslug;
 264   double RadSumSqr;
 265   double Rad2 = Radius*Radius;
 266   Volume = (Contents*lbtoslug)/Density; // in^3
 267
 268   switch (grainType) {
 269     case gtCYLINDRICAL:
 270       InnerRadius = sqrt(Rad2 - Volume/(M_PI * Length));
 271       RadSumSqr = (Rad2 + InnerRadius*InnerRadius)/144.0;
 272       Ixx = 0.5*Mass*RadSumSqr;
 273       Iyy = Mass*(3.0*RadSumSqr + Length*Length/144.0)/12.0;
 274       break;
 275     case gtENDBURNING:
 276       Length = Volume/(M_PI*Rad2);
 277       Ixx = 0.5*Mass*Rad2/144.0;
 278       Iyy = Mass*(3.0*Rad2 + Length*Length)/(144.0*12.0);
 279       break;
 280   }
 281   Izz  = Iyy;
 282
 283 }
 284
 285 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 286 //    The bitmasked value choices are as follows:
 287 //    unset: In this case (the default) JSBSim would only print
 288 //       out the normally expected messages, essentially echoing
 289 //       the config files as they are read. If the environment
 290 //       variable is not set, debug_lvl is set to 1 internally
 291 //    0: This requests JSBSim not to output any messages
 292 //       whatsoever.
 293 //    1: This value explicity requests the normal JSBSim
 294 //       startup messages
 295 //    2: This value asks for a message to be printed out when
 296 //       a class is instantiated
 297 //    4: When this value is set, a message is displayed when a
 298 //       FGModel object executes its Run() method
 299 //    8: When this value is set, various runtime state variables
 300 //       are printed out periodically
 301 //    16: When set various parameters are sanity checked and
 302 //       a message is printed out when they go out of bounds
 303
 304 void FGTank::Debug(int from)
 305 {
 306   if (debug_lvl <= 0) return;
 307
 308   if (debug_lvl & 1) { // Standard console startup message output
 309     if (from == 0) { // Constructor
 310       cout << "      " << type << " tank holds " << Capacity << " lbs. " << type << endl;
 311       cout << "      currently at " << PctFull << "% of maximum capacity" << endl;
 312       cout << "      Tank location (X, Y, Z): " << vXYZ(eX) << ", " << vXYZ(eY) << ", " << vXYZ(eZ) << endl;
 313       cout << "      Effective radius: " << Radius << " inches" << endl;
 314       cout << "      Initial temperature: " << Temperature << " Fahrenheit" << endl;
 315     }
 316   }
 317   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 318     if (from == 0) cout << "Instantiated: FGTank" << endl;
 319     if (from == 1) cout << "Destroyed:    FGTank" << endl;
 320   }
 321   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 322   }
 323   if (debug_lvl & 8 ) { // Runtime state variables
 324   }
 325   if (debug_lvl & 16) { // Sanity checking
 326   }
 327   if (debug_lvl & 64) {
 328     if (from == 0) { // Constructor
 329       cout << IdSrc << endl;
 330       cout << IdHdr << endl;
 331     }
 332   }
 333 }
 334 }