src/FDM/JSBSim/models/propulsion/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 Lesser 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 Lesser General Public License for more
  18  details.
  19
  20  You should have received a copy of the GNU Lesser 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 Lesser 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 01/06/2005  DPC  Converted to new XML format
  37
  38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  39 INCLUDES
  40 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  41
  42 #include "FGElectric.h"
  43 #include "models/FGPropulsion.h"
  44 #include "models/propulsion/FGThruster.h"
  45
  46 #include <iostream>
  47 #include <sstream>
  48
  49 using namespace std;
  50
  51 namespace JSBSim {
  52
  53 static const char *IdSrc = "$Id: FGElectric.cpp,v 1.8 2010/02/25 05:21:36 jberndt Exp $";
  54 static const char *IdHdr = ID_ELECTRIC;
  55
  56 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  57 CLASS IMPLEMENTATION
  58 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  59
  60 FGElectric::FGElectric(FGFDMExec* exec, Element *el, int engine_number)
  61   : FGEngine(exec, el, engine_number)
  62 {
  63   string token;
  64
  65   Type = etElectric;
  66   PowerWatts = 745.7;
  67   hptowatts = 745.7;
  68
  69   dt = FDMExec->GetDeltaT();
  70
  71   if (el->FindElement("power"))
  72     PowerWatts = el->FindElementValueAsNumberConvertTo("power","WATTS");
  73
  74   Debug(0); // Call Debug() routine from constructor if needed
  75 }
  76
  77 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  78
  79 FGElectric::~FGElectric()
  80 {
  81   Debug(1); // Call Debug() routine from constructor if needed
  82 }
  83
  84 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  85
  86 double FGElectric::Calculate(void)
  87 {
  88   Throttle = FCS->GetThrottlePos(EngineNumber);
  89
  90   RPM = Thruster->GetRPM() * Thruster->GetGearRatio();
  91
  92   HP = PowerWatts * Throttle / hptowatts;
  93
  94   PowerAvailable = (HP * hptoftlbssec) - Thruster->GetPowerRequired();
  95
  96   return Thruster->Calculate(PowerAvailable);
  97 }
  98
  99 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 100
 101 string FGElectric::GetEngineLabels(const string& delimiter)
 102 {
 103   std::ostringstream buf;
 104
 105   buf << Name << " HP (engine " << EngineNumber << ")" << delimiter
 106       << Thruster->GetThrusterLabels(EngineNumber, delimiter);
 107
 108   return buf.str();
 109 }
 110
 111 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 112
 113 string FGElectric::GetEngineValues(const string& delimiter)
 114 {
 115   std::ostringstream buf;
 116
 117   buf << HP << delimiter
 118      << Thruster->GetThrusterValues(EngineNumber, delimiter);
 119
 120   return buf.str();
 121 }
 122
 123 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 124 //
 125 //    The bitmasked value choices are as follows:
 126 //    unset: In this case (the default) JSBSim would only print
 127 //       out the normally expected messages, essentially echoing
 128 //       the config files as they are read. If the environment
 129 //       variable is not set, debug_lvl is set to 1 internally
 130 //    0: This requests JSBSim not to output any messages
 131 //       whatsoever.
 132 //    1: This value explicity requests the normal JSBSim
 133 //       startup messages
 134 //    2: This value asks for a message to be printed out when
 135 //       a class is instantiated
 136 //    4: When this value is set, a message is displayed when a
 137 //       FGModel object executes its Run() method
 138 //    8: When this value is set, various runtime state variables
 139 //       are printed out periodically
 140 //    16: When set various parameters are sanity checked and
 141 //       a message is printed out when they go out of bounds
 142
 143 void FGElectric::Debug(int from)
 144 {
 145   if (debug_lvl <= 0) return;
 146
 147   if (debug_lvl & 1) { // Standard console startup message output
 148     if (from == 0) { // Constructor
 149
 150       cout << "\n    Engine Name: "         << Name << endl;
 151       cout << "      Power Watts: "         << PowerWatts << endl;
 152
 153     }
 154   }
 155   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 156     if (from == 0) cout << "Instantiated: FGElectric" << endl;
 157     if (from == 1) cout << "Destroyed:    FGElectric" << endl;
 158   }
 159   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 160   }
 161   if (debug_lvl & 8 ) { // Runtime state variables
 162   }
 163   if (debug_lvl & 16) { // Sanity checking
 164   }
 165   if (debug_lvl & 64) {
 166     if (from == 0) { // Constructor
 167       cout << IdSrc << endl;
 168       cout << IdHdr << endl;
 169     }
 170   }
 171 }
 172
 173 double
 174 FGElectric::CalcFuelNeed(void)
 175 {
 176   return 0;
 177 }
 178
 179 } // namespace JSBSim