1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5 Date started: 04/07/2004
6 Purpose: This module models an electric motor
8 --------- Copyright (C) 2004 David Culp (davidculp2@comcast.net) -------------
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
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
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.
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.
27 FUNCTIONAL DESCRIPTION
28 --------------------------------------------------------------------------------
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
34 --------------------------------------------------------------------------------
35 04/07/2004 DPC Created
36 01/06/2005 DPC Converted to new XML format
38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
40 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
42 #include "FGElectric.h"
43 #include <models/FGPropulsion.h>
47 static const char *IdSrc = "$Id$";
48 static const char *IdHdr = ID_ELECTRIC;
50 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
52 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
54 FGElectric::FGElectric(FGFDMExec* exec, Element *el, int engine_number)
55 : FGEngine(exec, el, engine_number)
65 if (el->FindElement("power"))
66 PowerWatts = el->FindElementValueAsNumberConvertTo("power","WATTS");
68 Debug(0); // Call Debug() routine from constructor if needed
71 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
73 FGElectric::~FGElectric()
75 Debug(1); // Call Debug() routine from constructor if needed
78 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
80 double FGElectric::Calculate(void)
82 Throttle = FCS->GetThrottlePos(EngineNumber);
84 RPM = Thruster->GetRPM() * Thruster->GetGearRatio();
86 HP = PowerWatts * Throttle / hptowatts;
88 PowerAvailable = (HP * hptoftlbssec) - Thruster->GetPowerRequired();
90 return Thruster->Calculate(PowerAvailable);
93 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
95 string FGElectric::GetEngineLabels(string delimeter)
97 std::ostringstream buf;
99 buf << Name << " HP (engine " << EngineNumber << ")" << delimeter
100 << Thruster->GetThrusterLabels(EngineNumber, delimeter);
105 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
107 string FGElectric::GetEngineValues(string delimeter)
109 std::ostringstream buf;
111 buf << HP << delimeter
112 << Thruster->GetThrusterValues(EngineNumber, delimeter);
117 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
119 // The bitmasked value choices are as follows:
120 // unset: In this case (the default) JSBSim would only print
121 // out the normally expected messages, essentially echoing
122 // the config files as they are read. If the environment
123 // variable is not set, debug_lvl is set to 1 internally
124 // 0: This requests JSBSim not to output any messages
126 // 1: This value explicity requests the normal JSBSim
128 // 2: This value asks for a message to be printed out when
129 // a class is instantiated
130 // 4: When this value is set, a message is displayed when a
131 // FGModel object executes its Run() method
132 // 8: When this value is set, various runtime state variables
133 // are printed out periodically
134 // 16: When set various parameters are sanity checked and
135 // a message is printed out when they go out of bounds
137 void FGElectric::Debug(int from)
139 if (debug_lvl <= 0) return;
141 if (debug_lvl & 1) { // Standard console startup message output
142 if (from == 0) { // Constructor
144 cout << "\n Engine Name: " << Name << endl;
145 cout << " Power Watts: " << PowerWatts << endl;
149 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
150 if (from == 0) cout << "Instantiated: FGElectric" << endl;
151 if (from == 1) cout << "Destroyed: FGElectric" << endl;
153 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
155 if (debug_lvl & 8 ) { // Runtime state variables
157 if (debug_lvl & 16) { // Sanity checking
159 if (debug_lvl & 64) {
160 if (from == 0) { // Constructor
161 cout << IdSrc << endl;
162 cout << IdHdr << endl;
168 FGElectric::CalcFuelNeed(void)
173 } // namespace JSBSim