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
  41 #if !defined ( sgi ) || defined( __GNUC__ ) && (_COMPILER_VERSION < 740)
  42 using std::cerr;
  43 using std::endl;
  44 using std::cout;
  45 #endif
  46
  47 namespace JSBSim {
  48
  49 static const char *IdSrc = "$Id$";
  50 static const char *IdHdr = ID_TANK;
  51
  52 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  53 CLASS IMPLEMENTATION
  54 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  55
  56 FGTank::FGTank(FGFDMExec* exec, Element* el, int tank_number)
  57                   : TankNumber(tank_number)
  58 {
  59   string token;
  60   Element* element;
  61   Area = 1.0;
  62   Temperature = -9999.0;
  63   Auxiliary = exec->GetAuxiliary();
  64   Radius = Capacity = Contents = Standpipe = 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   char property_name[80];
 106   snprintf(property_name, 80, "propulsion/tank[%d]/contents-lbs", TankNumber);
 107   PropertyManager->Tie( property_name, (FGTank*)this, &FGTank::GetContents,
 108                                        &FGTank::SetContents );
 109
 110   if (Temperature != -9999.0)  InitialTemperature = Temperature = FahrenheitToCelsius(Temperature);
 111   Area = 40.0 * pow(Capacity/1975, 0.666666667);
 112
 113   Debug(0);
 114 }
 115
 116 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 117
 118 FGTank::~FGTank()
 119 {
 120   Debug(1);
 121 }
 122
 123 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 124
 125 void FGTank::ResetToIC(void)
 126 {
 127   Temperature = InitialTemperature;
 128   Standpipe = InitialStandpipe;
 129   Contents = InitialContents;
 130   PctFull = 100.0*Contents/Capacity;
 131   Selected = true;
 132 }
 133
 134 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 135
 136 const FGColumnVector3 FGTank::GetXYZ(void)
 137 {
 138   return vXYZ_drain + (Contents/Capacity)*(vXYZ - vXYZ_drain);
 139 }
 140
 141 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 142
 143 const double FGTank::GetXYZ(int idx)
 144 {
 145   return vXYZ_drain(idx) + (Contents/Capacity)*(vXYZ(idx)-vXYZ_drain(idx));
 146 }
 147
 148 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 149
 150 double FGTank::Drain(double used)
 151 {
 152   double remaining = Contents - used;
 153
 154   if (remaining >= 0) { // Reduce contents by amount used.
 155
 156     Contents -= used;
 157     PctFull = 100.0*Contents/Capacity;
 158
 159   } else { // This tank must be empty.
 160
 161     Contents = 0.0;
 162     PctFull = 0.0;
 163     Selected = false;
 164   }
 165   return remaining;
 166 }
 167
 168 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 169
 170 double FGTank::Fill(double amount)
 171 {
 172   double overage = 0.0;
 173
 174   Contents += amount;
 175
 176   if (Contents > Capacity) {
 177     overage = Contents - Capacity;
 178     Contents = Capacity;
 179     PctFull = 100.0;
 180   } else {
 181     PctFull = Contents/Capacity*100.0;
 182   }
 183   return overage;
 184 }
 185
 186 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 187
 188 void FGTank::SetContents(double amount)
 189 {
 190   Contents = amount;
 191   if (Contents > Capacity) {
 192     Contents = Capacity;
 193     PctFull = 100.0;
 194   } else {
 195     PctFull = Contents/Capacity*100.0;
 196   }
 197 }
 198
 199 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 200
 201 double FGTank::Calculate(double dt)
 202 {
 203   if (Temperature == -9999.0) return 0.0;
 204   double HeatCapacity = 900.0;        // Joules/lbm/C
 205   double TempFlowFactor = 1.115;      // Watts/sqft/C
 206   double TAT = Auxiliary->GetTAT_C();
 207   double Tdiff = TAT - Temperature;
 208   double dTemp = 0.0;                 // Temp change due to one surface
 209   if (fabs(Tdiff) > 0.1) {
 210     dTemp = (TempFlowFactor * Area * Tdiff * dt) / (Contents * HeatCapacity);
 211   }
 212   return Temperature += (dTemp + dTemp);    // For now, assume upper/lower the same
 213 }
 214
 215 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 216 //    The bitmasked value choices are as follows:
 217 //    unset: In this case (the default) JSBSim would only print
 218 //       out the normally expected messages, essentially echoing
 219 //       the config files as they are read. If the environment
 220 //       variable is not set, debug_lvl is set to 1 internally
 221 //    0: This requests JSBSim not to output any messages
 222 //       whatsoever.
 223 //    1: This value explicity requests the normal JSBSim
 224 //       startup messages
 225 //    2: This value asks for a message to be printed out when
 226 //       a class is instantiated
 227 //    4: When this value is set, a message is displayed when a
 228 //       FGModel object executes its Run() method
 229 //    8: When this value is set, various runtime state variables
 230 //       are printed out periodically
 231 //    16: When set various parameters are sanity checked and
 232 //       a message is printed out when they go out of bounds
 233
 234 void FGTank::Debug(int from)
 235 {
 236   if (debug_lvl <= 0) return;
 237
 238   if (debug_lvl & 1) { // Standard console startup message output
 239     if (from == 0) { // Constructor
 240       cout << "      " << type << " tank holds " << Capacity << " lbs. " << type << endl;
 241       cout << "      currently at " << PctFull << "% of maximum capacity" << endl;
 242       cout << "      Tank location (X, Y, Z): " << vXYZ(eX) << ", " << vXYZ(eY) << ", " << vXYZ(eZ) << endl;
 243       cout << "      Effective radius: " << Radius << " inches" << endl;
 244       cout << "      Initial temperature: " << Temperature << " Fahrenheit" << endl;
 245     }
 246   }
 247   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 248     if (from == 0) cout << "Instantiated: FGTank" << endl;
 249     if (from == 1) cout << "Destroyed:    FGTank" << endl;
 250   }
 251   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 252   }
 253   if (debug_lvl & 8 ) { // Runtime state variables
 254   }
 255   if (debug_lvl & 16) { // Sanity checking
 256   }
 257   if (debug_lvl & 64) {
 258     if (from == 0) { // Constructor
 259       cout << IdSrc << endl;
 260       cout << IdHdr << endl;
 261     }
 262   }
 263 }
 264 }