JSBSim Flight Dynamics Model 1.2.3 (07 Jun 2025)
An Open Source Flight Dynamics and Control Software Library in C++
Loading...
Searching...
No Matches
Public Member Functions | List of all members
FGBrushLessDCMotor Class Reference

Detailed Description

Definition at line 81 of file FGBrushLessDCMotor.h.

+ Inheritance diagram for FGBrushLessDCMotor:
+ Collaboration diagram for FGBrushLessDCMotor:

Public Member Functions

 FGBrushLessDCMotor (FGFDMExec *exec, Element *el, int engine_number, FGEngine::Inputs &input)
 Constructor.
 
 ~FGBrushLessDCMotor ()
 Destructor.
 
double CalcFuelNeed (void)
 The fuel need is calculated based on power levels and flow rate for that power level.
 
void Calculate (void)
 Calculates the thrust of the engine, and other engine functions.
 
std::string GetEngineLabels (const std::string &delimiter)
 
std::string GetEngineValues (const std::string &delimiter)
 
double GetPowerAvailable (void) const
 
- Public Member Functions inherited from FGEngine
 FGEngine (int engine_number, struct Inputs &input)
 
virtual double CalcOxidizerNeed (void)
 
virtual const FGColumnVector3 & GetBodyForces (void)
 
virtual bool GetCranking (void) const
 
virtual double getFuelFlow_gph () const
 
virtual double getFuelFlow_pph () const
 
virtual double GetFuelFlowRate (void) const
 
virtual double GetFuelFlowRateGPH (void) const
 
virtual double GetFuelUsedLbs (void) const
 
virtual const FGColumnVector3 & GetMoments (void)
 
virtual const std::string & GetName (void) const
 
size_t GetNumSourceTanks () const
 
virtual bool GetRunning (void) const
 
unsigned int GetSourceTank (unsigned int i) const
 
virtual bool GetStarter (void) const
 
virtual bool GetStarved (void) const
 
virtual double GetThrottleMax (void) const
 
virtual double GetThrottleMin (void) const
 
virtual double GetThrust (void) const
 
FGThruster * GetThruster (void) const
 
EngineType GetType (void) const
 
virtual int InitRunning (void)
 
void LoadThruster (FGFDMExec *exec, Element *el)
 
void LoadThrusterInputs ()
 
virtual void ResetToIC (void)
 Resets the Engine parameters to the initial conditions.
 
virtual void SetFuelDensity (double d)
 
virtual void SetFuelFreeze (bool f)
 
virtual void SetName (const std::string &name)
 
virtual void SetRunning (bool bb)
 
virtual void SetStarter (bool s)
 
virtual void SetStarved (bool tt)
 
virtual void SetStarved (void)
 
- Public Member Functions inherited from FGModelFunctions
std::string GetFunctionStrings (const std::string &delimeter) const
 Gets the strings for the current set of functions.
 
std::string GetFunctionValues (const std::string &delimeter) const
 Gets the function values.
 
std::shared_ptr< FGFunction > GetPreFunction (const std::string &name)
 Get one of the "pre" function.
 
bool Load (Element *el, FGFDMExec *fdmex, std::string prefix="")
 
void PostLoad (Element *el, FGFDMExec *fdmex, std::string prefix="")
 
void PreLoad (Element *el, FGFDMExec *fdmex, std::string prefix="")
 
void RunPostFunctions (void)
 
void RunPreFunctions (void)
 
- Public Member Functions inherited from FGJSBBase
 FGJSBBase ()
 Constructor for FGJSBBase.
 
virtual ~FGJSBBase ()
 Destructor for FGJSBBase.
 
void disableHighLighting (void)
 Disables highlighting in the console output.
 

Additional Inherited Members

- Public Types inherited from FGEngine
enum  EngineType {
  etUnknown , etRocket , etPiston , etTurbine ,
  etTurboprop , etElectric
}
 
- Public Types inherited from FGJSBBase
enum  { eL = 1 , eM , eN }
 Moments L, M, N. More...
 
enum  { eP = 1 , eQ , eR }
 Rates P, Q, R. More...
 
