FGPropeller.h

/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 Header:       FGPropeller.h
 Author:       Jon S. Berndt
 Date started: 08/24/00
 
 ------------- Copyright (C) 2000  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.
 
HISTORY
--------------------------------------------------------------------------------
08/24/00  JSB  Created
 
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SENTRY
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
#ifndef FGPROPELLER_H
#define FGPROPELLER_H
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
INCLUDES
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
#include "FGThruster.h"
#include "math/FGTable.h"
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
FORWARD DECLARATIONS
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
namespace JSBSim {
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DOCUMENTATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DECLARATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
class FGPropeller : public FGThruster {
 
public:
  FGPropeller(FGFDMExec* exec, Element* el, int num = 0);
 
  ~FGPropeller();
 
  void ResetToIC(void);
 
  void SetRPM(double rpm) {RPM = rpm;}
 
  void SetEngineRPM(double rpm) {RPM = rpm/GearRatio;}
 
  bool IsVPitch(void) const {return MaxPitch != MinPitch;}
 
  void SetPitch(double pitch) {Pitch = pitch;}
 
  void SetAdvance(double advance) {Advance = advance;}
 
  void SetPFactor(double pf) {P_Factor = pf;}
 
  void SetConstantSpeed(int mode) {ConstantSpeed = mode;} 
 
  void SetCtFactor(double ctf) {CtFactor = ctf;}
 
  void SetCpFactor(double cpf) {CpFactor = cpf;}
 
  void SetSense(double s) { Sense = s;}
 
  double GetPitch(void) const     { return Pitch;         }
 
  double GetRPM(void) const       { return RPM;           } 
 
  double GetEngineRPM(void) const { return RPM * GearRatio;  } 
 
  double GetIxx(void) const       { return Ixx;           }
 
  double GetCtFactor(void) const  { return CtFactor;      }
 
  double GetCpFactor(void) const  { return CpFactor;      }
 
  double GetDiameter(void) const  { return Diameter;      }
 
  FGTable* GetCThrustTable(void) const { return cThrust;}
  FGTable* GetCPowerTable(void)  const { return cPower; }
 
  FGTable* GetCtMachTable(void) const { return CtMach; }
  FGTable* GetCpMachTable(void) const { return CpMach; }
 
  double GetTorque(void) const  { return vTorque(eX); }
 
  double GetPowerRequired(void);
 
  double Calculate(double EnginePower);
  FGColumnVector3 GetPFactor(void) const;
  std::string GetThrusterLabels(int id, const std::string& delimeter);
  std::string GetThrusterValues(int id, const std::string& delimeter);
  void   SetReverseCoef (double c) { Reverse_coef = c; }
  double GetReverseCoef (void) const { return Reverse_coef; }
  void   SetReverse (bool r) { Reversed = r; }
  bool   GetReverse (void) const { return Reversed; }
  void   SetFeather (bool f) { Feathered = f; }
  bool   GetFeather (void) const { return Feathered; }
  double GetThrustCoefficient(void) const {return ThrustCoeff;}
  double GetHelicalTipMach(void) const {return HelicalTipMach;}
  int    GetConstantSpeed(void) const {return ConstantSpeed;}
  void   SetInducedVelocity(double Vi) {Vinduced = Vi;}
  double GetInducedVelocity(void) const {return Vinduced;}
 
private:
  int   numBlades;
  double J;
  double RPM;
  double Ixx;
  double Diameter;
  double MaxPitch;
  double MinPitch;
  double MinRPM;
  double MaxRPM;
  double Pitch;
  double P_Factor;
  double Sense, Sense_multiplier;
  double Advance;
  double ExcessTorque;
  double D4;
  double D5;
  double HelicalTipMach;
  double Vinduced;
  FGColumnVector3 vTorque;
  FGTable *cThrust;
  FGTable *cPower;
  FGTable *CtMach;
  FGTable *CpMach;
  double CtFactor;
  double CpFactor;
  int    ConstantSpeed;
  void Debug(int from);
  double ReversePitch; // Pitch, when fully reversed
  bool   Reversed;     // true, when propeller is reversed
  double Reverse_coef; // 0 - 1 defines AdvancePitch (0=MIN_PITCH 1=REVERSE_PITCH)
  bool   Feathered;    // true, if feather command
};
}
//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
#endif