#ifdef FGFS
# include <simgear/compiler.h>
-# ifdef FG_HAVE_STD_INCLUDES
+# ifdef SG_HAVE_STD_INCLUDES
# include <vector>
+# include <iterator>
# else
# include <vector.h>
+# include <iterator.h>
# endif
#else
# include <vector>
+# include <iterator>
#endif
#include "FGModel.h"
#include "FGRocket.h"
#include "FGPiston.h"
-#include "FGTurboShaft.h"
-#include "FGTurboJet.h"
-#include "FGTurboProp.h"
+#include "FGTurbine.h"
+#include "FGSimTurbine.h"
#include "FGTank.h"
#include "FGPropeller.h"
#include "FGNozzle.h"
FORWARD DECLARATIONS
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
-/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+namespace JSBSim {
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DOCUMENTATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
/** Propulsion management class.
- FGPropulsion manages all aspects of propulsive force generation, including
- containment of engines, tanks, and thruster class instances in STL vectors,
- and the interaction and communication between them.
+ The Propulsion class is the container for the entire propulsion system, which is
+ comprised of engines, tanks, and "thrusters" (the device that transforms the
+ engine power into a force that acts on the aircraft, such as a nozzle or
+ propeller). Once the Propulsion class gets the config file, it reads in
+ information which is specific to a type of engine. Then:
+
+ -# The appropriate engine type instance is created
+ -# A thruster object is instantiated, and is linked to the engine
+ -# At least one tank object is created, and is linked to an engine.
+
+ At Run time each engines Calculate() method is called to return the excess power
+ generated during that iteration. The drag from the previous iteration is sub-
+ tracted to give the excess power available for thrust this pass. That quantity
+ is passed to the thrusters associated with a particular engine - perhaps with a
+ scaling mechanism (gearing?) to allow the engine to give its associated thrust-
+ ers specific distributed portions of the excess power.
@author Jon S. Berndt
@version $Id$
- @see FGEngine
- @see FGTank
- @see FGThruster
+ @see
+ FGEngine
+ FGTank
+ FGThruster
*/
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DECLARATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
-class FGPropulsion : public FGModel {
+class FGPropulsion : public FGModel
+{
public:
+ /// Constructor
FGPropulsion(FGFDMExec*);
+ /// Destructor
~FGPropulsion();
/** Executes the propulsion model.
@param AC_cfg pointer to the config file instance that describes the
aircraft being modeled.
@return true if successfully loaded, otherwise false */
- bool LoadPropulsion(FGConfigFile* AC_cfg);
+ bool Load(FGConfigFile* AC_cfg);
/// Retrieves the number of engines defined for the aircraft.
- inline unsigned int GetNumEngines(void) {return Engines.size();}
+ inline unsigned int GetNumEngines(void) const {return Engines.size();}
/** Retrieves an engine object pointer from the list of engines.
@param index the engine index within the vector container
if (index <= Engines.size()-1) return Engines[index];
else return 0L; }
+ /// Retrieves the number of tanks defined for the aircraft.
+ inline unsigned int GetNumTanks(void) const {return Tanks.size();}
+
/** Retrieves a tank object pointer from the list of tanks.
@param index the tank index within the vector container
@return the address of the specific tank, or zero if no such tank is
else return 0L; }
/** Returns the number of fuel tanks currently actively supplying fuel */
- inline int GetnumSelectedFuelTanks(void) {return numSelectedFuelTanks;}
+ inline int GetnumSelectedFuelTanks(void) const {return numSelectedFuelTanks;}
/** Returns the number of oxidizer tanks currently actively supplying oxidizer */
- inline int GetnumSelectedOxiTanks(void) {return numSelectedOxiTanks;}
+ inline int GetnumSelectedOxiTanks(void) const {return numSelectedOxiTanks;}
+ /** Loops the engines/thrusters until thrust output steady (used for trimming) */
bool GetSteadyState(void);
-
-
- inline FGColumnVector& GetForces(void) {return *Forces; }
- inline FGColumnVector& GetMoments(void) {return *Moments;}
-
+
+ /** starts the engines in IC mode (dt=0). All engine-specific setup must
+ be done before calling this (i.e. magnetos, starter engage, etc.) */
+ bool ICEngineStart(void);
+
+ string GetPropulsionStrings(void);
+ string GetPropulsionValues(void);
+
+ inline FGColumnVector3& GetForces(void) {return vForces; }
+ inline double GetForces(int n) const { return vForces(n);}
+ inline FGColumnVector3& GetMoments(void) {return vMoments;}
+ inline double GetMoments(int n) const {return vMoments(n);}
+
+ FGColumnVector3& GetTanksMoment(void);
+ double GetTanksWeight(void);
+
+ double GetTanksIxx(const FGColumnVector3& vXYZcg);
+ double GetTanksIyy(const FGColumnVector3& vXYZcg);
+ double GetTanksIzz(const FGColumnVector3& vXYZcg);
+ double GetTanksIxz(const FGColumnVector3& vXYZcg);
+ double GetTanksIxy(const FGColumnVector3& vXYZcg);
+
+ inline int GetActiveEngine(void) const
+ {
+ return ActiveEngine;
+ }
+
+ inline int GetActiveEngine(void);
+
+ void SetMagnetos(int setting);
+ void SetStarter(int setting);
+ void SetCutoff(int setting=0);
+ void SetActiveEngine(int engine);
+
+ void bind();
+ void unbind();
+
private:
vector <FGEngine*> Engines;
vector <FGTank*> Tanks;
+ vector <FGTank*>::iterator iTank;
vector <FGThruster*> Thrusters;
unsigned int numSelectedFuelTanks;
unsigned int numSelectedOxiTanks;
unsigned int numEngines;
unsigned int numTanks;
unsigned int numThrusters;
- float dt;
- FGColumnVector *Forces;
- FGColumnVector *Moments;
- void Debug(void);
+ int ActiveEngine;
+ double dt;
+ FGColumnVector3 vForces;
+ FGColumnVector3 vMoments;
+ FGColumnVector3 vXYZtank;
+ void Debug(int from);
};
-
+}
//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
#endif