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