src/FDM/JSBSim/models/propulsion/FGTransmission.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  JSBSim
   4  Author:       Jon S. Berndt
   5  Date started: 08/24/00
   6  ------------- Copyright (C) 2000  Jon S. Berndt (jon@jsbsim.org) -------------
   7
   8  Module:       FGTransmission.cpp
   9  Author:       T.Kreitler
  10  Date started: 02/05/12
  11
  12  ------------- Copyright (C) 2012  T. Kreitler (t.kreitler@web.de) -------------
  13
  14  This program is free software; you can redistribute it and/or modify it under
  15  the terms of the GNU Lesser General Public License as published by the Free Software
  16  Foundation; either version 2 of the License, or (at your option) any later
  17  version.
  18
  19  This program is distributed in the hope that it will be useful, but WITHOUT
  20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  21  FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
  22  details.
  23
  24  You should have received a copy of the GNU Lesser General Public License along with
  25  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  26  Place - Suite 330, Boston, MA  02111-1307, USA.
  27
  28  Further information about the GNU Lesser General Public License can also be found on
  29  the world wide web at http://www.gnu.org.
  30
  31 FUNCTIONAL DESCRIPTION
  32 --------------------------------------------------------------------------------
  33
  34 HISTORY
  35 --------------------------------------------------------------------------------
  36 02/05/12  T.Kreitler  Created
  37
  38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  39 INCLUDES
  40 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  41
  42
  43 #include "FGTransmission.h"
  44
  45 using std::cout;
  46 using std::endl;
  47
  48 namespace JSBSim {
  49
  50 static const char *IdSrc = "$Id: FGTransmission.cpp,v 1.1 2012/02/25 14:37:02 jentron Exp $";
  51 static const char *IdHdr = ID_TRANSMISSION;
  52
  53 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  54 CLASS IMPLEMENTATION
  55 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  56
  57 FGTransmission::FGTransmission(FGFDMExec *exec, int num, double dt) :
  58   FreeWheelTransmission(1.0),
  59   ThrusterMoment(1.0), EngineMoment(1.0), EngineFriction(0.0),
  60   ClutchCtrlNorm(1.0), BrakeCtrlNorm(0.0), MaxBrakePower(0.0),
  61   EngineRPM(0.0), ThrusterRPM(0.0)
  62 {
  63   PropertyManager = exec->GetPropertyManager();
  64   FreeWheelLag = Filter(200.0,dt); // avoid too abrupt changes in transmission
  65   BindModel(num);
  66 }
  67
  68 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  69
  70 FGTransmission::~FGTransmission(){
  71 }
  72
  73 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  74
  75 // basically P = Q*w and Q_Engine + (-Q_Rotor) = J * dw/dt, J = Moment
  76 //
  77 void FGTransmission::Calculate(double EnginePower, double ThrusterTorque, double dt) {
  78
  79   double coupling = 1.0, coupling_sq = 1.0;
  80   double fw_mult = 1.0;
  81
  82   double d_omega = 0.0, engine_d_omega = 0.0, thruster_d_omega = 0.0; // relative changes
  83
  84   double engine_omega = rpm_to_omega(EngineRPM);
  85   double safe_engine_omega = engine_omega < 1e-1 ? 1e-1 : engine_omega;
  86   double engine_torque = EnginePower / safe_engine_omega;
  87
  88   double thruster_omega = rpm_to_omega(ThrusterRPM);
  89   double safe_thruster_omega = thruster_omega < 1e-1 ? 1e-1 : thruster_omega;
  90
  91   engine_torque  -= EngineFriction / safe_engine_omega;
  92   ThrusterTorque += Constrain(0.0, BrakeCtrlNorm, 1.0) * MaxBrakePower / safe_thruster_omega;
  93
  94   // would the FWU release ?
  95   engine_d_omega = engine_torque/EngineMoment * dt;
  96   thruster_d_omega =  - ThrusterTorque/ThrusterMoment * dt;
  97
  98   if ( thruster_omega+thruster_d_omega > engine_omega+engine_d_omega ) {
  99     // don't drive the engine
 100     FreeWheelTransmission = 0.0;
 101   } else {
 102     FreeWheelTransmission = 1.0;
 103   }
 104
 105   fw_mult = FreeWheelLag.execute(FreeWheelTransmission);
 106   coupling = fw_mult * Constrain(0.0, ClutchCtrlNorm, 1.0);
 107
 108   if (coupling < 0.999999) { // are the separate calculations needed ?
 109     // assume linear transfer
 110     engine_d_omega   =
 111        (engine_torque - ThrusterTorque*coupling)/(ThrusterMoment*coupling + EngineMoment) * dt;
 112     thruster_d_omega =
 113        (engine_torque*coupling - ThrusterTorque)/(ThrusterMoment + EngineMoment*coupling) * dt;
 114
 115     EngineRPM += omega_to_rpm(engine_d_omega);
 116     ThrusterRPM += omega_to_rpm(thruster_d_omega);
 117
 118     // simulate transit to static friction
 119     coupling_sq = coupling*coupling;
 120     EngineRPM   = (1.0-coupling_sq) * EngineRPM    + coupling_sq * 0.02 * (49.0*EngineRPM + ThrusterRPM);
 121     ThrusterRPM = (1.0-coupling_sq) * ThrusterRPM  + coupling_sq * 0.02 * (EngineRPM + 49.0*ThrusterRPM);
 122
 123     // enforce equal rpm
 124     if ( fabs(EngineRPM-ThrusterRPM) < 1e-3 ) {
 125       EngineRPM = ThrusterRPM = 0.5 * (EngineRPM+ThrusterRPM);
 126     }
 127   } else {
 128     d_omega = (engine_torque - ThrusterTorque)/(ThrusterMoment + EngineMoment) * dt;
 129     EngineRPM = ThrusterRPM += omega_to_rpm(d_omega);
 130   }
 131
 132   // nothing will turn backward
 133   if (EngineRPM < 0.0 ) EngineRPM = 0.0;
 134   if (ThrusterRPM < 0.0 ) ThrusterRPM = 0.0;
 135
 136 }
 137
 138 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 139
 140 bool FGTransmission::BindModel(int num)
 141 {
 142   string property_name, base_property_name;
 143   base_property_name = CreateIndexedPropertyName("propulsion/engine", num);
 144
 145   property_name = base_property_name + "/brake-ctrl-norm";
 146   PropertyManager->Tie( property_name.c_str(), this,
 147       &FGTransmission::GetBrakeCtrlNorm, &FGTransmission::SetBrakeCtrlNorm);
 148
 149   property_name = base_property_name + "/clutch-ctrl-norm";
 150   PropertyManager->Tie( property_name.c_str(), this,
 151       &FGTransmission::GetClutchCtrlNorm, &FGTransmission::SetClutchCtrlNorm);
 152
 153   property_name = base_property_name + "/free-wheel-transmission";
 154   PropertyManager->Tie( property_name.c_str(), this,
 155       &FGTransmission::GetFreeWheelTransmission);
 156
 157   return true;
 158 }
 159
 160 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 161 //    The bitmasked value choices are as follows:
 162 //    unset: In this case (the default) JSBSim would only print
 163 //       out the normally expected messages, essentially echoing
 164 //       the config files as they are read. If the environment
 165 //       variable is not set, debug_lvl is set to 1 internally
 166 //    0: This requests JSBSim not to output any messages
 167 //       whatsoever.
 168 //    1: This value explicity requests the normal JSBSim
 169 //       startup messages
 170 //    2: This value asks for a message to be printed out when
 171 //       a class is instantiated
 172 //    4: When this value is set, a message is displayed when a
 173 //       FGModel object executes its Run() method
 174 //    8: When this value is set, various runtime state variables
 175 //       are printed out periodically
 176 //    16: When set various parameters are sanity checked and
 177 //       a message is printed out when they go out of bounds
 178
 179 void FGTransmission::Debug(int from)
 180 {
 181   if (debug_lvl <= 0) return;
 182
 183   if (debug_lvl & 1) { // Standard console startup message output
 184     if (from == 0) { // Constructor
 185     }
 186   }
 187   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 188     if (from == 0) cout << "Instantiated: FGTransmission" << endl;
 189     if (from == 1) cout << "Destroyed:    FGTransmission" << endl;
 190   }
 191   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 192   }
 193   if (debug_lvl & 8 ) { // Runtime state variables
 194   }
 195   if (debug_lvl & 16) { // Sanity checking
 196   }
 197   if (debug_lvl & 64) {
 198     if (from == 0) { // Constructor
 199       cout << IdSrc << endl;
 200       cout << IdHdr << endl;
 201     }
 202   }
 203 }
 204
 205 }
 206