JSBSim Flight Dynamics Model  1.0 (02 March 2017)
An Open Source Flight Dynamics and Control Software Library in C++
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 Lesser 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 Lesser General Public License for more
18  details.
19 
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.
23 
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.
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 <iostream>
43 #include <sstream>
44 
45 #include "FGElectric.h"
46 #include "FGPropeller.h"
47 #include "input_output/FGXMLElement.h"
48 
49 using namespace std;
50 
51 namespace JSBSim {
52 
53 IDENT(IdSrc,"$Id: FGElectric.cpp,v 1.20 2015/09/27 09:54:21 bcoconni Exp $");
54 IDENT(IdHdr,ID_ELECTRIC);
55 
56 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
57 CLASS IMPLEMENTATION
58 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
59 
60 FGElectric::FGElectric(FGFDMExec* exec, Element *el, int engine_number, struct FGEngine::Inputs& input)
61  : FGEngine(engine_number, input)
62 {
63  Load(exec,el);
64 
65  Type = etElectric;
66  PowerWatts = 745.7;
67  hptowatts = 745.7;
68 
69  if (el->FindElement("power"))
70  PowerWatts = el->FindElementValueAsNumberConvertTo("power","WATTS");
71 
72  string base_property_name = CreateIndexedPropertyName("propulsion/engine",
73  EngineNumber);
74  exec->GetPropertyManager()->Tie(base_property_name + "/power-hp", &HP);
75 
76  Debug(0); // Call Debug() routine from constructor if needed
77 }
78 
79 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
80 
82 {
83  Debug(1); // Call Debug() routine from constructor if needed
84 }
85 
86 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
87 
89 {
90  RunPreFunctions();
91 
92  if (Thruster->GetType() == FGThruster::ttPropeller) {
93  ((FGPropeller*)Thruster)->SetAdvance(in.PropAdvance[EngineNumber]);
94  ((FGPropeller*)Thruster)->SetFeather(in.PropFeather[EngineNumber]);
95  }
96 
97  RPM = Thruster->GetRPM() * Thruster->GetGearRatio();
98 
99  HP = PowerWatts * in.ThrottlePos[EngineNumber] / hptowatts;
100 
101  LoadThrusterInputs();
102  Thruster->Calculate(HP * hptoftlbssec);
103 
104  RunPostFunctions();
105 }
106 
107 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
108 
109 double FGElectric::CalcFuelNeed(void)
110 {
111  return 0;
112 }
113 
114 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
115 
116 string FGElectric::GetEngineLabels(const string& delimiter)
117 {
118  std::ostringstream buf;
119 
120  buf << Name << " HP (engine " << EngineNumber << ")" << delimiter
121  << Thruster->GetThrusterLabels(EngineNumber, delimiter);
122 
123  return buf.str();
124 }
125 
126 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
127 
128 string FGElectric::GetEngineValues(const string& delimiter)
129 {
130  std::ostringstream buf;
131 
132  buf << HP << delimiter
133  << Thruster->GetThrusterValues(EngineNumber, delimiter);
134 
135  return buf.str();
136 }
137 
138 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
139 //
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
146 // whatsoever.
147 // 1: This value explicity requests the normal JSBSim
148 // startup messages
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
157 
158 void FGElectric::Debug(int from)
159 {
160  if (debug_lvl <= 0) return;
161 
162  if (debug_lvl & 1) { // Standard console startup message output
163  if (from == 0) { // Constructor
164 
165  cout << "\n Engine Name: " << Name << endl;
166  cout << " Power Watts: " << PowerWatts << endl;
167 
168  }
169  }
170  if (debug_lvl & 2 ) { // Instantiation/Destruction notification
171  if (from == 0) cout << "Instantiated: FGElectric" << endl;
172  if (from == 1) cout << "Destroyed: FGElectric" << endl;
173  }
174  if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
175  }
176  if (debug_lvl & 8 ) { // Runtime state variables
177  }
178  if (debug_lvl & 16) { // Sanity checking
179  }
180  if (debug_lvl & 64) {
181  if (from == 0) { // Constructor
182  cout << IdSrc << endl;
183  cout << IdHdr << endl;
184  }
185  }
186 }
187 
188 } // namespace JSBSim
double FindElementValueAsNumberConvertTo(const std::string &el, const std::string &target_units)
Searches for the named element and converts and returns the data belonging to it. ...
STL namespace.
FGPropeller models a propeller given the tabular data for Ct (thrust) and Cp (power), indexed by the advance ratio "J".
Definition: FGPropeller.h:170
Element * FindElement(const std::string &el="")
Searches for a specified element.
FGPropertyManager * GetPropertyManager(void)
Returns a pointer to the property manager object.
Definition: FGFDMExec.cpp:1099
void Tie(const std::string &name, bool *pointer, bool useDefault=true)
Tie a property to an external bool variable.
void Calculate(void)
Calculates the thrust of the engine, and other engine functions.
Definition: FGElectric.cpp:88
Base class for all engines.
Definition: FGEngine.h:121
Encapsulates the JSBSim simulation executive.
Definition: FGFDMExec.h:189
~FGElectric()
Destructor.
Definition: FGElectric.cpp:81