FGTank.h

/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 Header:       FGTank.h
 Author:       Jon S. Berndt
 Date started: 01/21/99
 
 ------------- Copyright (C) 1999  Jon S. Berndt (jon@jsbsim.org) -------------
 
 This program is free software; you can redistribute it and/or modify it under
 the terms of the GNU Lesser General Public License as published by the Free
 Software Foundation; either version 2 of the License, or (at your option) any
 later version.
 
 This program is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 details.
 
 You should have received a copy of the GNU Lesser General Public License along
 with this program; if not, write to the Free Software Foundation, Inc., 59
 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
 Further information about the GNU Lesser General Public License can also be
 found on the world wide web at http://www.gnu.org.
 
FUNCTIONAL DESCRIPTION
--------------------------------------------------------------------------------
 
Based on Flightgear code, which is based on LaRCSim. This class simulates
a generic Tank.
 
HISTORY
--------------------------------------------------------------------------------
01/21/99   JSB   Created
 
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SENTRY
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
#ifndef FGTank_H
#define FGTank_H
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
INCLUDES
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
#include "FGJSBBase.h"
#include "math/FGColumnVector3.h"
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
FORWARD DECLARATIONS
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
namespace JSBSim {
 
class Element;
class FGPropertyManager;
class FGFDMExec;
class FGFunction;
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DOCUMENTATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DECLARATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
class JSBSIM_API FGTank : public FGJSBBase
{
public:
  FGTank(FGFDMExec* exec, Element* el, int tank_number);
  ~FGTank();
 
  enum TankType {ttUNKNOWN, ttFUEL, ttOXIDIZER};
  enum GrainType {gtUNKNOWN, gtCYLINDRICAL, gtENDBURNING, gtFUNCTION};
 
  double Drain(double used);
 
  double Calculate(double dt, double TempC);
 
  int GetType(void) const {return Type;}
 
  const std::string& GetName(void) const { return Name; }
 
  void ResetToIC(void);
 
  bool GetSelected(void) const {return Selected;}
 
  double GetPctFull(void) const {return PctFull;}
 
  double GetCapacity(void) const {return Capacity;}
 
  double GetCapacityGallons(void) const {return Capacity/Density;}
 
  double GetContents(void) const {return Contents;}
 
  double GetContentsGallons(void) const {return Contents/Density;}
 
  double GetTemperature_degC(void) const {return Temperature;}
 
  double GetTemperature(void) const {return CelsiusToFahrenheit(Temperature);}
 
  double ProcessFuelName(const std::string& name);
 
  double GetUnusable(void) const {return UnusableVol*Density;}
 
  double GetUnusableVolume(void) const {return UnusableVol;}
 
  void SetUnusableVolume(double volume) {UnusableVol = volume;}
 
  double GetIxx(void) const {return Ixx;}
  double GetIyy(void) const {return Iyy;}
  double GetIzz(void) const {return Izz;}
 
  inline double GetLocationX(void) const { return vXYZ(eX); }
  inline double GetLocationY(void) const { return vXYZ(eY); }
  inline double GetLocationZ(void) const { return vXYZ(eZ); }
  inline void SetLocationX(double x) { vXYZ(eX) = x; }
  inline void SetLocationY(double y) { vXYZ(eY) = y; }
  inline void SetLocationZ(double z) { vXYZ(eZ) = z; }
 
  double GetStandpipe(void) const {return Standpipe;}
 
  int  GetPriority(void) const {return Priority;}
  void SetPriority(int p) { Priority = p; Selected = p>0 ? true:false; } 
 
  double GetDensity(void) const {return Density;}
  void   SetDensity(double d) { Density = d; }
 
  double GetExternalFlow(void) const {return ExternalFlow;}
  void   SetExternalFlow(double f) { ExternalFlow = f; }
 
  FGColumnVector3 GetXYZ(void) const;
  double GetXYZ(int idx) const;
 
  GrainType GetGrainType(void) const {return grainType;}
 
  double Fill(double amount);
  void SetContents(double amount);
  void SetContentsGallons(double gallons);
  void SetTemperature(double temp) { Temperature = temp; }
  void SetStandpipe(double amount) { Standpipe = amount; }
  void SetSelected(bool sel) { sel==true ? SetPriority(1):SetPriority(0); }
 
private:
  TankType Type;
  GrainType grainType;
  int TankNumber;
  std::string Name;
  double ixx_unit;
  double iyy_unit;
  double izz_unit;
  FGColumnVector3 vXYZ;
  FGColumnVector3 vXYZ_drain;
  FGFunction* function_ixx;
  FGFunction* function_iyy;
  FGFunction* function_izz;
  double Capacity, UnusableVol;
  double Radius;
  double InnerRadius;
  double Length;
  double Volume;
  double Density;
  double Ixx;
  double Iyy;
  double Izz;
  double InertiaFactor;
  double PctFull;
  double Contents, InitialContents;
  double Area;
  double Temperature, InitialTemperature;
  double Standpipe, InitialStandpipe;
  double ExternalFlow;
  bool  Selected;
  int Priority, InitialPriority;
 
  void CalculateInertias(void);
  void bind(FGPropertyManager* PropertyManager);
  void Debug(int from);
};
}
//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
#endif