enum  { eU = 1 , eV , eW }
 Velocities U, V, W. More...
 
enum  { eX = 1 , eY , eZ }
 Positions X, Y, Z. More...
 
enum  { ePhi = 1 , eTht , ePsi }
 Euler angles Phi, Theta, Psi. More...
 
enum  { eDrag = 1 , eSide , eLift }
 Stability axis forces, Drag, Side force, Lift. More...
 
enum  { eRoll = 1 , ePitch , eYaw }
 Local frame orientation Roll, Pitch, Yaw. More...
 
enum  { eNorth = 1 , eEast , eDown }
 Local frame position North, East, Down. More...
 
enum  { eLat = 1 , eLong , eRad }
 Locations Radius, Latitude, Longitude. More...
 
enum  {
  inNone = 0 , inDegrees , inRadians , inMeters ,
  inFeet
}
 Conversion specifiers. More...
 
- Static Public Member Functions inherited from FGJSBBase
static const std::string & GetVersion (void)
 Returns the version number of JSBSim.
 
static constexpr double KelvinToFahrenheit (double kelvin)
 Converts from degrees Kelvin to degrees Fahrenheit.
 
static constexpr double CelsiusToRankine (double celsius)
 Converts from degrees Celsius to degrees Rankine.
 
static constexpr double RankineToCelsius (double rankine)
 Converts from degrees Rankine to degrees Celsius.
 
static constexpr double KelvinToRankine (double kelvin)
 Converts from degrees Kelvin to degrees Rankine.
 
static constexpr double RankineToKelvin (double rankine)
 Converts from degrees Rankine to degrees Kelvin.
 
static constexpr double FahrenheitToCelsius (double fahrenheit)
 Converts from degrees Fahrenheit to degrees Celsius.
 
static constexpr double CelsiusToFahrenheit (double celsius)
 Converts from degrees Celsius to degrees Fahrenheit.
 
static constexpr double CelsiusToKelvin (double celsius)
 Converts from degrees Celsius to degrees Kelvin.
 
static constexpr double KelvinToCelsius (double kelvin)
 Converts from degrees Kelvin to degrees Celsius.
 
static constexpr double FeetToMeters (double measure)
 Converts from feet to meters.
 
static bool EqualToRoundoff (double a, double b)
 Finite precision comparison.
 
static bool EqualToRoundoff (float a, float b)
 Finite precision comparison.
 
static bool EqualToRoundoff (float a, double b)
 Finite precision comparison.
 
static bool EqualToRoundoff (double a, float b)
 Finite precision comparison.
 
static constexpr double Constrain (double min, double value, double max)
 Constrain a value between a minimum and a maximum value.
 
static constexpr double sign (double num)
 
- Public Attributes inherited from FGEngine
struct Inputs & in
 
- Static Public Attributes inherited from FGJSBBase
static char highint [5] = {27, '[', '1', 'm', '\0' }
 highlights text
 
static char halfint [5] = {27, '[', '2', 'm', '\0' }
 low intensity text
 
static char normint [6] = {27, '[', '2', '2', 'm', '\0' }
 normal intensity text
 
static char reset [5] = {27, '[', '0', 'm', '\0' }
 resets text properties
 
static char underon [5] = {27, '[', '4', 'm', '\0' }
 underlines text
 
static char underoff [6] = {27, '[', '2', '4', 'm', '\0' }
 underline off
 
static char fgblue [6] = {27, '[', '3', '4', 'm', '\0' }
 blue text
 
static char fgcyan [6] = {27, '[', '3', '6', 'm', '\0' }
 cyan text
 
static char fgred [6] = {27, '[', '3', '1', 'm', '\0' }
 red text
 
static char fggreen [6] = {27, '[', '3', '2', 'm', '\0' }
 green text
 
static char fgdef [6] = {27, '[', '3', '9', 'm', '\0' }
 default text
 
static short debug_lvl = 1
 
- Protected Member Functions inherited from FGEngine
void Debug (int from)
 
bool Load (FGFDMExec *exec, Element *el)
 
- Protected Member Functions inherited from FGModelFunctions
virtual bool InitModel (void)
 
