Models an aircraft control variables for purposes of trimming. More...

#include <FGTrimAnalysisControl.h>

Inheritance diagram for FGTrimAnalysisControl:

Collaboration diagram for FGTrimAnalysisControl:

Public Member Functions
	FGTrimAnalysisControl (FGFDMExec fdmex, FGInitialCondition IC, TaControl control)
	Constructor for Trim Analysis Control class. More...

	~FGTrimAnalysisControl ()
	Destructor.

double	GetControl (void)
	Gets the control value. More...

double	GetControlInitialValue (void)
	Get control step. More...

double	GetControlMax (void)
	Gets the control maximum value. More...

double	GetControlMin (void)
	Gets the control minimum value. More...

string	GetControlName (void)
	Gets the control name. More...

double	GetControlStep (void)
	Get control step. More...

TaControl	GetControlType (void)
	Return the control type. More...

double	GetStateTarget (void)
	Get target state value for trim. More...

double	GetTolerance (void)
	Get control tolerance. More...

bool	initTheta (void)
	Calculate steady state thetas value on ground. More...

void	Run (void)
	This function iterates through a call to the FGFDMExec::RunIC() function until the desired trimming condition falls inside a tolerance. More...

void	SetControl (double value)
	Sets the control value. More...

void	SetControlInitialValue (double value)
	Set control initial value. More...

void	SetControlLimits (double min, double max)
	Set both control limits. More...

void	SetControlStep (double value)
	Set control step. More...

void	SetControlToMax (void)
	Set control value to maximum.

void	SetControlToMin (void)
	Set control value to minimum.

void	SetPhiOnGround (double ff)
	Set phi value on ground for trim. More...

void	SetStateTarget (double target)
	Set target state value for trim. More...

void	SetThetaOnGround (double ff)
	Set theta value on ground for trim. More...

void	SetTolerance (double ff)
	Set control tolerance. More...

Public Member Functions inherited from FGJSBBase
	FGJSBBase ()
	Constructor for FGJSBBase.

virtual	~FGJSBBase ()
	Destructor for FGJSBBase.

void	disableHighLighting (void)
	Disables highlighting in the console output.

std::string	GetVersion (void)
	Returns the version number of JSBSim. More...

void	PutMessage (const Message &msg)
	Places a Message structure on the Message queue. More...

void	PutMessage (const std::string &text)
	Creates a message with the given text and places it on the queue. More...

void	PutMessage (const std::string &text, bool bVal)
	Creates a message with the given text and boolean value and places it on the queue. More...

void	PutMessage (const std::string &text, int iVal)
	Creates a message with the given text and integer value and places it on the queue. More...

void	PutMessage (const std::string &text, double dVal)
	Creates a message with the given text and double value and places it on the queue. More...

int	SomeMessages (void)
	Reads the message on the queue (but does not delete it). More...

void	ProcessMessage (void)
	Reads the message on the queue and removes it from the queue. More...

Message *	ProcessNextMessage (void)
	Reads the next message on the queue and removes it from the queue. More...

Additional Inherited Members
Public Types inherited from FGJSBBase
enum	{ eL = 1, eM, eN }
	Moments L, M, N.

enum	{ eP = 1, eQ, eR }
	Rates P, Q, R.

enum	{ eU = 1, eV, eW }
	Velocities U, V, W.

enum	{ eX = 1, eY, eZ }
	Positions X, Y, Z.

enum	{ ePhi = 1, eTht, ePsi }
	Euler angles Phi, Theta, Psi.

enum	{ eDrag = 1, eSide, eLift }
	Stability axis forces, Drag, Side force, Lift.

enum	{ eRoll = 1, ePitch, eYaw }
	Local frame orientation Roll, Pitch, Yaw.

enum	{ eNorth = 1, eEast, eDown }
	Local frame position North, East, Down.

enum	{ eLat = 1, eLong, eRad }
	Locations Radius, Latitude, Longitude.

enum	{ inNone = 0, inDegrees, inRadians, inMeters, inFeet }
	Conversion specifiers.

Static Public Member Functions inherited from FGJSBBase
static double	CelsiusToFahrenheit (double celsius)
	Converts from degrees Celsius to degrees Fahrenheit. More...

static double	CelsiusToKelvin (double celsius)
	Converts from degrees Celsius to degrees Kelvin. More...

static double	CelsiusToRankine (double celsius)
	Converts from degrees Celsius to degrees Rankine. More...

static double	Constrain (double min, double value, double max)
	Constrain a value between a minimum and a maximum value.

static bool	EqualToRoundoff (double a, double b)
	Finite precision comparison. More...

