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