src/FDM/JSBSim/models/propulsion/FGTank.h

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Header:       FGTank.h
   4  Author:       Jon S. Berndt
   5  Date started: 01/21/99
   6
   7  ------------- Copyright (C) 1999  Jon S. Berndt (jon@jsbsim.org) -------------
   8
   9  This program is free software; you can redistribute it and/or modify it under
  10  the terms of the GNU Lesser General Public License as published by the Free Software
  11  Foundation; either version 2 of the License, or (at your option) any later
  12  version.
  13
  14  This program is distributed in the hope that it will be useful, but WITHOUT
  15  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
  17  details.
  18
  19  You should have received a copy of the GNU Lesser General Public License along with
  20  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  21  Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23  Further information about the GNU Lesser General Public License can also be found on
  24  the world wide web at http://www.gnu.org.
  25
  26 FUNCTIONAL DESCRIPTION
  27 --------------------------------------------------------------------------------
  28
  29 Based on Flightgear code, which is based on LaRCSim. This class simulates
  30 a generic Tank.
  31
  32 HISTORY
  33 --------------------------------------------------------------------------------
  34 01/21/99   JSB   Created
  35
  36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  37 SENTRY
  38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  39
  40 #ifndef FGTank_H
  41 #define FGTank_H
  42
  43 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  44 INCLUDES
  45 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  46
  47 #include "FGJSBBase.h"
  48 #include "math/FGColumnVector3.h"
  49 #include <string>
  50
  51 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  52 DEFINITIONS
  53 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  54
  55 #define ID_TANK "$Id$"
  56
  57 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  58 FORWARD DECLARATIONS
  59 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  60
  61 namespace JSBSim {
  62
  63 class Element;
  64 class FGPropertyManager;
  65 class FGFDMExec;
  66
  67 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  68 CLASS DOCUMENTATION
  69 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  70
  71 /** Models a fuel tank.
  72
  73 <h3>Fuel Temperature:</h3>
  74
  75     Fuel temperature is calculated using the following assumptions:
  76
  77     Fuel temperature will only be calculated for tanks which have an initial fuel
  78     temperature specified in the configuration file.
  79
  80     The surface area of the tank is estimated from the capacity in pounds.  It
  81     is assumed that the tank is a wing tank with dimensions h by 4h by 10h. The
  82     volume of the tank is then 40(h)(h)(h). The area of the upper or lower
  83     surface is then 40(h)(h).  The volume is also equal to the capacity divided
  84     by 49.368 lbs/cu-ft, for jet fuel.  The surface area of one side can then be
  85     derived from the tank's capacity.
  86
  87     The heat capacity of jet fuel is assumed to be 900 Joules/lbm/K, and the
  88     heat transfer factor of the tank is 1.115 Watts/sq-ft/K.
  89
  90 <h3>Fuel Dump:</h3>
  91
  92     Fuel dumping is handled by the FGPropulsion class.  A standpipe can be defined
  93     here for each tank which sets the level of contents (in pounds) which is not dumpable.
  94     Default standpipe level is zero, making all contents dumpable.
  95
  96 <h3>Fuel Transfer:</h3>
  97
  98     Fuel transfer is handled by the FGPropulsion class, however the contents of tanks
  99     may be manipulated directly using the SetContents() function here, or via the property
 100     tree at <tt>propulsion/tank[i]/contents-lbs</tt>, where i is the tank number (Tanks
 101     are automatically numbered, starting at zero, in the order in which they are read in
 102     the aircraft configuration file).  The latter method allows one to use a system of FCS
 103     components to control tank contents.
 104
 105 <h3>Configuration File Format:</h3>
 106
 107 @code
 108 <tank type="{FUEL | OXIDIZER}">
 109   <grain_config type="{CYLINDRICAL | ENDBURNING}">
 110     <length unit="{IN | FT | M}"> {number} </radius>
 111   </grain_config>
 112   <location unit="{FT | M | IN}">
 113     <x> {number} </x>
 114     <y> {number} </y>
 115     <z> {number} </z>
 116   </location>
 117   <drain_location unit="{FT | M | IN}">
 118     <x> {number} </x>
 119     <y> {number} </y>
 120     <z> {number} </z>
 121   </drain_location>
 122   <radius unit="{IN | FT | M}"> {number} </radius>
 123   <capacity unit="{LBS | KG}"> {number} </capacity>
 124   <contents unit="{LBS | KG}"> {number} </contents>
 125   <temperature> {number} </temperature> <!-- must be degrees fahrenheit -->
 126   <standpipe unit="{LBS | KG"}> {number} </standpipe>
 127   <priority> {integer} </priority>
 128   <density unit="{KG/L | LBS/GAL}"> {number} </density>
 129 </tank>
 130 @endcode
 131
 132 <h3>Definition of the tank configuration file parameters:</h3>
 133
 134 - \b type - One of FUEL or OXIDIZER.  This is required.
 135 - \b radius - Equivalent radius of tank for modeling slosh, defaults to inches.
 136 - \b grain_config type - One of CYLINDRICAL or ENDBURNING.
 137 - \b length - length of tank for modeling solid fuel propellant grain, defaults to inches.
 138 - \b capacity - Capacity, defaults to pounds.
 139 - \b contents - Initial contents, defaults to pounds.
 140 - \b temperature - Initial temperature, defaults to degrees Fahrenheit.
 141 - \b standpipe - Minimum contents to which tank can dump, defaults to pounds.
 142 - \b priority - Establishes feed sequence of tank. "1" is the highest priority.
 143 - \b density - Density of liquid tank contents.
 144
 145 location:
 146 - \b x - Location of tank on aircraft's x-axis, defaults to inches.
 147 - \b y - Location of tank on aircraft's y-axis, defaults to inches.
 148 - \b z - Location of tank on aircraft's z-axis, defaults to inches.
 149
 150 drain_location:
 151 - \b x - Location of tank drain on aircraft's x-axis, defaults to inches.
 152 - \b y - Location of tank drain on aircraft's y-axis, defaults to inches.
 153 - \b z - Location of tank drain on aircraft's z-axis, defaults to inches.
 154
 155 <h3>Default values of the tank configuration file parameters:</h3>
 156
 157 - \b type - ttUNKNOWN  (causes a load error in the propulsion configuration)
 158 - \b location, \b drain_location - both optional, but a warning message will
 159 be printed to the console if the location is not given
 160 - \b x - 0.0  (both full and drained CG locations)
 161 - \b y - 0.0  (both full and drained CG locations)
 162 - \b z - 0.0  (both full and drained CG locations)
 163 - \b radius - 0.0
 164 - \b capacity - 0.00001 (tank capacity must not be zero)
 165 - \b contents - 0.0
 166 - \b temperature - -9999.0 (flag which indicates no temperature is set)
 167 - \b standpipe - 0.0 (all contents may be dumped)
 168 - \b priority - 1 (highest feed sequence priority)
 169 - \b density - 6.6
 170
 171     @author Jon Berndt, Dave Culp
 172     @see Akbar, Raza et al. "A Simple Analysis of Fuel Addition to the CWT of
 173     747", California Institute of Technology, 1998,
 174     http://www.galcit.caltech.edu/EDL/projects/JetA/reports/lumped.pdf
 175 */
 176
 177 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 178 CLASS DECLARATION
 179 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 180
 181 class FGTank : public FGJSBBase
 182 {
 183 public:
 184   /** Constructor.
 185       The constructor reads in the defining parameters from a configuration file.
 186       @param exec a pointer to the base FGFDMExec instance.
 187       @param el a pointer to the Tank element.
 188       @param tank_number the tank number (zero based).
 189   */
 190   FGTank(FGFDMExec* exec, Element* el, int tank_number);
 191   /// Destructor
 192   ~FGTank();
 193
 194   /** Removes fuel from the tank.
 195       This function removes fuel from a tank. If the tank empties, it is
 196       deselected.
 197       @param used the amount of fuel used in lbs.
 198       @return the remaining contents of the tank in lbs.
 199   */
 200   double Drain(double used);
 201
 202   /** Performs local, tanks-specific calculations, such as fuel temperature.
 203       This function calculates the temperature of the fuel in the tank.
 204       @param dt the time step for this model.
 205       @return the current temperature in degrees Celsius.
 206   */
 207   double Calculate(double dt);
 208
 209   /** Retrieves the type of tank: Fuel or Oxidizer.
 210       @return the tank type, 0 for undefined, 1 for fuel, and 2 for oxidizer.
 211   */
 212   int GetType(void) {return Type;}
 213
 214   /** Resets the tank parameters to the initial conditions */
 215   void ResetToIC(void);
 216
 217   /** If the tank is set to supply fuel, this function returns true.
 218       @return true if this tank is set to a non-zero priority.*/
 219   bool GetSelected(void) {return Selected;}
 220
 221   /** Gets the tank fill level.
 222       @return the fill level in percent, from 0 to 100.*/
 223   double GetPctFull(void) {return PctFull;}
 224
 225   /** Gets the capacity of the tank.
 226       @return the capacity of the tank in pounds. */
 227   double GetCapacity(void) {return Capacity;}
 228
 229   /** Gets the capacity of the tank.
 230       @return the capacity of the tank in gallons. */
 231   double GetCapacityGallons(void) {return Capacity/Density;}
 232
 233   /** Gets the contents of the tank.
 234       @return the contents of the tank in pounds. */
 235   double GetContents(void) const {return Contents;}
 236
 237   /** Gets the contents of the tank.
 238       @return the contents of the tank in gallons. */
 239   double GetContentsGallons(void) const {return Contents/Density;}
 240
 241   /** Gets the temperature of the fuel.
 242       The temperature of the fuel is calculated if an initial tempearture is
 243       given in the configuration file.
 244       @return the temperature of the fuel in degrees C IF an initial temperature
 245       is given, otherwise 0.0 C is returned. */
 246   double GetTemperature_degC(void) {return Temperature;}
 247
 248   /** Gets the temperature of the fuel.
 249       The temperature of the fuel is calculated if an initial tempearture is
 250       given in the configuration file.
 251       @return the temperature of the fuel in degrees F IF an initial temperature
 252       is given, otherwise 32 degrees F is returned. */
 253   double GetTemperature(void) {return CelsiusToFahrenheit(Temperature);}
 254
 255   double GetIxx(void) {return Ixx;}
 256   double GetIyy(void) {return Iyy;}
 257   double GetIzz(void) {return Izz;}
 258
 259   double GetStandpipe(void) {return Standpipe;}
 260
 261   int  GetPriority(void) const {return Priority;}
 262   void SetPriority(int p) { Priority = p; Selected = p>0 ? true:false; }
 263
 264   const FGColumnVector3 GetXYZ(void);
 265   const double GetXYZ(int idx);
 266
 267   double Fill(double amount);
 268   void SetContents(double amount);
 269   void SetContentsGallons(double gallons);
 270   void SetTemperature(double temp) { Temperature = temp; }
 271   void SetStandpipe(double amount) { Standpipe = amount; }
 272   void SetSelected(bool sel) { sel==true ? SetPriority(1):SetPriority(0); }
 273
 274   enum TankType {ttUNKNOWN, ttFUEL, ttOXIDIZER};
 275   enum GrainType {gtUNKNOWN, gtCYLINDRICAL, gtENDBURNING};
 276
 277 private:
 278   TankType Type;
 279   GrainType grainType;
 280   int TankNumber;
 281   std::string type;
 282   std::string strGType;
 283   FGColumnVector3 vXYZ;
 284   FGColumnVector3 vXYZ_drain;
 285   double Capacity;
 286   double Radius;
 287   double InnerRadius;
 288   double Length;
 289   double Volume;
 290   double Density;
 291   double Ixx;
 292   double Iyy;
 293   double Izz;
 294   double PctFull;
 295   double Contents, InitialContents;
 296   double Area;
 297   double Temperature, InitialTemperature;
 298   double Standpipe, InitialStandpipe;
 299   bool  Selected;
 300   int Priority, InitialPriority;
 301   FGFDMExec* Exec;
 302   FGPropertyManager* PropertyManager;
 303   void CalculateInertias(void);
 304   void Debug(int from);
 305 };
 306 }
 307 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 308 #endif
 309