static bool	EqualToRoundoff (float a, float b)
	Finite precision comparison. More...

static bool	EqualToRoundoff (float a, double b)
	Finite precision comparison. More...

static bool	EqualToRoundoff (double a, float b)
	Finite precision comparison. More...

static double	FahrenheitToCelsius (double fahrenheit)
	Converts from degrees Fahrenheit to degrees Celsius. More...

static double	FeetToMeters (double measure)
	Converts from feet to meters. More...

static double	GaussianRandomNumber (void)

static double	KelvinToCelsius (double kelvin)
	Converts from degrees Kelvin to degrees Celsius. More...

static double	KelvinToFahrenheit (double kelvin)
	Converts from degrees Kelvin to degrees Fahrenheit. More...

static double	KelvinToRankine (double kelvin)
	Converts from degrees Kelvin to degrees Rankine. More...

static double	MachFromVcalibrated (double vcas, double p, double psl, double rhosl)
	Calculate the Mach number from the calibrated airspeed. More...

static double	PitotTotalPressure (double mach, double p)
	Compute the total pressure in front of the Pitot tube. More...

static double	RankineToCelsius (double rankine)
	Converts from degrees Rankine to degrees Celsius. More...

static double	RankineToKelvin (double rankine)
	Converts from degrees Rankine to degrees Kelvin. More...

static double	sign (double num)

static double	VcalibratedFromMach (double mach, double p, double psl, double rhosl)
	Calculate the calibrated airspeed from the Mach number. More...

Static Public Attributes inherited from FGJSBBase
static short	debug_lvl = 1

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

Protected Member Functions inherited from FGJSBBase
void	Debug (int)

Static Protected Member Functions inherited from FGJSBBase
static std::string	CreateIndexedPropertyName (const std::string &Property, int index)

Static Protected Attributes inherited from FGJSBBase
static const double	degtorad = 0.017453292519943295769236907684886

static const double	fpstokts = 1.0/ktstofps

static const double	fttom = 0.3048

static int	gaussian_random_number_phase = 0

static const double	hptoftlbssec = 550.0

static const double	in3tom3 = 1.638706E-5

static const double	inchtoft = 0.08333333

static const double	inhgtopa = 3386.38

static const std::string	JSBSim_version = "1.0 " __DATE__ " " __TIME__

static const double	kgtolb = 2.20462

static const double	kgtoslug = 0.06852168

static const double	ktstofps = 1.68781

static const double	lbtoslug = 1.0/slugtolb

static Message	localMsg

static const double	m3toft3 = 1.0/(fttomfttomfttom)

static double	Mair = 28.9645

static unsigned int	messageId = 0

static std::queue< Message >	Messages

static const std::string	needed_cfg_version = "2.0"

static const double	psftoinhg = 0.014138

static const double	psftopa = 47.88

static const double	radtodeg = 57.295779513082320876798154814105

static double	Reng = 1716.56

static double	Rstar = 1545.348

static const double	SHRatio = 1.40

static const double	slugtolb = 32.174049

Detailed Description

Models an aircraft control variables for purposes of trimming.

Definition at line 93 of file FGTrimAnalysisControl.h.

Constructor & Destructor Documentation

◆ FGTrimAnalysisControl()

FGTrimAnalysisControl	(	FGFDMExec *	fdmex,
		FGInitialCondition *	IC,
		TaControl	control
	)

Constructor for Trim Analysis Control class.

Parameters

fdmex	FGFDMExec pointer
IC	pointer to initial conditions instance
control	a Control type (enum)

