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 #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   Temperature = -9999.0;
  63   Ixx = Iyy = Izz = 0.0;
  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     CalculateInertias();
 141   }
 142
 143   string property_name, base_property_name;
 144   base_property_name = CreateIndexedPropertyName("propulsion/tank", TankNumber);
 145   property_name = base_property_name + "/contents-lbs";
 146   PropertyManager->Tie( property_name.c_str(), (FGTank*)this, &FGTank::GetContents,
 147                                        &FGTank::SetContents );
 148
 149   if (Temperature != -9999.0)  InitialTemperature = Temperature = FahrenheitToCelsius(Temperature);
 150   Area = 40.0 * pow(Capacity/1975, 0.666666667);
 151
 152   Debug(0);
 153 }
 154
 155 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 156
 157 FGTank::~FGTank()
 158 {
 159   Debug(1);
 160 }
 161
 162 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 163
 164 void FGTank::ResetToIC(void)
 165 {
 166   Temperature = InitialTemperature;
 167   Standpipe = InitialStandpipe;
 168   Contents = InitialContents;
 169   PctFull = 100.0*Contents/Capacity;
 170   Selected = true;
 171 }
 172
 173 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 174
 175 const FGColumnVector3 FGTank::GetXYZ(void)
 176 {
 177   return vXYZ_drain + (Contents/Capacity)*(vXYZ - vXYZ_drain);
 178 }
 179
 180 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 181
 182 const double FGTank::GetXYZ(int idx)
 183 {
 184   return vXYZ_drain(idx) + (Contents/Capacity)*(vXYZ(idx)-vXYZ_drain(idx));
 185 }
 186
 187 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 188
 189 double FGTank::Drain(double used)
 190 {
 191   double remaining = Contents - used;
 192
 193   if (remaining >= 0) { // Reduce contents by amount used.
 194
 195     Contents -= used;
 196     PctFull = 100.0*Contents/Capacity;
 197
 198   } else { // This tank must be empty.
 199
 200     Contents = 0.0;
 201     PctFull = 0.0;
 202     Selected = false;
 203   }
 204
 205   if (grainType != gtUNKNOWN) CalculateInertias();
 206
 207   return remaining;
 208 }
 209
 210 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 211
 212 double FGTank::Fill(double amount)
 213 {
 214   double overage = 0.0;
 215
 216   Contents += amount;
 217
 218   if (Contents > Capacity) {
 219     overage = Contents - Capacity;
 220     Contents = Capacity;
 221     PctFull = 100.0;
 222   } else {
 223     PctFull = Contents/Capacity*100.0;
 224   }
 225   return overage;
 226 }
 227
 228 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 229
 230 void FGTank::SetContents(double amount)
 231 {
 232   Contents = amount;
 233   if (Contents > Capacity) {
 234     Contents = Capacity;
 235     PctFull = 100.0;
 236   } else {
 237     PctFull = Contents/Capacity*100.0;
 238   }
 239 }
 240
 241 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 242
 243 double FGTank::Calculate(double dt)
 244 {
 245   if (Temperature == -9999.0) return 0.0;
 246   double HeatCapacity = 900.0;        // Joules/lbm/C
 247   double TempFlowFactor = 1.115;      // Watts/sqft/C
 248   double TAT = Exec->GetAuxiliary()->GetTAT_C();
 249   double Tdiff = TAT - Temperature;
 250   double dTemp = 0.0;                 // Temp change due to one surface
 251   if (fabs(Tdiff) > 0.1) {
 252     dTemp = (TempFlowFactor * Area * Tdiff * dt) / (Contents * HeatCapacity);
 253   }
 254   return Temperature += (dTemp + dTemp);    // For now, assume upper/lower the same
 255 }
 256
 257 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 258 //  This function calculates the moments of inertia for a solid propellant
 259 //  grain - either an end burning cylindrical grain or a bored cylindrical
 260 //  grain.
 261
 262 void FGTank::CalculateInertias(void)
 263 {
 264   double Mass = Contents*lbtoslug;
 265   double RadSumSqr;
 266   double Rad2 = Radius*Radius;
 267
 268   if (Density > 0.0) {
 269     Volume = (Contents*lbtoslug)/Density; // in^3
 270   } else {
 271     cerr << endl << "  Solid propellant grain density is zero!" << endl << endl;
 272     exit(-1);
 273   }
 274
 275   switch (grainType) {
 276     case gtCYLINDRICAL:
 277       InnerRadius = sqrt(Rad2 - Volume/(M_PI * Length));
 278       RadSumSqr = (Rad2 + InnerRadius*InnerRadius)/144.0;
 279       Ixx = 0.5*Mass*RadSumSqr;
 280       Iyy = Mass*(3.0*RadSumSqr + Length*Length/144.0)/12.0;
 281       break;
 282     case gtENDBURNING:
 283       Length = Volume/(M_PI*Rad2);
 284       Ixx = 0.5*Mass*Rad2/144.0;
 285       Iyy = Mass*(3.0*Rad2 + Length*Length)/(144.0*12.0);
 286       break;
 287   }
 288   Izz  = Iyy;
 289
 290 }
 291
 292 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 293 //    The bitmasked value choices are as follows:
 294 //    unset: In this case (the default) JSBSim would only print
 295 //       out the normally expected messages, essentially echoing
 296 //       the config files as they are read. If the environment
 297 //       variable is not set, debug_lvl is set to 1 internally
 298 //    0: This requests JSBSim not to output any messages
 299 //       whatsoever.
 300 //    1: This value explicity requests the normal JSBSim
 301 //       startup messages
 302 //    2: This value asks for a message to be printed out when
 303 //       a class is instantiated
 304 //    4: When this value is set, a message is displayed when a
 305 //       FGModel object executes its Run() method
 306 //    8: When this value is set, various runtime state variables
 307 //       are printed out periodically
 308 //    16: When set various parameters are sanity checked and
 309 //       a message is printed out when they go out of bounds
 310
 311 void FGTank::Debug(int from)
 312 {
 313   if (debug_lvl <= 0) return;
 314
 315   if (debug_lvl & 1) { // Standard console startup message output
 316     if (from == 0) { // Constructor
 317       cout << "      " << type << " tank holds " << Capacity << " lbs. " << type << endl;
 318       cout << "      currently at " << PctFull << "% of maximum capacity" << endl;
 319       cout << "      Tank location (X, Y, Z): " << vXYZ(eX) << ", " << vXYZ(eY) << ", " << vXYZ(eZ) << endl;
 320       cout << "      Effective radius: " << Radius << " inches" << endl;
 321       cout << "      Initial temperature: " << Temperature << " Fahrenheit" << endl;
 322     }
 323   }
 324   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 325     if (from == 0) cout << "Instantiated: FGTank" << endl;
 326     if (from == 1) cout << "Destroyed:    FGTank" << endl;
 327   }
 328   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 329   }
 330   if (debug_lvl & 8 ) { // Runtime state variables
 331   }
 332   if (debug_lvl & 16) { // Sanity checking
 333   }
 334   if (debug_lvl & 64) {
 335     if (from == 0) { // Constructor
 336       cout << IdSrc << endl;
 337       cout << IdHdr << endl;
 338     }
 339   }
 340 }
 341 }