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   <density unit="{KG/L | LBS/GAL}"> {number} </density>
 132 </tank>
 133 @endcode
 134
 135 <h3>Definition of the tank configuration file parameters:</h3>
 136
 137 - \b type - One of FUEL or OXIDIZER.  This is required.
 138 - \b radius - Equivalent radius of tank for modeling slosh, defaults to inches.
 139 - \b grain_config type - One of CYLINDRICAL or ENDBURNING.
 140 - \b length - length of tank for modeling solid fuel propellant grain, defaults to inches.
 141 - \b capacity - Capacity, defaults to pounds.
 142 - \b contents - Initial contents, defaults to pounds.
 143 - \b temperature - Initial temperature, defaults to degrees Fahrenheit.
 144 - \b standpipe - Minimum contents to which tank can dump, defaults to pounds.
 145 - \b priority - Establishes feed sequence of tank. "1" is the highest priority.
 146 - \b density - Density of liquid tank contents.
 147
 148 location:
 149 - \b x - Location of tank on aircraft's x-axis, defaults to inches.
 150 - \b y - Location of tank on aircraft's y-axis, defaults to inches.
 151 - \b z - Location of tank on aircraft's z-axis, defaults to inches.
 152
 153 drain_location:
 154 - \b x - Location of tank drain on aircraft's x-axis, defaults to inches.
 155 - \b y - Location of tank drain on aircraft's y-axis, defaults to inches.
 156 - \b z - Location of tank drain on aircraft's z-axis, defaults to inches.
 157
 158 <h3>Default values of the tank configuration file parameters:</h3>
 159
 160 - \b type - ttUNKNOWN  (causes a load error in the propulsion configuration)
 161 - \b location, \b drain_location - both optional, but a warning message will
 162 be printed to the console if the location is not given
 163 - \b x - 0.0  (both full and drained CG locations)
 164 - \b y - 0.0  (both full and drained CG locations)
 165 - \b z - 0.0  (both full and drained CG locations)
 166 - \b radius - 0.0
 167 - \b capacity - 0.00001 (tank capacity must not be zero)
 168 - \b contents - 0.0
 169 - \b temperature - -9999.0 (flag which indicates no temperature is set)
 170 - \b standpipe - 0.0 (all contents may be dumped)
 171 - \b priority - 1 (highest feed sequence priority)
 172 - \b density - 6.6
 173
 174     @author Jon Berndt, Dave Culp
 175     @see Akbar, Raza et al. "A Simple Analysis of Fuel Addition to the CWT of
 176     747", California Institute of Technology, 1998,
 177     http://www.galcit.caltech.edu/EDL/projects/JetA/reports/lumped.pdf
 178 */
 179
 180 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 181 CLASS DECLARATION
 182 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 183
 184 class FGTank : public FGJSBBase
 185 {
 186 public:
 187   /** Constructor.
 188       The constructor reads in the defining parameters from a configuration file.
 189       @param exec a pointer to the base FGFDMExec instance.
 190       @param el a pointer to the Tank element.
 191       @param tank_number the tank number (zero based).
 192   */
 193   FGTank(FGFDMExec* exec, Element* el, int tank_number);
 194   /// Destructor
 195   ~FGTank();
 196
 197   /** Removes fuel from the tank.
 198       This function removes fuel from a tank. If the tank empties, it is
 199       deselected.
 200       @param used the amount of fuel used in lbs.
 201       @return the remaining contents of the tank in lbs.
 202   */
 203   double Drain(double used);
 204
 205   /** Performs local, tanks-specific calculations, such as fuel temperature.
 206       This function calculates the temperature of the fuel in the tank.
 207       @param dt the time step for this model.
 208       @return the current temperature in degrees Celsius.
 209   */
 210   double Calculate(double dt);
 211
 212   /** Retrieves the type of tank: Fuel or Oxidizer.
 213       @return the tank type, 0 for undefined, 1 for fuel, and 2 for oxidizer.
 214   */
 215   int GetType(void) {return Type;}
 216
 217   /** Resets the tank parameters to the initial conditions */
 218   void ResetToIC(void);
 219
 220   /** If the tank is set to supply fuel, this function returns true.
 221       @return true if this tank is set to a non-zero priority.*/
 222   bool GetSelected(void) {return Selected;}
 223
 224   /** Gets the tank fill level.
 225       @return the fill level in percent, from 0 to 100.*/
 226   double GetPctFull(void) {return PctFull;}
 227
 228   /** Gets the capacity of the tank.
 229       @return the capacity of the tank in pounds. */
 230   double GetCapacity(void) {return Capacity;}
 231
 232   /** Gets the capacity of the tank.
 233       @return the capacity of the tank in gallons. */
 234   double GetCapacityGallons(void) {return Capacity/Density;}
 235
 236   /** Gets the contents of the tank.
 237       @return the contents of the tank in pounds. */
 238   double GetContents(void) const {return Contents;}
 239
 240   /** Gets the contents of the tank.
 241       @return the contents of the tank in gallons. */
 242   double GetContentsGallons(void) const {return Contents/Density;}
 243
 244   /** Gets the temperature of the fuel.
 245       The temperature of the fuel is calculated if an initial tempearture is
 246       given in the configuration file.
 247       @return the temperature of the fuel in degrees C IF an initial temperature
 248       is given, otherwise 0.0 C is returned. */
 249   double GetTemperature_degC(void) {return Temperature;}
 250
 251   /** Gets the temperature of the fuel.
 252       The temperature of the fuel is calculated if an initial tempearture is
 253       given in the configuration file.
 254       @return the temperature of the fuel in degrees F IF an initial temperature
 255       is given, otherwise 32 degrees F is returned. */
 256   double GetTemperature(void) {return CelsiusToFahrenheit(Temperature);}
 257
 258   double GetIxx(void) {return Ixx;}
 259   double GetIyy(void) {return Iyy;}
 260   double GetIzz(void) {return Izz;}
 261
 262   double GetStandpipe(void) {return Standpipe;}
 263
 264   int  GetPriority(void) const {return Priority;}
 265   void SetPriority(int p) { Priority = p; Selected = p>0 ? true:false; }
 266
 267   const FGColumnVector3 GetXYZ(void);
 268   const double GetXYZ(int idx);
 269
 270   double Fill(double amount);
 271   void SetContents(double amount);
 272   void SetContentsGallons(double gallons);
 273   void SetTemperature(double temp) { Temperature = temp; }
 274   void SetStandpipe(double amount) { Standpipe = amount; }
 275   void SetSelected(bool sel) { sel==true ? SetPriority(1):SetPriority(0); }
 276
 277   enum TankType {ttUNKNOWN, ttFUEL, ttOXIDIZER};
 278   enum GrainType {gtUNKNOWN, gtCYLINDRICAL, gtENDBURNING};
 279
 280 private:
 281   TankType Type;
 282   GrainType grainType;
 283   int TankNumber;
 284   string type;
 285   string strGType;
 286   FGColumnVector3 vXYZ;
 287   FGColumnVector3 vXYZ_drain;
 288   double Capacity;
 289   double Radius;
 290   double InnerRadius;
 291   double Length;
 292   double Volume;
 293   double Density;
 294   double Ixx;
 295   double Iyy;
 296   double Izz;
 297   double PctFull;
 298   double Contents, InitialContents;
 299   double Area;
 300   double Temperature, InitialTemperature;
 301   double Standpipe, InitialStandpipe;
 302   bool  Selected;
 303   int Priority, InitialPriority;
 304   FGFDMExec* Exec;
 305   FGPropertyManager* PropertyManager;
 306   void CalculateInertias(void);
 307   void Debug(int from);
 308 };
 309 }
 310 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 311 #endif
 312