Definition at line 62 of file FGTrimAnalysisControl.cpp.

                                                              {
   fdmex=fdex;
   fgic=ic;
   state=taAll;
   control=ctrl;
   control_initial_value = 0.;
   control_value=0;
   state_convert=1.0;
   control_convert=1.0;
   state_value=0;
   state_target=0;
   control_tolerance = DEFAULT_TOLERANCE;
 
   switch(control) {
   case taThrottle:
     control_min=0;
     control_max=1;
     control_step=0.2;
     control_initial_value = 0.5;
     control_value=control_initial_value;
     control_name = "Throttle (cmd,norm)";
     break;
   case taBeta:
     control_min=-30*degtorad;
     control_max=30*degtorad;
     control_step=1*degtorad;
     control_convert=radtodeg;
     break;
   case taAlpha:
     control_min=fdmex->GetAerodynamics()->GetAlphaCLMin();
     control_max=fdmex->GetAerodynamics()->GetAlphaCLMax();
     if(control_max <= control_min) {
       control_max=20*degtorad;
       control_min=-5*degtorad;
     }
     control_step=1*degtorad;
     control_initial_value = (control_min+control_max)/2;
     control_value= control_initial_value;
     control_convert=radtodeg;
     break;
   case taPitchTrim:
     control_name = "Pitch Trim (cmd,norm)";
     control_min=-1;
     control_max=1;
     control_step=0.1;
     state_convert=radtodeg;
     break;
   case taElevator:
     control_name = "Elevator (cmd,norm)";
     control_min=-1;
     control_max=1;
     control_step=0.1;
     state_convert=radtodeg;
     break;
   case taRollTrim:
     control_name = "Roll Trim (cmd,norm)";
     control_min=-1;
     control_max=1;
     control_step=0.1;
     state_convert=radtodeg;
     break;
   case taAileron:
     control_name = "Ailerons (cmd,norm)";
     control_min=-1;
     control_max=1;
     control_step=0.1;
     state_convert=radtodeg;
     break;
   case taYawTrim:
     control_name = "Yaw Trim (cmd,norm)";
     control_min=-1;
     control_max=1;
     control_step=0.1;
     state_convert=radtodeg;
     break;
   case taRudder:
     control_name = "Rudder (cmd,norm)";
     control_min=-1;
     control_max=1;
     control_step=0.1;
     state_convert=radtodeg;
     break;
   case taAltAGL:
     control_name = "Altitude (ft)";
     control_min=0;
     control_max=30;
     control_step=2;
     control_initial_value = fdmex->GetPropagate()->GetDistanceAGL();
     control_value = control_initial_value;
     break;
   case taPhi:
     control_name = "Phi (rad)";
     control_min=fdmex->GetPropagate()->GetEuler(ePhi) - 30*degtorad;
     control_max=fdmex->GetPropagate()->GetEuler(ePhi) + 30*degtorad;
     control_step=1*degtorad;
     state_convert=radtodeg;
     control_convert=radtodeg;
     break;
   case taTheta:
     control_name = "Theta (rad)";
     control_min=fdmex->GetPropagate()->GetEuler(eTht) - 5*degtorad;
     control_max=fdmex->GetPropagate()->GetEuler(eTht) + 5*degtorad;
     control_step=1*degtorad;
     state_convert=radtodeg;
     break;
   case taHeading:
     control_name = "Heading (rad)";
     control_min=fdmex->GetPropagate()->GetEuler(ePsi) - 30*degtorad;
     control_max=fdmex->GetPropagate()->GetEuler(ePsi) + 30*degtorad;
     control_step=1*degtorad;
     state_convert=radtodeg;
     break;
   case taGamma:
     control_name = "Gamma (rad)";
     control_min=-80*degtorad;
     control_max=80*degtorad;
     control_step=1*degtorad;
     control_convert=radtodeg;
     break;
   }
 
 //  if (debug_lvl > 0)
 //    cout << "FGTrimAnalysisControl created: "<< control_name << endl;
 
   Debug(0);
 }

Here is the call graph for this function:

Member Function Documentation

◆ GetControl()

double GetControl ( void )

inline

Gets the control value.

Returns: value

Definition at line 122 of file FGTrimAnalysisControl.h.

122 { return control_value; }

◆ GetControlInitialValue()

double GetControlInitialValue ( void )

inline

Get control step.

Returns: value of control initial value

Definition at line 163 of file FGTrimAnalysisControl.h.

163 { return control_initial_value; }

◆ GetControlMax()

double GetControlMax ( void )

inline

Gets the control maximum value.

Returns: control nax value

Definition at line 144 of file FGTrimAnalysisControl.h.

144 { return control_max; }

Here is the caller graph for this function:

◆ GetControlMin()

double GetControlMin ( void )

inline

Gets the control minimum value.

Returns: control min value

Definition at line 140 of file FGTrimAnalysisControl.h.

140 { return control_min; }

Here is the call graph for this function:

◆ GetControlName()

string GetControlName ( void )

inline

Gets the control name.

Returns: control name

Definition at line 135 of file FGTrimAnalysisControl.h.

135 { return control_name; }

◆ GetControlStep()

double GetControlStep ( void )

inline

Get control step.

Returns: value of control step

Definition at line 153 of file FGTrimAnalysisControl.h.

153 { return control_step; }

◆ GetControlType()

TaControl GetControlType ( void )

inline

Return the control type.

Returns: TaControl

Definition at line 128 of file FGTrimAnalysisControl.h.

128 { return control; }

Here is the caller graph for this function:

◆ GetStateTarget()

double GetStateTarget ( void )

inline

Get target state value for trim.

Returns: state target

Definition at line 210 of file FGTrimAnalysisControl.h.

