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"
44 #include "models/propulsion/FGThruster.h"
45 #include "FGPropeller.h"
54 static const char *IdSrc = "$Id: FGElectric.cpp,v 1.11 2011/06/06 22:35:08 jentron Exp $";
55 static const char *IdHdr = ID_ELECTRIC;
57 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
59 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
61 FGElectric::FGElectric(FGFDMExec* exec, Element *el, int engine_number)
62 : FGEngine(exec, el, engine_number)
70 dt = FDMExec->GetDeltaT();
72 if (el->FindElement("power"))
73 PowerWatts = el->FindElementValueAsNumberConvertTo("power","WATTS");
75 string property_name, base_property_name;
76 base_property_name = CreateIndexedPropertyName("propulsion/engine", EngineNumber);
77 property_name = base_property_name + "/power-hp";
78 PropertyManager->Tie(property_name, &HP);
80 Debug(0); // Call Debug() routine from constructor if needed
83 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
85 FGElectric::~FGElectric()
87 Debug(1); // Call Debug() routine from constructor if needed
90 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
92 void FGElectric::Calculate(void)
96 Throttle = FCS->GetThrottlePos(EngineNumber);
98 if (Thruster->GetType() == FGThruster::ttPropeller) {
99 ((FGPropeller*)Thruster)->SetAdvance(FCS->GetPropAdvance(EngineNumber));
100 ((FGPropeller*)Thruster)->SetFeather(FCS->GetPropFeather(EngineNumber));
103 RPM = Thruster->GetRPM() * Thruster->GetGearRatio();
105 HP = PowerWatts * Throttle / hptowatts;
107 Thruster->Calculate(HP * hptoftlbssec);
112 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
114 double FGElectric::CalcFuelNeed(void)
119 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
121 string FGElectric::GetEngineLabels(const string& delimiter)
123 std::ostringstream buf;
125 buf << Name << " HP (engine " << EngineNumber << ")" << delimiter
126 << Thruster->GetThrusterLabels(EngineNumber, delimiter);
131 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
133 string FGElectric::GetEngineValues(const string& delimiter)
135 std::ostringstream buf;
137 buf << HP << delimiter
138 << Thruster->GetThrusterValues(EngineNumber, delimiter);
143 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
145 // The bitmasked value choices are as follows:
146 // unset: In this case (the default) JSBSim would only print
147 // out the normally expected messages, essentially echoing
148 // the config files as they are read. If the environment
149 // variable is not set, debug_lvl is set to 1 internally
150 // 0: This requests JSBSim not to output any messages
152 // 1: This value explicity requests the normal JSBSim
154 // 2: This value asks for a message to be printed out when
155 // a class is instantiated
156 // 4: When this value is set, a message is displayed when a
157 // FGModel object executes its Run() method
158 // 8: When this value is set, various runtime state variables
159 // are printed out periodically
160 // 16: When set various parameters are sanity checked and
161 // a message is printed out when they go out of bounds
163 void FGElectric::Debug(int from)
165 if (debug_lvl <= 0) return;
167 if (debug_lvl & 1) { // Standard console startup message output
168 if (from == 0) { // Constructor
170 cout << "\n Engine Name: " << Name << endl;
171 cout << " Power Watts: " << PowerWatts << endl;
175 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
176 if (from == 0) cout << "Instantiated: FGElectric" << endl;
177 if (from == 1) cout << "Destroyed: FGElectric" << endl;
179 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
181 if (debug_lvl & 8 ) { // Runtime state variables
183 if (debug_lvl & 16) { // Sanity checking
185 if (debug_lvl & 64) {
186 if (from == 0) { // Constructor
187 cout << IdSrc << endl;
188 cout << IdHdr << endl;
193 } // namespace JSBSim