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