210 { return state_target; }

Here is the call graph for this function:

◆ GetTolerance()

double GetTolerance ( void )

inline

Get control tolerance.

Returns: value of control tolerance

Definition at line 190 of file FGTrimAnalysisControl.h.

190 { return control_tolerance; }

Here is the call graph for this function:

◆ initTheta()

bool initTheta ( void )

Calculate steady state thetas value on ground.

Returns: true if successful

Definition at line 328 of file FGTrimAnalysisControl.cpp.

                                           {
   int i,N;
   int iForward = 0;
   int iAft = 1;
   double zAft,zForward,zDiff,theta;
   double xAft,xForward,xDiff;
   bool level;
   double saveAlt;
 
   saveAlt=fgic->GetAltitudeAGLFtIC();
   fgic->SetAltitudeAGLFtIC(100);
 
 
   N=fdmex->GetGroundReactions()->GetNumGearUnits();
 
   //find the first wheel unit forward of the cg
   //the list is short so a simple linear search is fine
   for( i=0; i<N; i++ ) {
     if(fdmex->GetGroundReactions()->GetGearUnit(i)->GetBodyLocation(1) > 0 ) {
         iForward=i;
         break;
     }
   }
   //now find the first wheel unit aft of the cg
   for( i=0; i<N; i++ ) {
     if(fdmex->GetGroundReactions()->GetGearUnit(i)->GetBodyLocation(1) < 0 ) {
         iAft=i;
         break;
     }
   }
 
   // now adjust theta till the wheels are the same distance from the ground
   xAft=fdmex->GetGroundReactions()->GetGearUnit(iAft)->GetBodyLocation(1);
   xForward=fdmex->GetGroundReactions()->GetGearUnit(iForward)->GetBodyLocation(1);
   xDiff = xForward - xAft;
   zAft=fdmex->GetGroundReactions()->GetGearUnit(iAft)->GetLocalGear(3);
   zForward=fdmex->GetGroundReactions()->GetGearUnit(iForward)->GetLocalGear(3);
   zDiff = zForward - zAft;
   level=false;
   theta=fgic->GetThetaDegIC();
   while(!level && (i < 100)) {
     theta+=radtodeg*atan(zDiff/xDiff);
     fgic->SetThetaDegIC(theta);
     fdmex->SuspendIntegration();
     fdmex->Initialize(fgic);
     fdmex->Run();
     fdmex->ResumeIntegration();
     zAft=fdmex->GetGroundReactions()->GetGearUnit(iAft)->GetLocalGear(3);
     zForward=fdmex->GetGroundReactions()->GetGearUnit(iForward)->GetLocalGear(3);
     zDiff = zForward - zAft;
     //cout << endl << theta << "  " << zDiff << endl;
     //cout << "0: " << fdmex->GetGroundReactions()->GetGearUnit(0)->GetLocalGear() << endl;
     //cout << "1: " << fdmex->GetGroundReactions()->GetGearUnit(1)->GetLocalGear() << endl;
     if(fabs(zDiff ) < 0.1)
         level=true;
     i++;
   }
   //cout << i << endl;
   if (debug_lvl > 0) {
       cout << "    Initial Theta: " << fdmex->GetPropagate()->GetEuler(eTht)*radtodeg << endl;
       cout << "    Used gear unit " << iAft << " as aft and " << iForward << " as forward" << endl;
   }
   control_min=(theta+5)*degtorad;
   control_max=(theta-5)*degtorad;
   fgic->SetAltitudeAGLFtIC(saveAlt);
   if(i < 100)
     return true;
   else
     return false;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Run()

void Run ( void )

This function iterates through a call to the FGFDMExec::RunIC() function until the desired trimming condition falls inside a tolerance.

Definition at line 430 of file FGTrimAnalysisControl.cpp.

                                     {
 
     // ... what's going on here ??
 }

Here is the call graph for this function:

◆ SetControl()

void SetControl ( double value )

inline

Sets the control value.

Parameters

value

Definition at line 117 of file FGTrimAnalysisControl.h.

117 { control_value=value; }

◆ SetControlInitialValue()

void SetControlInitialValue ( double value )

inline

Set control initial value.

Parameters

value of control initial value

Definition at line 158 of file FGTrimAnalysisControl.h.

158 { control_initial_value = value; }

◆ SetControlLimits()

void SetControlLimits	(	double	min,
		double	max
	)

inline

Set both control limits.

Parameters

max	control max
min	control min

Definition at line 177 of file FGTrimAnalysisControl.h.

                                                        {
       control_min=min;
       control_max=max;
   }

◆ SetControlStep()

void SetControlStep ( double value )

inline

Set control step.

Parameters

value of control step

Definition at line 149 of file FGTrimAnalysisControl.h.

149 { control_step = value; }

◆ SetPhiOnGround()

void SetPhiOnGround ( double ff )

Set phi value on ground for trim.

Parameters

ff

Definition at line 401 of file FGTrimAnalysisControl.cpp.

                                                     {
   int i,ref;
 
   i=0; ref=-1;
   //must have an off-center unit here
   while ( (ref < 0) && (i < fdmex->GetGroundReactions()->GetNumGearUnits()) ) {
     if ( (fdmex->GetGroundReactions()->GetGearUnit(i)->GetWOW()) &&
       (fabs(fdmex->GetGroundReactions()->GetGearUnit(i)->GetBodyLocation(2)) > 0.01))
         ref=i;
     i++;
   }
   if (ref >= 0) {
     double st = fdmex->GetPropagate()->GetSinEuler(eTht);
     double ct = fdmex->GetPropagate()->GetCosEuler(eTht);
     double lx = fdmex->GetGroundReactions()->GetGearUnit(ref)->GetBodyLocation(1);
     double ly = fdmex->GetGroundReactions()->GetGearUnit(ref)->GetBodyLocation(2);
     double lz = fdmex->GetGroundReactions()->GetGearUnit(ref)->GetBodyLocation(3);
     double hagl = -1*lx*st +
                     ly*sin(ff)*ct +
                     lz*cos(ff)*ct;
 
     fgic->SetAltitudeAGLFtIC(hagl);
   }
   fgic->SetPhiRadIC(ff);
 
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetStateTarget()

void SetStateTarget ( double target )

inline

Set target state value for trim.

Parameters

target

Definition at line 205 of file FGTrimAnalysisControl.h.

205 { state_target=target; }

◆ SetThetaOnGround()

void SetThetaOnGround ( double ff )

Set theta value on ground for trim.

Parameters

ff

Definition at line 289 of file FGTrimAnalysisControl.cpp.

                                                       {
   int center,i,ref;
 
   // favor an off-center unit so that the same one can be used for both
   // pitch and roll.  An on-center unit is used (for pitch)if that's all
   // that's in contact with the ground.
   i=0; ref=-1; center=-1;
   while( (ref < 0) && (i < fdmex->GetGroundReactions()->GetNumGearUnits()) ) {
     if(fdmex->GetGroundReactions()->GetGearUnit(i)->GetWOW()) {
       if(fabs(fdmex->GetGroundReactions()->GetGearUnit(i)->GetBodyLocation(2)) > 0.01)
         ref=i;
       else
         center=i;
     }
     i++;
   }
   if((ref < 0) && (center >= 0)) {
     ref=center;
   }
   cout << "SetThetaOnGround ref gear: " << ref << endl;
   if(ref >= 0) {
     double sp = fdmex->GetPropagate()->GetSinEuler(ePhi);
     double cp = fdmex->GetPropagate()->GetCosEuler(ePhi);
     double lx = fdmex->GetGroundReactions()->GetGearUnit(ref)->GetBodyLocation(1);
     double ly = fdmex->GetGroundReactions()->GetGearUnit(ref)->GetBodyLocation(2);
     double lz = fdmex->GetGroundReactions()->GetGearUnit(ref)->GetBodyLocation(3);
     double hagl = -1*lx*sin(ff) +
                     ly*sp*cos(ff) +
                     lz*cp*cos(ff);
 
     fgic->SetAltitudeAGLFtIC(hagl);
     cout << "SetThetaOnGround new alt: " << hagl << endl;
   }
   fgic->SetThetaRadIC(ff);
   cout << "SetThetaOnGround new theta: " << ff << endl;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTolerance()

void SetTolerance ( double ff )

inline

Set control tolerance.

Parameters

ff	value of control tolerance

Definition at line 185 of file FGTrimAnalysisControl.h.

185 { control_tolerance=ff;}

The documentation for this class was generated from the following files:

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FGTrimAnalysisControl()

Member Function Documentation

◆ GetControl()

◆ GetControlInitialValue()

◆ GetControlMax()

◆ GetControlMin()

◆ GetControlName()

◆ GetControlStep()

◆ GetControlType()

◆ GetStateTarget()

◆ GetTolerance()

◆ initTheta()

◆ Run()

◆ SetControl()

◆ SetControlInitialValue()

◆ SetControlLimits()

◆ SetControlStep()

◆ SetPhiOnGround()

◆ SetStateTarget()

◆ SetThetaOnGround()

◆ SetTolerance()