src/FDM/JSBSim/FGMassBalance.h

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Header:       FGMassBalance.h
   4  Author:       Jon S. Berndt
   5  Date started: 09/12/2000
   6
   7  ------------- Copyright (C) 2000  Jon S. Berndt (jsb@hal-pc.org) --------------
   8
   9  This program is free software; you can redistribute it and/or modify it under
  10  the terms of the GNU 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 General Public License for more
  17  details.
  18
  19  You should have received a copy of the GNU 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 General Public License can also be found on
  24  the world wide web at http://www.gnu.org.
  25
  26 HISTORY
  27 --------------------------------------------------------------------------------
  28 09/12/2000  JSB  Created
  29
  30 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  31 SENTRY
  32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  33
  34 #ifndef FGMASSBALANCE_H
  35 #define FGMASSBALANCE_H
  36
  37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #include "FGModel.h"
  42 #include "FGPropulsion.h"
  43 #include <vector>
  44
  45 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  46 DEFINITIONS
  47 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  48
  49 #define ID_MASSBALANCE "$Id$"
  50
  51 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  52 FORWARD DECLARATIONSS
  53 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  54
  55 namespace JSBSim {
  56
  57 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  58 CLASS DOCUMENTATION
  59 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  60
  61 /** Models weight and balance information.
  62   */
  63
  64 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  65 CLASS DECLARATION
  66 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  67
  68 class FGMassBalance : public FGModel
  69 {
  70
  71 public:
  72   FGMassBalance(FGFDMExec*);
  73   ~FGMassBalance();
  74
  75   bool Run(void);
  76
  77   inline double GetMass(void) const {return Mass;}
  78   inline double GetWeight(void) const {return Weight;}
  79   inline double GetIxx(void) const {return Ixx;}
  80   inline double GetIyy(void) const {return Iyy;}
  81   inline double GetIzz(void) const {return Izz;}
  82   inline double GetIxy(void) const {return Ixy;}
  83   inline double GetIxz(void) const {return Ixz;}
  84   inline FGColumnVector3& GetXYZcg(void) {return vXYZcg;}
  85   inline double GetXYZcg(int axis) const  {return vXYZcg(axis);}
  86
  87   /** Conversion from the structural frame to the body frame.
  88    * Converts the argument \parm r given in the reference frame
  89    * coordinate system to the body frame. The units of the structural
  90    * frame are assumed to be in inches. The unit of the result is in
  91    * ft.
  92    */
  93   FGColumnVector3 StructuralToBody(const FGColumnVector3& r) const;
  94
  95   inline void SetEmptyWeight(double EW) { EmptyWeight = EW;}
  96   inline void SetBaseIxx(double bixx)   { baseIxx = bixx;}
  97   inline void SetBaseIyy(double biyy)   { baseIyy = biyy;}
  98   inline void SetBaseIzz(double bizz)   { baseIzz = bizz;}
  99   inline void SetBaseIxy(double bixy)   { baseIxy = bixy;}
 100   inline void SetBaseIxz(double bixz)   { baseIxz = bixz;}
 101   inline void SetBaseCG(const FGColumnVector3& CG) {vbaseXYZcg = CG;}
 102
 103   void AddPointMass(double weight, double X, double Y, double Z);
 104   double GetPointMassWeight(void);
 105   FGColumnVector3& GetPointMassMoment(void);
 106   double GetPMIxx(void);
 107   double GetPMIyy(void);
 108   double GetPMIzz(void);
 109   double GetPMIxy(void);
 110   double GetPMIxz(void);
 111
 112   void bind(void);
 113   void unbind(void);
 114
 115 private:
 116   double Weight;
 117   double EmptyWeight;
 118   double Mass;
 119   double Ixx;
 120   double Iyy;
 121   double Izz;
 122   double Ixy;
 123   double Ixz;
 124   double baseIxx;
 125   double baseIyy;
 126   double baseIzz;
 127   double baseIxy;
 128   double baseIxz;
 129   FGColumnVector3 vXYZcg;
 130   FGColumnVector3 vXYZtank;
 131   FGColumnVector3 vbaseXYZcg;
 132   vector <FGColumnVector3> PointMassLoc;
 133   vector <double> PointMassWeight;
 134   FGColumnVector3 PointMassCG;
 135   void Debug(int from);
 136 };
 137 }
 138 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 139 #endif