src/FDM/JSBSim/FGElectric.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGElectric.cpp
   4  Author:       David Culp
   5  Date started: 04/07/2004
   6  Purpose:      This module models an electric motor
   7
   8  --------- Copyright (C) 2004  David Culp (davidculp2@comcast.net) -------------
   9
  10  This program is free software; you can redistribute it and/or modify it under
  11  the terms of the GNU General Public License as published by the Free Software
  12  Foundation; either version 2 of the License, or (at your option) any later
  13  version.
  14
  15  This program is distributed in the hope that it will be useful, but WITHOUT
  16  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  18  details.
  19
  20  You should have received a copy of the GNU General Public License along with
  21  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  22  Place - Suite 330, Boston, MA  02111-1307, USA.
  23
  24  Further information about the GNU General Public License can also be found on
  25  the world wide web at http://www.gnu.org.
  26
  27 FUNCTIONAL DESCRIPTION
  28 --------------------------------------------------------------------------------
  29
  30 This class descends from the FGEngine class and models an electric motor based on
  31 parameters given in the engine config file for this class
  32
  33 HISTORY
  34 --------------------------------------------------------------------------------
  35 04/07/2004  DPC  Created
  36
  37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #include "FGElectric.h"
  42 #include "FGPropulsion.h"
  43
  44 namespace JSBSim {
  45
  46 static const char *IdSrc = "$Id$";
  47 static const char *IdHdr = ID_ELECTRIC;
  48
  49 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  50 CLASS IMPLEMENTATION
  51 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  52
  53 FGElectric::FGElectric(FGFDMExec* exec, FGConfigFile* Eng_cfg, int engine_number)
  54   : FGEngine(exec, engine_number)
  55 {
  56   string token;
  57
  58   Type = etElectric;
  59   PowerWatts = 745.7;
  60   hptowatts = 745.7;
  61
  62   dt = State->Getdt();
  63
  64   Name = Eng_cfg->GetValue("NAME");
  65   Eng_cfg->GetNextConfigLine();
  66   while (Eng_cfg->GetValue() != string("/FG_ELECTRIC")) {
  67     *Eng_cfg >> token;
  68     if      (token == "POWER_WATTS") *Eng_cfg >> PowerWatts;
  69     else cerr << "Unhandled token in Engine config file: " << token << endl;
  70   }
  71
  72   Debug(0); // Call Debug() routine from constructor if needed
  73 }
  74
  75 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  76
  77 FGElectric::~FGElectric()
  78 {
  79   Debug(1); // Call Debug() routine from constructor if needed
  80 }
  81
  82 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  83
  84 double FGElectric::Calculate(void)
  85 {
  86   Throttle = FCS->GetThrottlePos(EngineNumber);
  87
  88   RPM = Thruster->GetRPM() * Thruster->GetGearRatio();
  89
  90   HP = PowerWatts * Throttle / hptowatts;
  91
  92   PowerAvailable = (HP * hptoftlbssec) - Thruster->GetPowerRequired();
  93
  94   return Thrust = Thruster->Calculate(PowerAvailable);
  95 }
  96
  97 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  98
  99 string FGElectric::GetEngineLabels(string delimeter)
 100 {
 101   return ""; // currently no labels are returned for this engine
 102 }
 103
 104 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 105
 106 string FGElectric::GetEngineValues(string delimeter)
 107 {
 108   return ""; // currently no values are returned for this engine
 109 }
 110
 111 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 112 //
 113 //    The bitmasked value choices are as follows:
 114 //    unset: In this case (the default) JSBSim would only print
 115 //       out the normally expected messages, essentially echoing
 116 //       the config files as they are read. If the environment
 117 //       variable is not set, debug_lvl is set to 1 internally
 118 //    0: This requests JSBSim not to output any messages
 119 //       whatsoever.
 120 //    1: This value explicity requests the normal JSBSim
 121 //       startup messages
 122 //    2: This value asks for a message to be printed out when
 123 //       a class is instantiated
 124 //    4: When this value is set, a message is displayed when a
 125 //       FGModel object executes its Run() method
 126 //    8: When this value is set, various runtime state variables
 127 //       are printed out periodically
 128 //    16: When set various parameters are sanity checked and
 129 //       a message is printed out when they go out of bounds
 130
 131 void FGElectric::Debug(int from)
 132 {
 133   if (debug_lvl <= 0) return;
 134
 135   if (debug_lvl & 1) { // Standard console startup message output
 136     if (from == 0) { // Constructor
 137
 138       cout << "\n    Engine Name: "         << Name << endl;
 139       cout << "      Power Watts: "         << PowerWatts << endl;
 140
 141     }
 142   }
 143   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 144     if (from == 0) cout << "Instantiated: FGElectric" << endl;
 145     if (from == 1) cout << "Destroyed:    FGElectric" << endl;
 146   }
 147   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 148   }
 149   if (debug_lvl & 8 ) { // Runtime state variables
 150   }
 151   if (debug_lvl & 16) { // Sanity checking
 152   }
 153   if (debug_lvl & 64) {
 154     if (from == 0) { // Constructor
 155       cout << IdSrc << endl;
 156       cout << IdHdr << endl;
 157     }
 158   }
 159 }
 160
 161 double
 162 FGElectric::CalcFuelNeed(void)
 163 {
 164   return 0;
 165 }
 166
 167 } // namespace JSBSim