src/FDM/JSBSim/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 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 General Public License for more
  18  details.
  19
  20  You should have received a copy of the GNU 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 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(FGConfigFile* AC_cfg, FGFDMExec* exec)
  57 {
  58   string token;
  59   double X, Y, Z;
  60   Area = 1.0;
  61   Temperature = -9999.0;
  62   Auxiliary = exec->GetAuxiliary();
  63
  64   type = AC_cfg->GetValue("TYPE");
  65
  66   if      (type == "FUEL")     Type = ttFUEL;
  67   else if (type == "OXIDIZER") Type = ttOXIDIZER;
  68   else                         Type = ttUNKNOWN;
  69
  70   AC_cfg->GetNextConfigLine();
  71   while ((token = AC_cfg->GetValue()) != string("/AC_TANK")) {
  72     if (token == "XLOC") *AC_cfg >> X;
  73     else if (token == "YLOC") *AC_cfg >> Y;
  74     else if (token == "ZLOC") *AC_cfg >> Z;
  75     else if (token == "RADIUS") *AC_cfg >> Radius;
  76     else if (token == "CAPACITY") *AC_cfg >> Capacity;
  77     else if (token == "CONTENTS") *AC_cfg >> Contents;
  78     else if (token == "TEMPERATURE") *AC_cfg >> Temperature;
  79     else cerr << "Unknown identifier: " << token << " in tank definition." << endl;
  80   }
  81
  82   vXYZ << X << Y << Z;
  83
  84   Selected = true;
  85
  86   if (Capacity != 0) {
  87     PctFull = 100.0*Contents/Capacity;            // percent full; 0 to 100.0
  88   } else {
  89     Contents = 0;
  90     PctFull  = 0;
  91   }
  92
  93   if (Temperature != -9999.0)  Temperature = FahrenheitToCelsius(Temperature);
  94   Area = 40.0 * pow(Capacity/1975, 0.666666667);
  95
  96   Debug(0);
  97 }
  98
  99 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 100
 101 FGTank::~FGTank()
 102 {
 103   Debug(1);
 104 }
 105
 106 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 107
 108 double FGTank::Drain(double used)
 109 {
 110   double shortage = Contents - used;
 111
 112   if (shortage >= 0) {
 113     Contents -= used;
 114     PctFull = 100.0*Contents/Capacity;
 115   } else {
 116     Contents = 0.0;
 117     PctFull = 0.0;
 118     Selected = false;
 119   }
 120   return shortage;
 121 }
 122
 123 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 124
 125 double FGTank::Fill(double amount)
 126 {
 127   double overage = 0.0;
 128
 129   Contents += amount;
 130
 131   if (Contents > Capacity) {
 132     overage = Contents - Capacity;
 133     Contents = Capacity;
 134     PctFull = 100.0;
 135   } else {
 136     PctFull = Contents/Capacity*100.0;
 137   }
 138   return overage;
 139 }
 140
 141 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 142
 143 void FGTank::SetContents(double amount)
 144 {
 145   Contents = amount;
 146   if (Contents > Capacity) {
 147     Contents = Capacity;
 148     PctFull = 100.0;
 149   } else {
 150     PctFull = Contents/Capacity*100.0;
 151   }
 152 }
 153
 154 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 155
 156 double FGTank::Calculate(double dt)
 157 {
 158   if (Temperature == -9999.0) return 0.0;
 159   double HeatCapacity = 900.0;        // Joules/lbm/C
 160   double TempFlowFactor = 1.115;      // Watts/sqft/C
 161   double TAT = Auxiliary->GetTAT_C();
 162   double Tdiff = TAT - Temperature;
 163   double dT = 0.0;                    // Temp change due to one surface
 164   if (fabs(Tdiff) > 0.1) {
 165     dT = (TempFlowFactor * Area * Tdiff * dt) / (Contents * HeatCapacity);
 166   }
 167   return Temperature += (dT + dT);    // For now, assume upper/lower the same
 168 }
 169
 170 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 171 //    The bitmasked value choices are as follows:
 172 //    unset: In this case (the default) JSBSim would only print
 173 //       out the normally expected messages, essentially echoing
 174 //       the config files as they are read. If the environment
 175 //       variable is not set, debug_lvl is set to 1 internally
 176 //    0: This requests JSBSim not to output any messages
 177 //       whatsoever.
 178 //    1: This value explicity requests the normal JSBSim
 179 //       startup messages
 180 //    2: This value asks for a message to be printed out when
 181 //       a class is instantiated
 182 //    4: When this value is set, a message is displayed when a
 183 //       FGModel object executes its Run() method
 184 //    8: When this value is set, various runtime state variables
 185 //       are printed out periodically
 186 //    16: When set various parameters are sanity checked and
 187 //       a message is printed out when they go out of bounds
 188
 189 void FGTank::Debug(int from)
 190 {
 191   if (debug_lvl <= 0) return;
 192
 193   if (debug_lvl & 1) { // Standard console startup message output
 194     if (from == 0) { // Constructor
 195       cout << "      " << type << " tank holds " << Capacity << " lbs. " << type << endl;
 196       cout << "      currently at " << PctFull << "% of maximum capacity" << endl;
 197       cout << "      Tank location (X, Y, Z): " << vXYZ(eX) << ", " << vXYZ(eY) << ", " << vXYZ(eZ) << endl;
 198       cout << "      Effective radius: " << Radius << " inches" << endl;
 199     }
 200   }
 201   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 202     if (from == 0) cout << "Instantiated: FGTank" << endl;
 203     if (from == 1) cout << "Destroyed:    FGTank" << endl;
 204   }
 205   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 206   }
 207   if (debug_lvl & 8 ) { // Runtime state variables
 208   }
 209   if (debug_lvl & 16) { // Sanity checking
 210   }
 211   if (debug_lvl & 64) {
 212     if (from == 0) { // Constructor
 213       cout << IdSrc << endl;
 214       cout << IdHdr << endl;
 215     }
 216   }
 217 }
 218 }