-/*******************************************************************************
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Header: FGCoefficient.h
Author: Jon Berndt
--------------------------------------------------------------------------------
12/28/98 JSB Created
-********************************************************************************
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SENTRY
-*******************************************************************************/
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
#ifndef FGCOEFFICIENT_H
#define FGCOEFFICIENT_H
-/*******************************************************************************
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
INCLUDES
-*******************************************************************************/
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
#ifdef FGFS
-# include <Include/compiler.h>
-# include STL_STRING
-# ifdef FG_HAVE_STD_INCLUDES
-# include <fstream>
-# else
-# include <fstream.h>
-# endif
- FG_USING_STD(string);
-#else
-# include <string>
-# include <fstream>
+# include <simgear/compiler.h>
#endif
-/*******************************************************************************
-DEFINES
-*******************************************************************************/
-
-using namespace std;
-
-#define FG_QBAR 1
-#define FG_WINGAREA 2
-#define FG_WINGSPAN 4
-#define FG_CBAR 8
-#define FG_ALPHA 16
-#define FG_ALPHADOT 32
-#define FG_BETA 64
-#define FG_BETADOT 128
-#define FG_PITCHRATE 256
-#define FG_ROLLRATE 512
-#define FG_YAWRATE 1024
-#define FG_ELEVATOR 2048
-#define FG_AILERON 4096
-#define FG_RUDDER 8192
-#define FG_MACH 16384
-#define FG_ALTITUDE 32768L
-
-/*******************************************************************************
+#include <vector>
+#include <string>
+#include "FGConfigFile.h"
+#include "FGTable.h"
+#include "FGJSBBase.h"
+#include "FGPropertyManager.h"
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+DEFINITIONS
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+#define ID_COEFFICIENT "$Id$"
+
+using std::vector;
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
FORWARD DECLARATIONS
-*******************************************************************************/
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+namespace JSBSim {
+
class FGFDMExec;
class FGState;
class FGAtmosphere;
class FGAuxiliary;
class FGOutput;
-/*******************************************************************************
-COMMENTS, REFERENCES, and NOTES
-*******************************************************************************/
-/**
-This class models the stability derivative coefficient lookup tables or
-equations. Note that the coefficients need not be calculated each delta-t.
-
-The coefficient files are located in the axis subdirectory for each aircraft.
-For instance, for the X-15, you would find subdirectories under the
-aircraft/X-15/ directory named CLIFT, CDRAG, CSIDE, CROLL, CPITCH, CYAW. Under
-each of these directories would be files named a, a0, q, and so on. The file
-named "a" under the CLIFT directory would contain data for the stability
-derivative modeling lift due to a change in alpha. See the FGAircraft.cpp file
-for additional information. The coefficient files have the following format:
-
-<name of coefficient>
-<short description of coefficient with no embedded spaces>
-<method used in calculating the coefficient: TABLE | EQUATION | VECTOR | VALUE>
- <parameter identifier for table row (if required)>
- <parameter identifier for table column (if required)>
-<OR'ed list of parameter identifiers needed to turn this coefficient into a force>
-<number of rows in table (if required)>
-<number of columns in table (if required)>
-
-<value of parameter indexing into the column of a table or vector - or value
- itself for a VALUE coefficient>
-<values of parameter indexing into row of a table if TABLE type> <Value of
- coefficient at this row and column>
-
-<... repeat above for each column of data in table ...>
-
-As an example for the X-15, for the lift due to mach:
-<PRE>
-
-CLa0
-Lift_at_zero_alpha
-Table 8 3
-16384
-32768
-16387
-
-0.00
-0.0 0.0
-0.5 0.4
-0.9 0.9
-1.0 1.6
-1.1 1.3
-1.4 1.0
-2.0 0.5
-3.0 0.5
-
-30000.00
-0.0 0.0
-0.5 0.5
-0.9 1.0
-1.0 1.7
-1.1 1.4
-1.4 1.1
-2.0 0.6
-3.0 0.6
-
-70000.00
-0.0 0.0
-0.5 0.6
-0.9 1.1
-1.0 1.7
-1.1 1.5
-1.4 1.2
-2.0 0.7
-3.0 0.7
-</PRE>
-
-Note that the values in a row which index into the table must be the same value
-for each column of data, so the first column of numbers for each altitude are
-seen to be equal, and there are the same number of values for each altitude.
-
-<PRE>
-FG_QBAR 1
-FG_WINGAREA 2
-FG_WINGSPAN 4
-FG_CBAR 8
-FG_ALPHA 16
-FG_ALPHADOT 32
-FG_BETA 64
-FG_BETADOT 128
-FG_PITCHRATE 256
-FG_ROLLRATE 512
-FG_YAWRATE 1024
-FG_ELEVATOR 2048
-FG_AILERON 4096
-FG_RUDDER 8192
-FG_MACH 16384
-FG_ALTITUDE 32768L
-</PRE>
-@author Jon S. Berndt
-@memo This class models the stability derivative coefficient lookup tables or equations.
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+CLASS DOCUMENTATION
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+/** This class models the aero coefficient and stability derivative coefficient
+ lookup table, value, vector, or equation (equation not modeled, yet).
+ Each coefficient for an axis is stored in that axes' vector of coefficients.
+ Each FDM execution frame the Run() method of the FGAerodynamics model
+ is called and the coefficient values are calculated.
+ @author Jon S. Berndt
+ @version $Id$
*/
-/*******************************************************************************
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DECLARATION
-*******************************************************************************/
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
-class FGCoefficient
+class FGCoefficient : public FGJSBBase
{
public:
- // ***************************************************************************
- /** @memo
- @param
- @return
- */
- FGCoefficient(FGFDMExec*, ifstream&);
-
- // ***************************************************************************
- /** @memo
- @param
- @return
- */
- ~FGCoefficient(void);
-
- // ***************************************************************************
- /** @memo
- @param
- @return
- */
- bool Allocate(int);
-
- // ***************************************************************************
- /** @memo
- @param
- @return
- */
- bool Allocate(int, int);
-
- // ***************************************************************************
- /** @memo
- @param
- @return
- */
- float Value(float, float);
-
- // ***************************************************************************
- /** @memo
- @param
- @return
- */
- float Value(float);
-
- // ***************************************************************************
- /** @memo
- @param
- @return
- */
- float Value(void);
-
- // ***************************************************************************
- /** @memo
- @param
- @return
- */
- float TotalValue(void);
-
- // ***************************************************************************
- /** @memo
- @param
- @return
- */
+ /** Constructor.
+ @param exec a pointer to the FGFDMExec instance. */
+ FGCoefficient(FGFDMExec* exec);
+ /// Destructor.
+ virtual ~FGCoefficient();
+
+ /** Loads the stability derivative/aero coefficient data from the config file
+ as directed by the FGAerodynamics instance.
+ @param AC_cfg a pointer to the current config file instance. */
+ virtual bool Load(FGConfigFile* AC_cfg);
+
+ typedef vector <FGPropertyManager*> MultVec;
+
enum Type {UNKNOWN, VALUE, VECTOR, TABLE, EQUATION};
+ /** Returns the value for this coefficient.
+ Each instance of FGCoefficient stores a value for the "type" of coefficient
+ it is, one of: VALUE, VECTOR, TABLE, or EQUATION. This TotalValue function
+ is called when the value for a coefficient needs to be known. When it is called,
+ depending on what type of coefficient is represented by the FGCoefficient
+ instance, TotalValue() directs the appropriate Value() function to be called.
+ The type of coefficient represented is determined when the config file is read.
+ The coefficient definition includes the "type" specifier.
+ @return the current value of the coefficient represented by this instance of
+ FGCoefficient. */
+ virtual double TotalValue(void);
+
+ /** Returns the value for this coefficient.
+ TotalValue is stored each time TotalValue() is called. This function returns
+ the stored value but does not calculate it anew. This is valuable for merely
+ printing out the value.
+ @return the most recently calculated and stored value of the coefficient
+ represented by this instance of FGCoefficient. */
+ virtual inline double GetValue(void) const { return totalValue; }
+
+ /// Returns the name of this coefficient.
+ virtual inline string Getname(void) const {return name;}
+
+ /// Returns the value of the coefficient only - before it is re-dimensionalized.
+ virtual inline double GetSD(void) const { return SD;}
+
+ /** Outputs coefficient information.
+ Non-dimensionalizing parameter descriptions are output
+ for each aero coefficient defined. */
+ virtual void DisplayCoeffFactors(void);
+
+ /// Returns the name of the coefficient.
+ virtual inline string GetCoefficientName(void) { return name; }
+ /// Returns the stability derivative or coefficient value as a string.
+ virtual string GetSDstring(void);
+
+ inline void setBias(double b) { bias=b; }
+ inline void setGain(double g) { gain=g; };
+ inline double getBias(void) const { return bias; }
+ inline double getGain(void) const { return gain; }
+
+ virtual void bind(FGPropertyManager *parent);
+ virtual void unbind(void);
+
protected:
+ FGFDMExec* FDMExec;
private:
- string filename;
+ int numInstances;
string description;
string name;
+ string filename;
string method;
- float StaticValue;
- float *Table2D;
- float **Table3D;
- float LookupR, LookupC;
- long int mult_idx[10];
+ string multparms;
+ string multparmsRow;
+ string multparmsCol;
+ double Value(double, double);
+ double Value(double);
+ double Value(void);
+ double StaticValue;
+ double totalValue;
+ double bias,gain;
+ FGPropertyManager *LookupR, *LookupC;
+
+ FGPropertyManager *node; // must be private!!
+
+ MultVec multipliers;
int rows, columns;
Type type;
- int multipliers;
- int mult_count;
+ double SD; // Actual stability derivative (or other coefficient) value
+ FGTable *Table;
- float GetCoeffVal(int);
-
- FGFDMExec* FDMExec;
FGState* State;
FGAtmosphere* Atmosphere;
FGFCS* FCS;
FGPosition* Position;
FGAuxiliary* Auxiliary;
FGOutput* Output;
+ FGPropertyManager* PropertyManager;
+
+ FGPropertyManager* resolveSymbol(string name);
+
+ virtual void Debug(int from);
};
-/******************************************************************************/
+} // using namespace JSBSim
+
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
#endif
+
projects / flightgear.git / blobdiff