FGTransmission.h

/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 JSBSim
 Author:       Jon S. Berndt
 Date started: 08/24/00
 ------------- Copyright (C) 2000  Jon S. Berndt (jon@jsbsim.org) -------------
 
 Header:       FGTransmission.h
 Author:       T.Kreitler
 Date started: 02/05/12
 
 ------------- Copyright (C) 2012  T. Kreitler (t.kreitler@web.de) -------------
 
 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
--------------------------------------------------------------------------------
02/05/12  T.Kreitler  Created
 
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SENTRY
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
#ifndef FGTRANSMISSION_H
#define FGTRANSMISSION_H
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
INCLUDES
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
#include "FGJSBBase.h"
#include "FGFDMExec.h"
#include "input_output/FGPropertyManager.h"
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
FORWARD DECLARATIONS
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
namespace JSBSim {
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DOCUMENTATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DECLARATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
class FGTransmission : public FGJSBBase {
 
public:
  FGTransmission(FGFDMExec *exec, int num, double dt);
 
  ~FGTransmission();
 
  void Calculate(double EnginePower, double ThrusterTorque, double dt);
 
  void   SetMaxBrakePower(double x) {MaxBrakePower=x;}
  double GetMaxBrakePower() const {return MaxBrakePower;}
  void   SetEngineFriction(double x) {EngineFriction=x;}
  double GetEngineFriction() const {return EngineFriction;}
  void   SetEngineMoment(double x) {EngineMoment=x;}
  double GetEngineMoment() const {return EngineMoment;}
  void   SetThrusterMoment(double x) {ThrusterMoment=x;}
  double GetThrusterMoment() const {return ThrusterMoment;}
 
  double GetFreeWheelTransmission() const {return FreeWheelTransmission;}
  void   SetEngineRPM(double x) {EngineRPM=x;}
  double GetEngineRPM() {return EngineRPM;}
  void   SetThrusterRPM(double x) {ThrusterRPM=x;}
  double GetThrusterRPM() {return ThrusterRPM;}
 
  double GetBrakeCtrlNorm() const {return BrakeCtrlNorm;}
  void   SetBrakeCtrlNorm(double x) {BrakeCtrlNorm=x;}
  double GetClutchCtrlNorm() const {return ClutchCtrlNorm;}
  void   SetClutchCtrlNorm(double x) {ClutchCtrlNorm=x;}
 
private:
  bool BindModel(int num, FGPropertyManager* pm);
  void Debug(int from);
 
  inline double omega_to_rpm(double w) {
    return w * 9.54929658551372014613302580235; // omega/(2.0*PI) * 60.0
  }
  inline double rpm_to_omega(double r) {
    return r * 0.104719755119659774615421446109; // (rpm/60.0)*2.0*PI
  }
 
  Filter FreeWheelLag;
  double FreeWheelTransmission; // state, 0: free, 1:locked
 
  double ThrusterMoment;
  double EngineMoment;   // estimated MOI of gear and engine, influences acceleration
  double EngineFriction; // estimated friction in gear and possibly engine
 
  double ClutchCtrlNorm;
  double BrakeCtrlNorm;
  double MaxBrakePower;
 
  double EngineRPM;
  double ThrusterRPM;
};
}
//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
#endif