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