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