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 "FGFDMExec.h"
  48 #include "FGJSBBase.h"
  49 #include "input_output/FGXMLElement.h"
  50 #include "math/FGColumnVector3.h"
  51 #include <string>
  52
  53 using std::string;
  54 using std::cerr;
  55 using std::endl;
  56 using std::cout;
  57
  58 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  59 DEFINITIONS
  60 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  61
  62 #define ID_TANK "$Id$"
  63
  64 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  65 FORWARD DECLARATIONS
  66 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  67
  68 namespace JSBSim {
  69
  70 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  71 CLASS DOCUMENTATION
  72 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  73
  74 /** Models a fuel tank.
  75
  76 <h3>Fuel Temperature:</h3>
  77
  78     Fuel temperature is calculated using the following assumptions:
  79
  80     Fuel temperature will only be calculated for tanks which have an initial fuel
  81     temperature specified in the configuration file.
  82
  83     The surface area of the tank is estimated from the capacity in pounds.  It
  84     is assumed that the tank is a wing tank with dimensions h by 4h by 10h. The
  85     volume of the tank is then 40(h)(h)(h). The area of the upper or lower
  86     surface is then 40(h)(h).  The volume is also equal to the capacity divided
  87     by 49.368 lbs/cu-ft, for jet fuel.  The surface area of one side can then be
  88     derived from the tank's capacity.
  89
  90     The heat capacity of jet fuel is assumed to be 900 Joules/lbm/K, and the
  91     heat transfer factor of the tank is 1.115 Watts/sq-ft/K.
  92
  93 <h3>Fuel Dump:</h3>
  94
  95     Fuel dumping is handled by the FGPropulsion class.  A standpipe can be defined
  96     here for each tank which sets the level of contents (in pounds) which is not dumpable.
  97     Default standpipe level is zero, making all contents dumpable.
  98
  99 <h3>Fuel Transfer:</h3>
 100
 101     Fuel transfer is handled by the FGPropulsion class, however the contents of tanks
 102     may be manipulated directly using the SetContents() function here, or via the property
 103     tree at <tt>propulsion/tank[i]/contents-lbs</tt>, where i is the tank number (Tanks
 104     are automatically numbered, starting at zero, in the order in which they are read in
 105     the aircraft configuration file).  The latter method allows one to use a system of FCS
 106     components to control tank contents.
 107
 108 <h3>Configuration File Format:</h3>
 109
 110 @code
 111 <tank type="{FUEL | OXIDIZER}">
 112   <grain_config type="{CYLINDRICAL | ENDBURNING}">
 113     <length unit="{IN | FT | M}"> {number} </radius>
 114   </grain_config>
 115   <location unit="{FT | M | IN}">
 116     <x> {number} </x>
 117     <y> {number} </y>
 118     <z> {number} </z>
 119   </location>
 120   <drain_location unit="{FT | M | IN}">
 121     <x> {number} </x>
 122     <y> {number} </y>
 123     <z> {number} </z>
 124   </drain_location>
 125   <radius unit="{IN | FT | M}"> {number} </radius>
 126   <capacity unit="{LBS | KG}"> {number} </capacity>
 127   <contents unit="{LBS | KG}"> {number} </contents>
 128   <temperature> {number} </temperature> <!-- must be degrees fahrenheit -->
 129   <standpipe unit="{LBS | KG"}> {number} </standpipe>
 130   <priority> {integer} </priority>
 131 </tank>
 132 @endcode
 133
 134 <h3>Definition of the tank configuration file parameters:</h3>
 135
 136 - \b type - One of FUEL or OXIDIZER.  This is required.
 137 - \b radius - Equivalent radius of tank for modeling slosh, defaults to inches.
 138 - \b grain_config type - One of CYLINDRICAL or ENDBURNING.
 139 - \b length - length of tank for modeling solid fuel propellant grain, defaults to inches.
 140 - \b capacity - Capacity, defaults to pounds.
 141 - \b contents - Initial contents, defaults to pounds.
 142 - \b temperature - Initial temperature, defaults to degrees Fahrenheit.
 143 - \b standpipe - Minimum contents to which tank can dump, defaults to pounds.
 144 - \b priority - Establishes feed sequence of tank. "1" is the highest priority.
 145
 146 location:
 147 - \b x - Location of tank on aircraft's x-axis, defaults to inches.
 148 - \b y - Location of tank on aircraft's y-axis, defaults to inches.
 149 - \b z - Location of tank on aircraft's z-axis, defaults to inches.
 150
 151 drain_location:
 152 - \b x - Location of tank drain on aircraft's x-axis, defaults to inches.
 153 - \b y - Location of tank drain on aircraft's y-axis, defaults to inches.
 154 - \b z - Location of tank drain on aircraft's z-axis, defaults to inches.
 155
 156 <h3>Default values of the tank configuration file parameters:</h3>
 157
 158 - \b type - ttUNKNOWN  (causes a load error in the propulsion configuration)
 159 - \b location, \b drain_location - both optional, but a warning message will
 160 be printed to the console if the location is not given
 161 - \b x - 0.0  (both full and drained CG locations)
 162 - \b y - 0.0  (both full and drained CG locations)
 163 - \b z - 0.0  (both full and drained CG locations)
 164 - \b radius - 0.0
 165 - \b capacity - 0.00001 (tank capacity must not be zero)
 166 - \b contents - 0.0
 167 - \b temperature - -9999.0 (flag which indicates no temperature is set)
 168 - \b standpipe - 0.0 (all contents may be dumped)
 169 - \b priority - 1 (highest feed sequence priority)
 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 contents of the tank.
 230       @return the contents of the tank in pounds. */
 231   double GetContents(void) const {return Contents;}
 232
 233   /** Gets the temperature of the fuel.
 234       The temperature of the fuel is calculated if an initial tempearture is
 235       given in the configuration file.
 236       @return the temperature of the fuel in degrees C IF an initial temperature
 237       is given, otherwise 0.0 C is returned. */
 238   double GetTemperature_degC(void) {return Temperature;}
 239
 240   /** Gets the temperature of the fuel.
 241       The temperature of the fuel is calculated if an initial tempearture is
 242       given in the configuration file.
 243       @return the temperature of the fuel in degrees F IF an initial temperature
 244       is given, otherwise 32 degrees F is returned. */
 245   double GetTemperature(void) {return CelsiusToFahrenheit(Temperature);}
 246
 247   double GetIxx(void) {return Ixx;}
 248   double GetIyy(void) {return Iyy;}
 249   double GetIzz(void) {return Izz;}
 250
 251   double GetStandpipe(void) {return Standpipe;}
 252
 253   int  GetPriority(void) const {return Priority;}
 254   void SetPriority(int p) { Priority = p; Selected = p>0 ? true:false; }
 255
 256   const FGColumnVector3 GetXYZ(void);
 257   const double GetXYZ(int idx);
 258
 259   double Fill(double amount);
 260   void SetContents(double amount);
 261   void SetTemperature(double temp) { Temperature = temp; }
 262   void SetStandpipe(double amount) { Standpipe = amount; }
 263   void SetSelected(bool sel) { sel==true ? SetPriority(1):SetPriority(0); }
 264
 265   enum TankType {ttUNKNOWN, ttFUEL, ttOXIDIZER};
 266   enum GrainType {gtUNKNOWN, gtCYLINDRICAL, gtENDBURNING};
 267
 268 private:
 269   TankType Type;
 270   GrainType grainType;
 271   int TankNumber;
 272   string type;
 273   string strGType;
 274   FGColumnVector3 vXYZ;
 275   FGColumnVector3 vXYZ_drain;
 276   double Capacity;
 277   double Radius;
 278   double InnerRadius;
 279   double Length;
 280   double Volume;
 281   double Density;
 282   double Ixx;
 283   double Iyy;
 284   double Izz;
 285   double PctFull;
 286   double Contents, InitialContents;
 287   double Area;
 288   double Temperature, InitialTemperature;
 289   double Standpipe, InitialStandpipe;
 290   bool  Selected;
 291   int Priority, InitialPriority;
 292   FGFDMExec* Exec;
 293   FGPropertyManager* PropertyManager;
 294   void CalculateInertias(void);
 295   void Debug(int from);
 296 };
 297 }
 298 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 299 #endif
 300