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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
45 #include "FGElectric.h"
46 #include "FGPropeller.h"
52 static const char *IdSrc = "$Id: FGElectric.cpp,v 1.13 2011/08/03 03:21:06 jberndt Exp $";
53 static const char *IdHdr = ID_ELECTRIC;
55 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
57 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
59 FGElectric::FGElectric(FGFDMExec* exec, Element *el, int engine_number, struct FGEngine::Inputs& input)
60 : FGEngine(exec, el, engine_number, input)
68 if (el->FindElement("power"))
69 PowerWatts = el->FindElementValueAsNumberConvertTo("power","WATTS");
71 string property_name, base_property_name;
72 base_property_name = CreateIndexedPropertyName("propulsion/engine", EngineNumber);
73 property_name = base_property_name + "/power-hp";
74 PropertyManager->Tie(property_name, &HP);
76 Debug(0); // Call Debug() routine from constructor if needed
79 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
81 FGElectric::~FGElectric()
83 Debug(1); // Call Debug() routine from constructor if needed
86 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
88 void FGElectric::Calculate(void)
92 if (Thruster->GetType() == FGThruster::ttPropeller) {
93 ((FGPropeller*)Thruster)->SetAdvance(in.PropAdvance[EngineNumber]);
94 ((FGPropeller*)Thruster)->SetFeather(in.PropFeather[EngineNumber]);
97 RPM = Thruster->GetRPM() * Thruster->GetGearRatio();
99 HP = PowerWatts * in.ThrottlePos[EngineNumber] / hptowatts;
101 LoadThrusterInputs();
102 Thruster->Calculate(HP * hptoftlbssec);
107 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
109 double FGElectric::CalcFuelNeed(void)
114 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
116 string FGElectric::GetEngineLabels(const string& delimiter)
118 std::ostringstream buf;
120 buf << Name << " HP (engine " << EngineNumber << ")" << delimiter
121 << Thruster->GetThrusterLabels(EngineNumber, delimiter);
126 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
128 string FGElectric::GetEngineValues(const string& delimiter)
130 std::ostringstream buf;
132 buf << HP << delimiter
133 << Thruster->GetThrusterValues(EngineNumber, delimiter);
138 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
140 // The bitmasked value choices are as follows:
141 // unset: In this case (the default) JSBSim would only print
142 // out the normally expected messages, essentially echoing
143 // the config files as they are read. If the environment
144 // variable is not set, debug_lvl is set to 1 internally
145 // 0: This requests JSBSim not to output any messages
147 // 1: This value explicity requests the normal JSBSim
149 // 2: This value asks for a message to be printed out when
150 // a class is instantiated
151 // 4: When this value is set, a message is displayed when a
152 // FGModel object executes its Run() method
153 // 8: When this value is set, various runtime state variables
154 // are printed out periodically
155 // 16: When set various parameters are sanity checked and
156 // a message is printed out when they go out of bounds
158 void FGElectric::Debug(int from)
160 if (debug_lvl <= 0) return;
162 if (debug_lvl & 1) { // Standard console startup message output
163 if (from == 0) { // Constructor
165 cout << "\n Engine Name: " << Name << endl;
166 cout << " Power Watts: " << PowerWatts << endl;
170 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
171 if (from == 0) cout << "Instantiated: FGElectric" << endl;
172 if (from == 1) cout << "Destroyed: FGElectric" << endl;
174 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
176 if (debug_lvl & 8 ) { // Runtime state variables
178 if (debug_lvl & 16) { // Sanity checking
180 if (debug_lvl & 64) {
181 if (from == 0) { // Constructor
182 cout << IdSrc << endl;
183 cout << IdHdr << endl;
188 } // namespace JSBSim