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 (jon@jsbsim.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 #include "FGFDMExec.h"
  41 #include "models/FGAuxiliary.h"
  42 #include "input_output/FGXMLElement.h"
  43 #include "input_output/FGPropertyManager.h"
  44 #include <iostream>
  45 #include <cstdlib>
  46
  47 using namespace std;
  48
  49 namespace JSBSim {
  50
  51 static const char *IdSrc = "$Id: FGTank.cpp,v 1.28 2010/01/24 19:26:04 jberndt Exp $";
  52 static const char *IdHdr = ID_TANK;
  53
  54 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  55 CLASS IMPLEMENTATION
  56 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  57
  58 FGTank::FGTank(FGFDMExec* exec, Element* el, int tank_number)
  59                   : TankNumber(tank_number), Exec(exec)
  60 {
  61   string token, strFuelName;
  62   Element* element;
  63   Element* element_Grain;
  64   Area = 1.0;
  65   Density = 6.6;
  66   InitialTemperature = Temperature = -9999.0;
  67   Ixx = Iyy = Izz = 0.0;
  68   Radius = Contents = Standpipe = Length = InnerRadius = 0.0;
  69   InitialStandpipe = 0.0;
  70   Capacity = 0.00001;
  71   Priority = InitialPriority = 1;
  72   PropertyManager = Exec->GetPropertyManager();
  73   vXYZ.InitMatrix();
  74   vXYZ_drain.InitMatrix();
  75
  76   type = el->GetAttributeValue("type");
  77   if      (type == "FUEL")     Type = ttFUEL;
  78   else if (type == "OXIDIZER") Type = ttOXIDIZER;
  79   else                         Type = ttUNKNOWN;
  80
  81   element = el->FindElement("location");
  82   if (element)  vXYZ = element->FindElementTripletConvertTo("IN");
  83   else          cerr << "No location found for this tank." << endl;
  84
  85   vXYZ_drain = vXYZ; // Set initial drain location to initial tank CG
  86
  87   element = el->FindElement("drain_location");
  88   if (element)  {
  89     vXYZ_drain = element->FindElementTripletConvertTo("IN");
  90   }
  91
  92   if (el->FindElement("radius"))
  93     Radius = el->FindElementValueAsNumberConvertTo("radius", "IN");
  94   if (el->FindElement("capacity"))
  95     Capacity = el->FindElementValueAsNumberConvertTo("capacity", "LBS");
  96   if (el->FindElement("contents"))
  97     InitialContents = Contents = el->FindElementValueAsNumberConvertTo("contents", "LBS");
  98   if (el->FindElement("temperature"))
  99     InitialTemperature = Temperature = el->FindElementValueAsNumber("temperature");
 100   if (el->FindElement("standpipe"))
 101     InitialStandpipe = Standpipe = el->FindElementValueAsNumberConvertTo("standpipe", "LBS");
 102   if (el->FindElement("priority"))
 103     InitialPriority = Priority = el->FindElementValueAsNumber("priority");
 104   if (el->FindElement("density"))
 105     Density = el->FindElementValueAsNumberConvertTo("density", "LBS/GAL");
 106   if (el->FindElement("type"))
 107     strFuelName = el->FindElementValue("type");
 108
 109
 110   SetPriority( InitialPriority );     // this will also set the Selected flag
 111
 112   if (Capacity == 0) {
 113     cerr << "Tank capacity must not be zero. Reset to 0.00001 lbs!" << endl;
 114     Capacity = 0.00001;
 115     Contents = 0.0;
 116   }
 117   PctFull = 100.0*Contents/Capacity;            // percent full; 0 to 100.0
 118
 119   // Check whether this is a solid propellant "tank". Initialize it if true.
 120
 121   grainType = gtUNKNOWN; // This is the default
 122
 123   element_Grain = el->FindElement("grain_config");
 124   if (element_Grain) {
 125
 126     strGType = element_Grain->GetAttributeValue("type");
 127     if (strGType == "CYLINDRICAL")     grainType = gtCYLINDRICAL;
 128     else if (strGType == "ENDBURNING") grainType = gtENDBURNING;
 129     else                               cerr << "Unknown propellant grain type specified" << endl;
 130
 131     if (element_Grain->FindElement("length"))
 132       Length = element_Grain->FindElementValueAsNumberConvertTo("length", "IN");
 133     if (element_Grain->FindElement("bore_diameter"))
 134       InnerRadius = element_Grain->FindElementValueAsNumberConvertTo("bore_diameter", "IN")/2.0;
 135
 136     // Initialize solid propellant values for debug and runtime use.
 137
 138     switch (grainType) {
 139       case gtCYLINDRICAL:
 140         if (Radius <= InnerRadius) {
 141           cerr << "The bore diameter should be smaller than the total grain diameter!" << endl;
 142           exit(-1);
 143         }
 144         Volume = M_PI * Length * (Radius*Radius - InnerRadius*InnerRadius); // cubic inches
 145         break;
 146       case gtENDBURNING:
 147         Volume = M_PI * Length * Radius * Radius; // cubic inches
 148         break;
 149       case gtUNKNOWN:
 150         cerr << "Unknown grain type found in this rocket engine definition." << endl;
 151         exit(-1);
 152     }
 153     Density = (Contents*lbtoslug)/Volume; // slugs/in^3
 154     CalculateInertias();
 155   }
 156
 157   string property_name, base_property_name;
 158   base_property_name = CreateIndexedPropertyName("propulsion/tank", TankNumber);
 159   property_name = base_property_name + "/contents-lbs";
 160   PropertyManager->Tie( property_name.c_str(), (FGTank*)this, &FGTank::GetContents,
 161                                        &FGTank::SetContents );
 162   property_name = base_property_name + "/priority";
 163   PropertyManager->Tie( property_name.c_str(), (FGTank*)this, &FGTank::GetPriority,
 164                                        &FGTank::SetPriority );
 165
 166   if (Temperature != -9999.0)  InitialTemperature = Temperature = FahrenheitToCelsius(Temperature);
 167   Area = 40.0 * pow(Capacity/1975, 0.666666667);
 168
 169   // A named fuel type will override a previous density value
 170   if (!strFuelName.empty()) Density = ProcessFuelName(strFuelName);
 171
 172   Debug(0);
 173 }
 174
 175 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 176
 177 FGTank::~FGTank()
 178 {
 179   Debug(1);
 180 }
 181
 182 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 183
 184 void FGTank::ResetToIC(void)
 185 {
 186   SetTemperature( InitialTemperature );
 187   SetStandpipe ( InitialStandpipe );
 188   SetContents ( InitialContents );
 189   PctFull = 100.0*Contents/Capacity;
 190   SetPriority( InitialPriority );
 191 }
 192
 193 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 194
 195 const FGColumnVector3 FGTank::GetXYZ(void)
 196 {
 197   return vXYZ_drain + (Contents/Capacity)*(vXYZ - vXYZ_drain);
 198 }
 199
 200 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 201
 202 const double FGTank::GetXYZ(int idx)
 203 {
 204   return vXYZ_drain(idx) + (Contents/Capacity)*(vXYZ(idx)-vXYZ_drain(idx));
 205 }
 206
 207 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 208
 209 double FGTank::Drain(double used)
 210 {
 211   double remaining = Contents - used;
 212
 213   if (remaining >= 0) { // Reduce contents by amount used.
 214
 215     Contents -= used;
 216     PctFull = 100.0*Contents/Capacity;
 217
 218   } else { // This tank must be empty.
 219
 220     Contents = 0.0;
 221     PctFull = 0.0;
 222   }
 223
 224   if (grainType != gtUNKNOWN) CalculateInertias();
 225
 226   return remaining;
 227 }
 228
 229 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 230
 231 double FGTank::Fill(double amount)
 232 {
 233   double overage = 0.0;
 234
 235   Contents += amount;
 236
 237   if (Contents > Capacity) {
 238     overage = Contents - Capacity;
 239     Contents = Capacity;
 240     PctFull = 100.0;
 241   } else {
 242     PctFull = Contents/Capacity*100.0;
 243   }
 244   return overage;
 245 }
 246
 247 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 248
 249 void FGTank::SetContents(double amount)
 250 {
 251   Contents = amount;
 252   if (Contents > Capacity) {
 253     Contents = Capacity;
 254     PctFull = 100.0;
 255   } else {
 256     PctFull = Contents/Capacity*100.0;
 257   }
 258 }
 259
 260 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 261
 262 void FGTank::SetContentsGallons(double gallons)
 263 {
 264   SetContents(gallons * Density);
 265 }
 266
 267
 268 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 269
 270 double FGTank::Calculate(double dt)
 271 {
 272   if (Temperature == -9999.0) return 0.0;
 273   double HeatCapacity = 900.0;        // Joules/lbm/C
 274   double TempFlowFactor = 1.115;      // Watts/sqft/C
 275   double TAT = Exec->GetAuxiliary()->GetTAT_C();
 276   double Tdiff = TAT - Temperature;
 277   double dTemp = 0.0;                 // Temp change due to one surface
 278   if (fabs(Tdiff) > 0.1) {
 279     dTemp = (TempFlowFactor * Area * Tdiff * dt) / (Contents * HeatCapacity);
 280   }
 281   return Temperature += (dTemp + dTemp);    // For now, assume upper/lower the same
 282 }
 283
 284 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 285 //  This function calculates the moments of inertia for a solid propellant
 286 //  grain - either an end burning cylindrical grain or a bored cylindrical
 287 //  grain.
 288
 289 void FGTank::CalculateInertias(void)
 290 {
 291   double Mass = Contents*lbtoslug;
 292   double RadSumSqr;
 293   double Rad2 = Radius*Radius;
 294
 295   if (Density > 0.0) {
 296     Volume = (Contents*lbtoslug)/Density; // in^3
 297   } else {
 298     cerr << endl << "  Solid propellant grain density is zero!" << endl << endl;
 299     exit(-1);
 300   }
 301
 302   switch (grainType) {
 303     case gtCYLINDRICAL:
 304       InnerRadius = sqrt(Rad2 - Volume/(M_PI * Length));
 305       RadSumSqr = (Rad2 + InnerRadius*InnerRadius)/144.0;
 306       Ixx = 0.5*Mass*RadSumSqr;
 307       Iyy = Mass*(3.0*RadSumSqr + Length*Length/144.0)/12.0;
 308       break;
 309     case gtENDBURNING:
 310       Length = Volume/(M_PI*Rad2);
 311       Ixx = 0.5*Mass*Rad2/144.0;
 312       Iyy = Mass*(3.0*Rad2 + Length*Length)/(144.0*12.0);
 313       break;
 314     case gtUNKNOWN:
 315       cerr << "Unknown grain type found." << endl;
 316       exit(-1);
 317       break;
 318   }
 319   Izz  = Iyy;
 320
 321 }
 322
 323 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 324
 325 double FGTank::ProcessFuelName(std::string const& name)
 326 {
 327    if      (name == "AVGAS")    return 6.02;
 328    else if (name == "JET-A")    return 6.74;
 329    else if (name == "JET-A1")   return 6.74;
 330    else if (name == "JET-B")    return 6.48;
 331    else if (name == "JP-1")     return 6.76;
 332    else if (name == "JP-2")     return 6.38;
 333    else if (name == "JP-3")     return 6.34;
 334    else if (name == "JP-4")     return 6.48;
 335    else if (name == "JP-5")     return 6.81;
 336    else if (name == "JP-6")     return 6.55;
 337    else if (name == "JP-7")     return 6.61;
 338    else if (name == "JP-8")     return 6.66;
 339    else if (name == "JP-8+100") return 6.66;
 340  //else if (name == "JP-9")     return 6.74;
 341  //else if (name == "JPTS")     return 6.74;
 342    else if (name == "RP-1")     return 6.73;
 343    else if (name == "T-1")      return 6.88;
 344    else if (name == "ETHANOL")  return 6.58;
 345    else if (name == "HYDRAZINE")return 8.61;
 346    else if (name == "F-34")     return 6.66;
 347    else if (name == "F-35")     return 6.74;
 348    else if (name == "F-40")     return 6.48;
 349    else if (name == "F-44")     return 6.81;
 350    else if (name == "AVTAG")    return 6.48;
 351    else if (name == "AVCAT")    return 6.81;
 352    else {
 353      cerr << "Unknown fuel type specified: "<< name << endl;
 354    }
 355
 356    return 6.6;
 357 }
 358
 359
 360 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 361 //    The bitmasked value choices are as follows:
 362 //    unset: In this case (the default) JSBSim would only print
 363 //       out the normally expected messages, essentially echoing
 364 //       the config files as they are read. If the environment
 365 //       variable is not set, debug_lvl is set to 1 internally
 366 //    0: This requests JSBSim not to output any messages
 367 //       whatsoever.
 368 //    1: This value explicity requests the normal JSBSim
 369 //       startup messages
 370 //    2: This value asks for a message to be printed out when
 371 //       a class is instantiated
 372 //    4: When this value is set, a message is displayed when a
 373 //       FGModel object executes its Run() method
 374 //    8: When this value is set, various runtime state variables
 375 //       are printed out periodically
 376 //    16: When set various parameters are sanity checked and
 377 //       a message is printed out when they go out of bounds
 378
 379 void FGTank::Debug(int from)
 380 {
 381   if (debug_lvl <= 0) return;
 382
 383   if (debug_lvl & 1) { // Standard console startup message output
 384     if (from == 0) { // Constructor
 385       cout << "      " << type << " tank holds " << Capacity << " lbs. " << type << endl;
 386       cout << "      currently at " << PctFull << "% of maximum capacity" << endl;
 387       cout << "      Tank location (X, Y, Z): " << vXYZ(eX) << ", " << vXYZ(eY) << ", " << vXYZ(eZ) << endl;
 388       cout << "      Effective radius: " << Radius << " inches" << endl;
 389       cout << "      Initial temperature: " << Temperature << " Fahrenheit" << endl;
 390       cout << "      Priority: " << Priority << endl;
 391     }
 392   }
 393   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 394     if (from == 0) cout << "Instantiated: FGTank" << endl;
 395     if (from == 1) cout << "Destroyed:    FGTank" << endl;
 396   }
 397   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 398   }
 399   if (debug_lvl & 8 ) { // Runtime state variables
 400   }
 401   if (debug_lvl & 16) { // Sanity checking
 402   }
 403   if (debug_lvl & 64) {
 404     if (from == 0) { // Constructor
 405       cout << IdSrc << endl;
 406       cout << IdHdr << endl;
 407     }
 408   }
 409 }
 410 }