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