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.10 2011/03/10 01:35:25 dpculp 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 void FGElectric::Calculate(void)
  87 {
  88   RunPreFunctions();
  89
  90   Throttle = FCS->GetThrottlePos(EngineNumber);
  91
  92   RPM = Thruster->GetRPM() * Thruster->GetGearRatio();
  93
  94   HP = PowerWatts * Throttle / hptowatts;
  95
  96   Thruster->Calculate(HP * hptoftlbssec);
  97
  98   RunPostFunctions();
  99 }
 100
 101 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 102
 103 double FGElectric::CalcFuelNeed(void)
 104 {
 105   return 0;
 106 }
 107
 108 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 109
 110 string FGElectric::GetEngineLabels(const string& delimiter)
 111 {
 112   std::ostringstream buf;
 113
 114   buf << Name << " HP (engine " << EngineNumber << ")" << delimiter
 115       << Thruster->GetThrusterLabels(EngineNumber, delimiter);
 116
 117   return buf.str();
 118 }
 119
 120 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 121
 122 string FGElectric::GetEngineValues(const string& delimiter)
 123 {
 124   std::ostringstream buf;
 125
 126   buf << HP << delimiter
 127      << Thruster->GetThrusterValues(EngineNumber, delimiter);
 128
 129   return buf.str();
 130 }
 131
 132 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 133 //
 134 //    The bitmasked value choices are as follows:
 135 //    unset: In this case (the default) JSBSim would only print
 136 //       out the normally expected messages, essentially echoing
 137 //       the config files as they are read. If the environment
 138 //       variable is not set, debug_lvl is set to 1 internally
 139 //    0: This requests JSBSim not to output any messages
 140 //       whatsoever.
 141 //    1: This value explicity requests the normal JSBSim
 142 //       startup messages
 143 //    2: This value asks for a message to be printed out when
 144 //       a class is instantiated
 145 //    4: When this value is set, a message is displayed when a
 146 //       FGModel object executes its Run() method
 147 //    8: When this value is set, various runtime state variables
 148 //       are printed out periodically
 149 //    16: When set various parameters are sanity checked and
 150 //       a message is printed out when they go out of bounds
 151
 152 void FGElectric::Debug(int from)
 153 {
 154   if (debug_lvl <= 0) return;
 155
 156   if (debug_lvl & 1) { // Standard console startup message output
 157     if (from == 0) { // Constructor
 158
 159       cout << "\n    Engine Name: "         << Name << endl;
 160       cout << "      Power Watts: "         << PowerWatts << endl;
 161
 162     }
 163   }
 164   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 165     if (from == 0) cout << "Instantiated: FGElectric" << endl;
 166     if (from == 1) cout << "Destroyed:    FGElectric" << endl;
 167   }
 168   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 169   }
 170   if (debug_lvl & 8 ) { // Runtime state variables
 171   }
 172   if (debug_lvl & 16) { // Sanity checking
 173   }
 174   if (debug_lvl & 64) {
 175     if (from == 0) { // Constructor
 176       cout << IdSrc << endl;
 177       cout << IdHdr << endl;
 178     }
 179   }
 180 }
 181
 182 } // namespace JSBSim