- Static Protected Member Functions inherited from FGJSBBase
static std::string CreateIndexedPropertyName (const std::string &Property, int index)
 
- Protected Attributes inherited from FGEngine
bool Cranking
 
const int EngineNumber
 
double FuelDensity
 
double FuelExpended
 
double FuelFlow_gph
 
double FuelFlow_pph
 
double FuelFlowRate
 
bool FuelFreeze
 
double FuelUsedLbs
 
double MaxThrottle
 
double MinThrottle
 
std::string Name
 
double PctPower
 
bool Running
 
double SLFuelFlowMax
 
std::vector< int > SourceTanks
 
bool Starter
 
bool Starved
 
FGThruster * Thruster
 
EngineType Type
 
- Protected Attributes inherited from FGModelFunctions
FGPropertyReader LocalProperties
 
std::vector< std::shared_ptr< FGFunction > > PostFunctions
 
std::vector< std::shared_ptr< FGFunction > > PreFunctions
 
- Static Protected Attributes inherited from FGJSBBase
static constexpr double radtodeg = 180. / M_PI
 
static constexpr double degtorad = M_PI / 180.
 
static constexpr double hptoftlbssec = 550.0
 
static constexpr double psftoinhg = 0.014138
 
static constexpr double psftopa = 47.88
 
static constexpr double fttom = 0.3048
 
static constexpr double ktstofps = 1852./(3600*fttom)
 
static constexpr double fpstokts = 1.0 / ktstofps
 
static constexpr double inchtoft = 1.0/12.0
 
static constexpr double m3toft3 = 1.0/(fttom*fttom*fttom)
 
static constexpr double in3tom3 = inchtoft*inchtoft*inchtoft/m3toft3
 
static constexpr double inhgtopa = 3386.38
 
static constexpr double slugtolb = 32.174049
 Note that definition of lbtoslug by the inverse of slugtolb and not to a different constant you can also get from some tables will make lbtoslug*slugtolb == 1 up to the magnitude of roundoff.
 
static constexpr double lbtoslug = 1.0/slugtolb
 
static constexpr double kgtolb = 2.20462
 
static constexpr double kgtoslug = 0.06852168
 
static const std::string needed_cfg_version = "2.0"
 
static const std::string JSBSim_version = JSBSIM_VERSION " " __DATE__ " " __TIME__
 

Constructor & Destructor Documentation

◆ FGBrushLessDCMotor()

FGBrushLessDCMotor ( FGFDMExec *  exec,
Element *  el,
int  engine_number,
FGEngine::Inputs &  input 
)

Constructor.

Definition at line 65 of file FGBrushLessDCMotor.cpp.

66 : FGEngine(engine_number, input)
67{
68 Load(exec, el);
69
70 Type = etElectric;
71
72 if (el->FindElement("maxvolts"))
73 MaxVolts = el->FindElementValueAsNumberConvertTo("maxvolts", "VOLTS");
74 else {
75 cerr << el->ReadFrom()
76 << "<maxvolts> is a mandatory parameter" << endl;
77 throw BaseException("Missing parameter");
78 }
79
80 if (el->FindElement("velocityconstant"))
81 Kv = el->FindElementValueAsNumber("velocityconstant");
82 else {
83 cerr << el->ReadFrom()
84 << "<velocityconstant> is a mandatory parameter" << endl;
85 throw BaseException("Missing parameter");
86 }
87
88 if (el->FindElement("coilresistance"))
89 CoilResistance = el->FindElementValueAsNumberConvertTo("coilresistance", "OHMS");
90 else {
91 cerr << el->ReadFrom()
92 << "<coilresistance> is a mandatory parameter" << endl;
93 throw BaseException("Missing parameter");
94 }
95 if (el->FindElement("noloadcurrent"))
96 ZeroTorqueCurrent = el->FindElementValueAsNumberConvertTo("noloadcurrent", "AMPERES");
97 else {
98 cerr << el->ReadFrom()
99 << "<noloadcurrent> is a mandatory parameter" << endl;
100 throw BaseException("Missing parameter");
101 }
102
103 double MaxCurrent = MaxVolts / CoilResistance + ZeroTorqueCurrent;
104
105 PowerWatts = MaxCurrent * MaxVolts;
106
107 string base_property_name = CreateIndexedPropertyName("propulsion/engine", EngineNumber);
108 auto pm = exec->GetPropertyManager();
109 pm->Tie(base_property_name + "/power-hp", &HP);
110 pm->Tie(base_property_name + "/current-amperes", &Current);
111
112 Debug(0); // Call Debug() routine from constructor if needed
113}
+ Here is the call graph for this function:

◆ ~FGBrushLessDCMotor()

~FGBrushLessDCMotor ( )

Destructor.

Definition at line 117 of file FGBrushLessDCMotor.cpp.

118{
119 Debug(1); // Call Debug() routine from constructor if needed
120}

Member Function Documentation

◆ CalcFuelNeed()

double CalcFuelNeed ( void  )
inlinevirtual

The fuel need is calculated based on power levels and flow rate for that power level.

It is also turned from a rate into an actual amount (pounds) by multiplying it by the delta T and the rate.

Returns
Total fuel requirement for this engine in pounds.

Reimplemented from FGEngine.

Definition at line 91 of file FGBrushLessDCMotor.h.

91{ return 0.; }

◆ Calculate()

void Calculate ( void  )
virtual

Calculates the thrust of the engine, and other engine functions.

Implements FGEngine.

Definition at line 124 of file FGBrushLessDCMotor.cpp.

125{
126 RunPreFunctions();
127
128 if (Thruster->GetType() == FGThruster::ttPropeller) {
129 ((FGPropeller*)Thruster)->SetAdvance(in.PropAdvance[EngineNumber]);
130 ((FGPropeller*)Thruster)->SetFeather(in.PropFeather[EngineNumber]);
131 }
132
133 double RPM = Thruster->GetRPM();
134 double V = MaxVolts * in.ThrottlePos[EngineNumber];
135
136 Current = (V - RPM / Kv) / CoilResistance; // Equation (4) from Drela's document
137
138 // Compute torque from current with Kq=1/Kv considering NoLoadCurrent deadband
139 // The "zero torque current" is by definition the current necessary for the
140 // motor to overcome internal friction : it is always resisting the torque and
141 // consequently has an opposite to the current.
142
143 double Torque = 0;
144
145 if (Current >= ZeroTorqueCurrent)
146 Torque = (Current - ZeroTorqueCurrent) / Kv * WattperRPMtoftpound;
147 if (Current<=-ZeroTorqueCurrent)
148 Torque = (Current + ZeroTorqueCurrent) / Kv * WattperRPMtoftpound;
149
150 // EnginePower must be non zero when accelerating from RPM == 0.0
151 double EnginePower = ((2 * M_PI) * max(RPM, 0.0001) * Torque) / 60; //units [#*ft/s]
152 HP = EnginePower / hptowatts * NMtoftpound; // units[HP]
153 LoadThrusterInputs();
154 Thruster->Calculate(EnginePower);
155
156 RunPostFunctions();
157}

◆ GetEngineLabels()

string GetEngineLabels ( const std::string &  delimiter)
virtual

Implements FGEngine.

Definition at line 161 of file FGBrushLessDCMotor.cpp.

162{
163 std::ostringstream buf;
164
165 buf << Name << " HP (engine " << EngineNumber << ")" << delimiter
166 << Thruster->GetThrusterLabels(EngineNumber, delimiter);
167
168 return buf.str();
169}

◆ GetEngineValues()

string GetEngineValues ( const std::string &  delimiter)
virtual

Implements FGEngine.

Definition at line 173 of file FGBrushLessDCMotor.cpp.

174{
175 std::ostringstream buf;
176
177 buf << HP << delimiter
178 << Thruster->GetThrusterValues(EngineNumber, delimiter);
179
180 return buf.str();
181}

◆ GetPowerAvailable()

double GetPowerAvailable ( void  ) const
inlinevirtual

Reimplemented from FGEngine.

Definition at line 90 of file FGBrushLessDCMotor.h.

90{return (HP * hptoftlbssec);}
The documentation for this class was generated from the following files: