Merge branch 'next' of gitorious.org:fg/flightgear into next

[flightgear.git] / src / FDM / JSBSim / models / propulsion / FGNozzle.h

diff --git a/src/FDM/JSBSim/models/propulsion/FGNozzle.h b/src/FDM/JSBSim/models/propulsion/FGNozzle.h
index f2aaf358a84cf684814e92ff78978b57565f3306..86576d57f4ed283eb990dc2579e35b7efea98e16 100644 (file)
--- a/src/FDM/JSBSim/models/propulsion/FGNozzle.h
+++ b/src/FDM/JSBSim/models/propulsion/FGNozzle.h
@@ -4,7 +4,7 @@
  Author:       Jon S. Berndt
  Date started: 08/24/00
 
- ------------- Copyright (C) 2000  Jon S. Berndt (jsb@hal-pc.org) -------------
+ ------------- Copyright (C) 2000  Jon S. Berndt (jon@jsbsim.org) -------------
 
  This program is free software; you can redistribute it and/or modify it under
  the terms of the GNU Lesser General Public License as published by the Free Software
@@ -44,7 +44,7 @@ INCLUDES
 DEFINITIONS
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
-#define ID_NOZZLE "$Id$";
+#define ID_NOZZLE "$Id: FGNozzle.h,v 1.10 2012/03/18 15:48:36 jentron Exp $";
 
 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 FORWARD DECLARATIONS
@@ -56,9 +56,26 @@ namespace JSBSim {
 CLASS DOCUMENTATION
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
-/** Models a rocket nozzle.
+/** Models a rocket nozzle. 
+
+<h3>Configuration File Format:</h3>
+
+@code
+<nozzle name="{string}">
+  <pe unit="{PSF}"> {number}  </pe>
+  <area unit="{FT2 | M2 | IN2}"> {number}  </area>
+</nozzle>
+@endcode
+
+<h3>Configuration parameters are:</h3>
+<pre>
+    <b>pe</b> -      Nozzle design exit pressure.
+    <b>area</b> -    Nozzle area at the exit plane.
+</pre>
+
+    All parameters MUST be specified.  
     @author Jon S. Berndt
-    @version $Id$
+    @version $Id: FGNozzle.h,v 1.10 2012/03/18 15:48:36 jentron Exp $
 */
 
 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -66,25 +83,19 @@ CLASS DECLARATION
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
 class FGNozzle : public FGThruster {
-
 public:
   /// Constructor
   FGNozzle(FGFDMExec* exec, Element* el, int num = 0);
   /// Destructor
   ~FGNozzle();
 
-  double Calculate(double CfPc);
-  double GetPowerRequired(void);
-  string GetThrusterLabels(int id, string delimeter);
-  string GetThrusterValues(int id, string delimeter);
+  double Calculate(double vacThrust);
+  string GetThrusterLabels(int id, const string& delimeter);
+  string GetThrusterValues(int id, const string& delimeter);
 
 private:
-  double PE;
-  double ExpR;
-  double nzlEff;
-  double Diameter;
-  double AreaT;
-  double Area2;
+//  double PE;
+  double Area;
   void Debug(int from);
 };
 }