FGTurbine.h

/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 Header:       FGTurbine.h
 Author:       David Culp
 Date started: 03/11/2003
 
 ------------- Copyright (C) 2003  David Culp (daveculp@cox.net)----------
 
 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
--------------------------------------------------------------------------------
03/11/2003  DPC  Created, based on FGTurbine
09/22/2003  DPC  Added starting, stopping, new framework
04/29/2004  DPC  Renamed from FGSimTurbine to FGTurbine
 
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SENTRY
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
#ifndef FGTURBINE_H
#define FGTURBINE_H
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
INCLUDES
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
#include "FGEngine.h"
 
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
FORWARD DECLARATIONS
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
namespace JSBSim {
 
class FGFunction;
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DOCUMENTATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DECLARATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
class FGTurbine : public FGEngine
{
public:
  FGTurbine(FGFDMExec* Executive, Element *el, int engine_number, struct Inputs& input);
 
  enum phaseType { tpOff, tpRun, tpSpinUp, tpStart, tpStall, tpSeize, tpTrim };
 
  void Calculate(void);
  double CalcFuelNeed(void);
  double GetPowerAvailable(void);
  double Seek(double* var, double target, double accel, double decel);
 
  phaseType GetPhase(void) { return phase; }
 
  bool GetOvertemp(void)  const {return Overtemp; }
  bool GetInjection(void) const {return Injection;}
  bool GetFire(void) const { return Fire; }
  bool GetAugmentation(void) const {return Augmentation;}
  bool GetReversed(void) const { return Reversed; }
  bool GetCutoff(void) const { return Cutoff; }
  int GetIgnition(void) const {return Ignition;}
 
  double GetInlet(void) const { return InletPosition; }
  double GetNozzle(void) const { return NozzlePosition; }
  double GetBleedDemand(void) const {return BleedDemand;}
  double GetN1(void) const {return N1;}
  double GetN2(void) const {return N2;}
  double GetEPR(void) const {return EPR;}
  double GetEGT(void) const {return EGT_degC;}
 
  double GetMaxN1(void) const {return MaxN1;}
  double GetMaxN2(void) const {return MaxN2;}
  double getOilPressure_psi () const {return OilPressure_psi;}
  double getOilTemp_degF (void) {return KelvinToFahrenheit(OilTemp_degK);}
  double GetInjectionTimer(void) const {return InjectionTimer;}
  double GetInjWaterNorm(void) const {return InjWaterNorm;}
  double GetInjN1increment(void) const {return InjN1increment;}
  double GetInjN2increment(void) const {return InjN2increment;}
 
  void SetInjection(bool injection) {Injection = injection;}
  void SetIgnition(int ignition) {Ignition = ignition;}
  void SetAugmentation(bool augmentation) {Augmentation = augmentation;}
  void SetPhase( phaseType p ) { phase = p; }
  void SetEPR(double epr) {EPR = epr;}
  void SetBleedDemand(double bleedDemand) {BleedDemand = bleedDemand;}
  void SetReverse(bool reversed) { Reversed = reversed; }
  void SetCutoff(bool cutoff) { Cutoff = cutoff; }
  void SetMaxN1(double maxn1) {MaxN1 = maxn1;}
  void SetMaxN2(double maxn2) {MaxN2 = maxn2;}
  void SetInjectionTimer(double injtimer) {InjectionTimer = injtimer;}
  void SetInjWaterNorm(double injwater) {InjWaterNorm = injwater;}
  void SetInjN1increment(double injN1inc) {InjN1increment = injN1inc;}
  void SetInjN2increment(double injN2inc) {InjN2increment = injN2inc;}
 
  int InitRunning(void);
  void ResetToIC(void);
 
  std::string GetEngineLabels(const std::string& delimiter);
  std::string GetEngineValues(const std::string& delimiter);
 
private:
 
  phaseType phase;         
  double MilThrust;        
  double MaxThrust;        
  double BypassRatio;      
  std::unique_ptr<FGParameter> TSFC;   
  std::unique_ptr<FGParameter> ATSFC;  
  double IdleN1;           
  double IdleN2;           
  double IgnitionN1;       
  double IgnitionN2;       
  double N1;               
  double N2;               
  double N2norm;           
  double MaxN1;            
  double MaxN2;            
  double IdleFF;           
  double N1_factor;        
  double N2_factor;        
  double ThrottlePos;      
  double AugmentCmd;       
  double N1_spinup;        
  double N2_spinup;        
  double N1_start_rate;    
  double N2_start_rate;    
  double N1_spindown;      
  double N2_spindown;      
  bool Stalled;            
  bool Seized;             
  bool Overtemp;           
  bool Fire;               
  bool Injection;
  bool Augmentation;
  bool Reversed;
  bool Cutoff;
  bool disableWindmill;    
  int Injected;            
  int Ignition;
  int Augmented;           
  int AugMethod;           
  double EGT_degC;
  double EPR;
  double OilPressure_psi;
  double OilTemp_degK;
  double BleedDemand;
  double InletPosition;
  double NozzlePosition;
  double correctedTSFC;
  double InjectionTimer;
  double InjectionTime;
  double InjWaterNorm;
  double InjN1increment;
  double InjN2increment;
 
  double Off(void);
  double Run();
  double SpinUp(void);
  double Start(void);
  double Stall(void);
  double Seize(void);
  double Trim();
 
  std::shared_ptr<FGFunction> IdleThrustLookup;
  std::shared_ptr<FGFunction> MilThrustLookup;
  std::shared_ptr<FGFunction> MaxThrustLookup;
  std::shared_ptr<FGFunction> InjectionLookup;
  FGFDMExec *FDMExec;
  std::shared_ptr<FGParameter> N1SpoolUp;
  std::shared_ptr<FGParameter> N1SpoolDown;
  std::shared_ptr<FGParameter> N2SpoolUp;
  std::shared_ptr<FGParameter> N2SpoolDown;
 
  bool Load(FGFDMExec *exec, Element *el);
  void bindmodel(FGPropertyManager* pm);
  void Debug(int from);
 
  friend class FGSpoolUp;
  friend class FGSimplifiedTSFC;
};
 
class FGSpoolUp : public FGParameter
{
public:
  FGSpoolUp(FGTurbine* _turb, double BPR, double factor)
    : turb(_turb), delay(factor * 90.0 / (BPR + 3.0)) {}
  std::string GetName(void) const { return std::string(); };
  double GetValue(void) const {
    // adjust acceleration for N2 and atmospheric density
    double n = std::min(1.0, turb->N2norm + 0.1);
    return delay / (1 + 3 * (1-n)*(1-n)*(1-n) + (1 - turb->in.DensityRatio));
  }
private:
  FGTurbine* turb;
  double delay; 
};
 
class FGSimplifiedTSFC : public FGParameter
{
public:
  FGSimplifiedTSFC(FGTurbine* _turb, double tsfcVal)
    : turb(_turb), tsfc(tsfcVal) {}
 
  std::string GetName(void) const { return std::string(); }
 
  double GetValue(void) const {
    // Correction/denormalisation for temp and thrust
      double T = turb->in.Temperature;
      double N2norm = turb->N2norm;
      return tsfc * sqrt(T / 389.7) * (0.84 + (1 - N2norm) * (1 - N2norm));
  }
 
private:
  FGTurbine* turb;
  double tsfc;
};
 
}
//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
#endif