Inheritance diagram for FGTrimAnalysis:

Collaboration diagram for FGTrimAnalysis:

Public Member Functions
	FGTrimAnalysis (FGFDMExec *FDMExec, TrimAnalysisMode tam=taFull)
	Initializes the trimming class. More...

	~FGTrimAnalysis (void)
	Destructor.

bool	AddControl (TaControl control)
	Add a control to the current configuration. More...

void	CalculatePhiWFromTargetNlfTurn (double nlf)
	Calculate the wind axis bank angle from a given Nlf (sets also the target Nlf) More...

void	ClearControls (void)
	Clear all controls from the current configuration. More...

void	ClearDebug (void)

bool	DoTrim (void)
	Execute the trim.

bool	EditState (TaControl new_control, double new_initvalue, double new_step, double new_min, double new_max)
	Change the control settings previously configured. More...

vector< FGTrimAnalysisControl * > *	GetControls ()

double	GetCostFunctionValue () const

double	GetGamma ()
	Return the current flight path angle in TrimAnalysis object. More...

bool	GetGammaFallback (void)
	query the fallback state More...

double	GetGammaRad ()
	Gets flight path angle. More...

TrimAnalysisMode	GetMode () const

double	GetPhiRad ()
	Gets Euler angle phi. More...

double	GetPhiWRad ()
	Gets Euler angle phiW (wind axes) More...

double	GetPsiRad ()
	Gets Euler angle psi. More...

ofstream *	GetResultsFile () const
	Get the pointer to the file where trim analysis results are written,. More...

double	GetTargetNlf (void)
	Gets target normal load factor in steady turn. More...

double	GetThetaRad ()
	Gets Euler angle theta. More...

double	GetTolerance (void)
	Get the tolerance for declaring a state trimmed. More...

bool	GetTrimFailed (void)
	Gets trim result status. More...

double	GetVtFps ()
	Gets true speed [fps] from IC. More...

bool	Load (string fname, bool useStoredPath=true)
	Loads the trim configuration from file. More...

bool	RemoveControl (TaControl control)
	Remove a specific control from the current configuration. More...

void	Report (void)
	Print the results of the trim. More...

void	SetCostFunctionValue (double value)
	Set the value of the cost function. More...

void	SetDebug (int level)
	Debug level 1 shows results of each top-level iteration Debug level 2 shows level 1 & results of each per-axis iteration.

void	SetDottedValues (double udot, double vdot, double wdot, double pdot, double qdot, double rdot)
	Sets Dotted values. More...

void	SetEulerAngles (double phi0, double theta0, double psi0)
	Sets Euler angles. More...

void	SetGammaFallback (bool bb)
	automatically switch to trimming longitudinal acceleration with flight path angle (gamma) once it becomes apparent that there is not enough/too much thrust. More...

void	SetMaxCycles (int ii)
	Set the iteration limit. More...

void	SetMode (TrimAnalysisMode tam)
	Clear all controls and set a predefined trim mode (Note: controls are intended here as those variables to be adjusted for attaining convergence of the trimming algorithm) More...

bool	SetResultsFile (string name)
	Set the file where trim analysis results are written, open and get ready. More...

void	SetState (double u0, double v0, double w0, double p0, double q0, double r0, double alpha0, double beta0, double phi0, double theta0, double psi0, double gamma0)
	Sets state variables. More...

void	SetTargetNlf (double nlf)
	Sets target normal load factor in steady turn. More...

void	SetTolerance (double tt)
	Set the tolerance for declaring a state trimmed. More...

void	SetTrimFailed (bool tf)
	Sets trim result status. More...

void	SetTrimSuccessfull ()

void	TrimStats ()
	Iteration statistics.

FGColumnVector3	UpdateRatesPullup (void)
	Updates angular rates for pull-up trim. More...

FGColumnVector3	UpdateRatesTurn (double psi, double theta, double phi, double phiW)
	Updates angular rates for turn trim according to turning trim constraints. 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...

Public Member Functions inherited from FGXMLFileRead
Element *	LoadXMLDocument (const SGPath &XML_filename, bool verbose=true)

Element *	LoadXMLDocument (const SGPath &XML_filename, FGXMLParse &fparse, bool verbose=true)

void	ResetParser (void)

Friends
class	Objective

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

Definition at line 330 of file FGTrimAnalysis.h.

Constructor & Destructor Documentation

◆ FGTrimAnalysis()

FGTrimAnalysis	(	FGFDMExec *	FDMExec,
		TrimAnalysisMode	tam = `taFull`
	)

Initializes the trimming class.

Parameters

FDMExec	pointer to a JSBSim executive object.
tam	trim mode

Definition at line 320 of file FGTrimAnalysis.cpp.

 {
   SetDebug(2);
 
   N=0;
 
   trim_failed = true;
 
   max_iterations=2500;
   stop_criterion="Stop-On-Delta";
 
   Debug=0;DebugLevel=0;
 
   fdmex=FDMExec;
 
   fgic=fdmex->GetIC();
   total_its=0;
   trimudot=true;
   gamma_fallback=true;
   ctrl_count=0;
   mode=tt;
   _targetNlf=1.0;
   _targetNlf=fgic->GetTargetNlfIC();
 
   _vtIC  = fgic->GetVtrueFpsIC();
   _hIC   = fgic->GetAltitudeFtIC();
   _gamma = fgic->GetFlightPathAngleRadIC();
   _rocIC = _vtIC*cos(_gamma);
   _vdownIC = _rocIC;
 
   // state variables
   _u       = fgic->GetUBodyFpsIC();
   _v       = fgic->GetVBodyFpsIC();
   _w       = fgic->GetWBodyFpsIC();
   _p       = fgic->GetPRadpsIC();
   _q       = fgic->GetQRadpsIC();
   _r       = fgic->GetRRadpsIC();
   _alpha   = fgic->GetAlphaRadIC();
   _beta    = fgic->GetBetaRadIC();
   _theta   = fgic->GetThetaRadIC();
   _phi     = fgic->GetPhiRadIC();
   _psiIC   = fgic->GetPsiRadIC();
   _psi     = _psiIC;
   _psigtIC = _psi;
 
   _phiW = _psiW = 0.0;
 
   _vgIC = _vtIC*cos(_gamma);
   _vnorthIC = _vgIC * cos(_psigtIC);
   _veastIC  = _vgIC * sin(_psigtIC);
   wnorthIC = _weastIC = _wdownIC = 0.;
 
   _udot=_vdot=_wdot=_pdot=_qdot=_rdot=0.;
   _psidot=_thetadot=0.;
   _psiWdot = _phiWdot = _gammadot = 0.;
 
   C1 = C2 = C3 = 1.0;
   _cbeta = cos(_beta);
   _sbeta = sin(_beta);
   _sphi = sin(_phi);
 
   SetMode(tt); // creates vTrimAnalysisControls
   fdmex->SetTrimMode( (int)tt );
 
   trim_id = "default-trim";
 
   // direct search stuff
   search_type = "Nelder-Mead";
   sigma_nm = 0.5; alpha_nm = 1.0; beta_nm = 0.5; gamma_nm = 2.0;
   initial_step = 0.01;
   tolerance = 1.0E-10; // 0.0000000001
   cost_function_value = 9999.0;
 
   rf_name = "";
   if (rf.is_open()) rf.close();
 
   Auxiliary    = fdmex->GetAuxiliary();
   Aerodynamics = fdmex->GetAerodynamics();
   Propulsion   = fdmex->GetPropulsion();
   FCS          = fdmex->GetFCS();
 }

Here is the call graph for this function:

Member Function Documentation

◆ AddControl()

bool AddControl ( TaControl control )

Add a control to the current configuration.

See the enums TaControl in FGTrimAnalysisControl.h for the available options. (Note: controls are intended here as those variables to be adjusted for attaining convergence of the trimming algorithm) Will fail if the given state is already configured.

Parameters

control the control to be adjusted in the trimming algorithm

Returns: true if add is successful

Definition at line 673 of file FGTrimAnalysis.cpp.

                                                    {
 
   FGTrimAnalysisControl* tac;
   bool result=true;
 
   mode = taCustom;
   vector <FGTrimAnalysisControl*>::iterator iControls = vTrimAnalysisControls.begin();
   while (iControls != vTrimAnalysisControls.end()) {
       tac=*iControls;
       if( tac->GetControlType() == control )
         result=false;
       iControls++;
   }
   if(result) {
     vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,control));
   }
   return result;
 }

Here is the call graph for this function:

◆ CalculatePhiWFromTargetNlfTurn()

void CalculatePhiWFromTargetNlfTurn ( double nlf )

Calculate the wind axis bank angle from a given Nlf (sets also the target Nlf)

Parameters

nlf

Definition at line 752 of file FGTrimAnalysis.cpp.

                                                              {
   if ( ( mode == taTurn ) || ( mode == taTurnFull ) ) {
      // target Nlf is given
      // set _phiW according to given Nlf
      _targetNlf = nlf;
      _phiW = atan2( sqrt(_targetNlf*_targetNlf-cos(_gamma)*cos(_gamma)), cos(_gamma) );
   }
 }

◆ ClearControls()

void ClearControls ( void )

Clear all controls from the current configuration.

The trimming routine must have at least one control configured to be useful (Note: controls are intended here as those variables to be adjusted for attaining convergence of the trimming algorithm)

Definition at line 653 of file FGTrimAnalysis.cpp.

                                        {
 
     FGTrimAnalysisControl* tac;
 
     mode=taCustom;
     vector<FGTrimAnalysisControl*>::iterator iControls;
     iControls = vTrimAnalysisControls.begin();
     while (iControls != vTrimAnalysisControls.end()) {
       tac=*iControls;
       delete tac;
 
       iControls++;
     }
 
     vTrimAnalysisControls.clear();
 
 }

◆ EditState()

bool EditState	(	TaControl	new_control,
		double	new_initvalue,
		double	new_step,
		double	new_min,
		double	new_max
	)

Change the control settings previously configured.

Parameters

new_control	the control used to zero the state
new_initvalue	a new initial value
new_step	a new adjusting step
new_min,new_max	a new range

Returns: true if editing is successful

Definition at line 717 of file FGTrimAnalysis.cpp.

                                                                                                                              {
   FGTrimAnalysisControl* tac;
   bool result=false;
 
   mode = taCustom;
   vector <FGTrimAnalysisControl*>::iterator iControls = vTrimAnalysisControls.begin();
   while (iControls != vTrimAnalysisControls.end()) {
       tac=*iControls;
       if( tac->GetControlType() == new_control ) {
         vTrimAnalysisControls.insert(iControls,1,new FGTrimAnalysisControl(fdmex,fgic,new_control));
         delete tac;
         vTrimAnalysisControls.erase(iControls+1);
         result=true;
         break;
       }
       iControls++;
   }
   return result;
 }

Here is the call graph for this function:

◆ GetCostFunctionValue()

double GetCostFunctionValue ( ) const

inline

Returns: The current cost function value

Definition at line 482 of file FGTrimAnalysis.h.

482 { return cost_function_value;}

◆ GetGamma()

double GetGamma ( void )

inline

Return the current flight path angle in TrimAnalysis object.

Returns: value of gamma

Definition at line 536 of file FGTrimAnalysis.h.

536 { return _gamma; }

Here is the caller graph for this function:

◆ GetGammaFallback()

bool GetGammaFallback ( void )

inline

query the fallback state

Returns: true if fallback is enabled.

Definition at line 548 of file FGTrimAnalysis.h.

548 { return gamma_fallback; }

◆ GetGammaRad()

double GetGammaRad ( )

inline

Gets flight path angle.

Returns: gamma [rad]

Definition at line 623 of file FGTrimAnalysis.h.

623 { return _gamma;}

Here is the caller graph for this function:

◆ GetMode()

TrimAnalysisMode GetMode ( ) const

inline

Returns: The Trim Analysis mode taLongitudinal, taFull, taGround, taCustom, or taNone

Definition at line 495 of file FGTrimAnalysis.h.

495 { return mode;};

Here is the caller graph for this function:

◆ GetPhiRad()

double GetPhiRad ( )

inline

Gets Euler angle phi.

Returns: phi [rad]

Definition at line 606 of file FGTrimAnalysis.h.

606 { return _phi;}

Here is the caller graph for this function:

◆ GetPhiWRad()

double GetPhiWRad ( )

inline

Gets Euler angle phiW (wind axes)

Returns: phiW [rad]

Definition at line 619 of file FGTrimAnalysis.h.

619 { return _phiW;}

Here is the caller graph for this function:

◆ GetPsiRad()

double GetPsiRad ( )

inline

Gets Euler angle psi.

Returns: phi [rad]

Definition at line 614 of file FGTrimAnalysis.h.

614 { return _psi;}

◆ GetResultsFile()

ofstream* GetResultsFile ( ) const

inline

Get the pointer to the file where trim analysis results are written,.

Returns: non null pointer if file is open

Definition at line 473 of file FGTrimAnalysis.h.

473 { if (rf.is_open()) return &rf; else return 0; } // const_cast<ofstream*>(&rf) (if rf is not mutable)

Here is the caller graph for this function:

◆ GetTargetNlf()

double GetTargetNlf ( void )

inline

Gets target normal load factor in steady turn.

Returns: _targetNlf

Definition at line 663 of file FGTrimAnalysis.h.

663 { return _targetNlf; }

Here is the caller graph for this function:

◆ GetThetaRad()

double GetThetaRad ( )

inline

Gets Euler angle theta.

Returns: phi [rad]

Definition at line 610 of file FGTrimAnalysis.h.

610 { return _theta;}

◆ GetTolerance()

double GetTolerance ( void )

inline

Get the tolerance for declaring a state trimmed.

Returns: tolerance.

Definition at line 569 of file FGTrimAnalysis.h.

569 {return tolerance; }

◆ GetTrimFailed()

bool GetTrimFailed ( void )

inline

Gets trim result status.

Returns: trim_failed (boolean)

Definition at line 578 of file FGTrimAnalysis.h.

578 { return trim_failed; }

◆ GetVtFps()

double GetVtFps ( )

inline

Gets true speed [fps] from IC.

Returns: Vt [fps]

Definition at line 627 of file FGTrimAnalysis.h.

627 { return _vtIC;}

Here is the caller graph for this function:

◆ Load()

bool Load	(	string	fname,
		bool	useStoredPath = `true`
	)

Loads the trim configuration from file.

Parameters

fname	The name of a trim configuration file
useStoredPath	true if the stored path to the trim config file should be used

Returns: true if successful

Definition at line 450 of file FGTrimAnalysis.cpp.

 {
     string name="", type="";
     string trimDef;
     Element *element=0, *trimCfg=0, *search_element=0, *output_element=0;
 
     string sep = "/";
 # ifdef macintosh
     sep = ";";
 # endif
 
     if( useStoredPath ) {
         trimDef = fdmex->GetFullAircraftPath() + sep + fname + ".xml";
     } else {
         trimDef = fname;
     }
 
     document = this->LoadXMLDocument(trimDef);
 
     trimCfg = document->FindElement("trim_config");
     if (!trimCfg) {
         cerr << "File: " << trimDef << " does not contain a trim configuration tag" << endl;
         return false;
     }
 
     name = trimCfg->GetAttributeValue("name");
     trim_id = name;
 
     // First, find "search" element that specifies the type of cost function minimum search
 
     search_element = trimCfg->FindElement("search");
     if (!search_element) {
         cerr << "Using the Nelder-Mead search algorithm (default)." << endl;
     } else {
         type = search_element->GetAttributeValue("type");
         if (type.size() > 0) search_type = type; // if search type is not set, default is already Nelder-Mead
         if (search_type == "Nelder-Mead") {
             // Read settings from search
             // Note: all of these have defaults set above
             if ( search_element->FindElement("sigma_nm") )
                 sigma_nm = search_element->FindElementValueAsNumber("sigma_nm");
             if ( search_element->FindElement("alpha_nm") )
                 alpha_nm = search_element->FindElementValueAsNumber("alpha_nm");
             if ( search_element->FindElement("beta_nm") )
                 beta_nm = search_element->FindElementValueAsNumber("beta_nm");
             if ( search_element->FindElement("gamma_nm") )
                 gamma_nm = search_element->FindElementValueAsNumber("gamma_nm");
         }
         // ToDo: manage all the other possible choices here
         // if (search_type == "Sequential-Multiple-Nelder-Mead") { }
         // if (search_type == "Multicompass") { }
         // etc ...
         if ( search_element->FindElement("tolerance") ) {
             tolerance = search_element->FindElement("tolerance")->GetAttributeValueAsNumber("value");
         }
         if ( search_element->FindElement("max_iterations") ) {
             max_iterations = (unsigned int)search_element->FindElement("max_iterations")->GetAttributeValueAsNumber("value");
         }
         if ( search_element->FindElement("stop_criterion") ) {
             stop_criterion = search_element->FindElement("stop_criterion")->GetAttributeValue("type");
         }
     }
 
     // Initialize trim controls based on what is in the trim config file. This
     // includes initial trim values (or defaults from the IC file) and step
     // size values.
 
     element = trimCfg->FindElement("phi");
     InitializeTrimControl(fgic->GetPhiRadIC(), element, "RAD", JSBSim::taPhi);
     if ( ( fabs(_phi) < 89.5*(FGJSBBase::degtorad ) ) && ( mode == taTurn ))
                 _targetNlf = 1./cos(_phi);
 
     element = trimCfg->FindElement("theta");
     InitializeTrimControl(fgic->GetThetaRadIC(), element, "RAD", JSBSim::taTheta);
     
     element = trimCfg->FindElement("psi");
     InitializeTrimControl(fgic->GetPsiRadIC(), element, "RAD", JSBSim::taHeading);
 
     element = trimCfg->FindElement("gamma");
     _gamma = fgic->GetFlightPathAngleRadIC();
     if (element)
       if (element->GetNumDataLines() > 0) _gamma = element->GetDataAsNumber();
 
     element = trimCfg->FindElement("nlf");
     if (element) {
       if (element->GetNumDataLines() > 0) _targetNlf = element->GetDataAsNumber();
       CalculatePhiWFromTargetNlfTurn(_targetNlf);
     }
 
     element = trimCfg->FindElement("throttle_cmd");
     if (element) InitializeTrimControl(0, element, "", JSBSim::taThrottle);
 
     element = trimCfg->FindElement("elevator_cmd");
     if (element) InitializeTrimControl(0, element, "", JSBSim::taElevator);
 
     element = trimCfg->FindElement("rudder_cmd");
     if (element) InitializeTrimControl(0, element, "", JSBSim::taRudder);
 
     element = trimCfg->FindElement("aileron_cmd");
     if (element) InitializeTrimControl(0, element, "", JSBSim::taAileron);
 
     output_element = trimCfg->FindElement("output_file");
     if (output_element) {
         rf_name = output_element->GetAttributeValue("name");
         if (rf_name.empty()) {
             cerr << "name must be specified in output_file \"name\" attribute."<< endl;
         } else {
             if ( !SetResultsFile(rf_name) )
                 cerr << "Unable to use output file "<< rf_name << endl;
         }
     }
     return true;
 }

Here is the call graph for this function:

◆ RemoveControl()

bool RemoveControl ( TaControl control )

Remove a specific control from the current configuration.

Parameters

control the state to remove

Returns: true if removal is successful

Definition at line 694 of file FGTrimAnalysis.cpp.

                                                       {
 
   FGTrimAnalysisControl* tac;
   bool result=false;
 
   mode = taCustom;
   vector <FGTrimAnalysisControl*>::iterator iControls = vTrimAnalysisControls.begin();
   while (iControls != vTrimAnalysisControls.end()) {
       tac=*iControls;
       if( tac->GetControlType() == control ) {
         delete tac;
         vTrimAnalysisControls.erase(iControls);
         result=true;
         continue;
       }
       iControls++;
   }
 
   return result;
 }

Here is the call graph for this function:

◆ Report()

void Report ( void )

Print the results of the trim.

For each axis trimmed, this includes the final state value, control value, and tolerance used.

Returns: true if trim succeeds

Definition at line 610 of file FGTrimAnalysis.cpp.

                                 {
 
     cout << "---------------------------------------------------------------------\n";
 
     cout << "Trim report: " << endl;
       cout << "\tTrim algorithm terminated with the following values:" << endl;
       cout << "\tu, v, w        (ft/s): " << _u <<", "<< _v <<", "<< _w << endl
            << "\tp, q, r       (rad/s): " << _p <<", "<< _q <<", "<< _r << endl
            << "\talpha, beta     (deg): " << _alpha*57.3 <<", "<< _beta*57.3 << endl
            << "\tphi, theta, psi (deg): " << _phi*57.3 <<", "<< _theta*57.3 << ", " << _psi*57.3 << endl
            << "\tCost function value  : " << cost_function_value << endl
            << "\tCycles executed      : " << total_its << endl << endl;
 
       cout << "\tTrim variables adjusted:" << endl;
       for (unsigned int i=0; i<vTrimAnalysisControls.size();i++){
           cout << "\t\t" << vTrimAnalysisControls[i]->GetControlName() <<": ";
           cout << vTrimAnalysisControls[i]->GetControl() << endl;
       }
       //...
 
       cout << endl;
 
       cout << "\t** Initial -> Final Conditions **" << endl;
       cout << "\tAlpha IC: " << fgic->GetAlphaDegIC() << " Degrees" << endl;
       cout << "\t   Final: " << Auxiliary->Getalpha()*57.3 << " Degrees" << endl;
       cout << "\tBeta  IC: " << fgic->GetBetaDegIC() << " Degrees" << endl;
       cout << "\t   Final: " << Auxiliary->Getbeta()*57.3 << " Degrees" << endl;
       cout << "\tGamma IC: " << fgic->GetFlightPathAngleDegIC() << " Degrees" << endl;
       cout << "\t   Final: " << Auxiliary->GetGamma()*57.3 << " Degrees" << endl;
       cout << "\tPhi IC  : " << fgic->GetPhiDegIC() << " Degrees" << endl;
       cout << "\t   Final: " << fdmex->GetPropagate()->GetEuler(1)*57.3 << " Degrees" << endl;
       cout << "\tTheta IC: " << fgic->GetThetaDegIC() << " Degrees" << endl;
       cout << "\t   Final: " << fdmex->GetPropagate()->GetEuler(2)*57.3 << " Degrees" << endl;
       cout << "\tPsi IC  : " << fgic->GetPsiDegIC() << " Degrees" << endl;
       cout << "\t   Final: " << fdmex->GetPropagate()->GetEuler(3)*57.3 << " Degrees" << endl;
       cout << endl;
       cout << "--------------------------------------------------------------------- \n\n";
 
       fdmex->EnableOutput();
 }

◆ SetCostFunctionValue()

void SetCostFunctionValue ( double value )

inline

Set the value of the cost function.

Parameters

value the cost function value

Definition at line 478 of file FGTrimAnalysis.h.

478 {cost_function_value = value;}

Here is the caller graph for this function:

◆ SetDottedValues()

void SetDottedValues	(	double	udot,
		double	vdot,
		double	wdot,
		double	pdot,
		double	qdot,
		double	rdot
	)

Sets Dotted values.

Parameters

udot,vdot,wdot,pdot,qdot,rdot

Definition at line 443 of file FGTrimAnalysis.cpp.

 {
     _udot=udot; _vdot=vdot; _wdot=wdot; _pdot=pdot; _qdot=qdot; _rdot=rdot;
 }

◆ SetEulerAngles()

void SetEulerAngles	(	double	phi0,
		double	theta0,
		double	psi0
	)

Sets Euler angles.

Parameters

phi0,theta0,psi0

Definition at line 432 of file FGTrimAnalysis.cpp.

 {
     // feed into private variables
     _phi = phi; _cphi = cos(_phi); _sphi = sin(_phi);
     _theta = theta; _ctheta = cos(_theta); _stheta = sin(_theta);
     _psi = psi; _cpsi = cos(_psi); _spsi = sin(_psi);
 
 }

Here is the caller graph for this function:

◆ SetGammaFallback()

void SetGammaFallback ( bool bb )

inline

automatically switch to trimming longitudinal acceleration with flight path angle (gamma) once it becomes apparent that there is not enough/too much thrust.

Parameters

bb	true to enable fallback

Definition at line 543 of file FGTrimAnalysis.h.

543 { gamma_fallback=bb; }

◆ SetMaxCycles()

void SetMaxCycles ( int ii )

inline

Set the iteration limit.

DoTrim() will return false if limit iterations are reached before trim is achieved. The default is 60. This does not ordinarily need to be changed.

Parameters

ii	integer iteration limit

Definition at line 555 of file FGTrimAnalysis.h.

555 { max_iterations = ii; }

◆ SetMode()

void SetMode ( TrimAnalysisMode tam )

Clear all controls and set a predefined trim mode (Note: controls are intended here as those variables to be adjusted for attaining convergence of the trimming algorithm)

Parameters

tam	the set of axes to trim. Can be: taLongitudinal, taFull, taGround, taCustom, or taNone

Definition at line 995 of file FGTrimAnalysis.cpp.

                                                 {
 
     ClearControls();
 
     cout << "---------------------------------------------------------------------" << endl;
     cout << "Trim analysis performed: ";
     mode=tt;
     switch(tt) {
       case taLongitudinal:
         if (debug_lvl > 0)
           cout << "  Longitudinal Trim" << endl;
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taThrottle ));
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taElevator )); // TODO: taPitchTrim
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taTheta ));
         break;
       case taFull:
         if (debug_lvl > 0)
           cout << "  Full Trim" << endl;
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taThrottle ));
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taElevator )); // TODO: taPitchTrim
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taAileron ));  // TODO: taRollTrim
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taRudder ));   // TODO: taYawTrim
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taPhi ));
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taTheta ));
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taHeading ));
         break;
       case taFullWingsLevel:
         if (debug_lvl > 0)
           cout << "  Full Trim, Wings-Level" << endl;
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taThrottle ));
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taElevator )); // TODO: taPitchTrim
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taAileron ));  // TODO: taRollTrim
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taRudder ));   // TODO: taYawTrim
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taTheta ));
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taHeading ));
         break;
       case taTurn:
           // ToDo: set target NLF here !!!
           // ToDo: assign psiDot here !!
         if (debug_lvl > 0)
           cout << "  Full Trim, Coordinated turn" << endl;
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taThrottle ));
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taElevator )); // TODO: taPitchTrim
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taAileron ));  // TODO: taRollTrim
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taRudder ));   // TODO: taYawTrim
         //vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taPhi ));
         //vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taTheta ));
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taHeading ));
         break;
       case taTurnFull:
         if (debug_lvl > 0)
           cout << "  Non-coordinated Turn Trim" << endl;
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taThrottle ));
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taElevator )); // TODO: taPitchTrim
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taAileron ));  // TODO: taRollTrim
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taRudder ));   // TODO: taYawTrim
         //vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taPhi ));
         // calculate this from target nlf
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taTheta ));
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taHeading ));
         break;
       case taPullup:
           // ToDo: set target NLF here !!!
           // ToDo: assign qDot here !!
         if (debug_lvl > 0)
           cout << "  Full Trim, Pullup" << endl;
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taThrottle ));
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taElevator )); // TODO: taPitchTrim
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taAileron ));
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taRudder ));
         //vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taPhi ));
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taTheta ));
         //vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taHeading ));
         break;
       case taGround:
         if (debug_lvl > 0)
           cout << "  Ground Trim" << endl;
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taAltAGL ));
         vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taTheta ));
         //vTrimAnalysisControls.push_back(new FGTrimAnalysisControl(fdmex,fgic,taPhi ));
         break;
       case taCustom:
         // agodemar...
         // ...agodemar
       case taNone:
         break;
     }
 
     current_ctrl=0;
 }

◆ SetResultsFile()

bool SetResultsFile ( string name )

Set the file where trim analysis results are written, open and get ready.

Parameters

name	the file name

Returns: true if file open is successful

Definition at line 1087 of file FGTrimAnalysis.cpp.

 {
     if ( rf.is_open() ) return false;
 
     rf_name = name;
     rf.open(rf_name.c_str(), ios::out);
     if ( !rf.is_open() ) {
        cerr << "Unable to open " << rf_name << endl;
        return false;
     }
     //rf << "# ... complete this " << endl;
     //rf << "# iteration, CostFunc, size, dT, dE, dA, dR, Psi (rad), Theta (rad), Phi (rad)\n";
     return true;
 }

Here is the call graph for this function:

◆ SetState()

void SetState	(	double	u0,
		double	v0,
		double	w0,
		double	p0,
		double	q0,
		double	r0,
		double	alpha0,
		double	beta0,
		double	phi0,
		double	theta0,
		double	psi0,
		double	gamma0
	)

Sets state variables.

Parameters

u0
v0
w0
p0
q0
r0
alpha0
beta0
phi0
psi0
theta0
gamma0

Definition at line 421 of file FGTrimAnalysis.cpp.

 {
   _u=u0; _v=v0; _w=w0;
   _p=p0; _q=q0; _r=r0;
   _alpha=alpha0; _beta=beta0; _gamma=gamma0;
   _theta=theta0; _phi=phi0; _psi=psi0;
 }

Here is the caller graph for this function:

◆ SetTargetNlf()

void SetTargetNlf ( double nlf )

inline

Sets target normal load factor in steady turn.

Parameters

nlf	target normal load factor

Definition at line 658 of file FGTrimAnalysis.h.

658 { _targetNlf=nlf; }

◆ SetTolerance()

void SetTolerance ( double tt )

inline

Set the tolerance for declaring a state trimmed.

(In the evaluation of the cost function, squares of angular accels are devided by 100) The default is 1e-8.

Parameters

tt	user defined tolerance

Definition at line 563 of file FGTrimAnalysis.h.

                                       {
     tolerance = tt;
   }

◆ SetTrimFailed()

void SetTrimFailed ( bool tf )

inline

Sets trim result status.

Parameters

tf (boolean)

Definition at line 574 of file FGTrimAnalysis.h.

574 { trim_failed = tf; }

◆ UpdateRatesPullup()

FGColumnVector3 UpdateRatesPullup ( void )

Updates angular rates for pull-up trim.

Returns: p, q, r

Definition at line 920 of file FGTrimAnalysis.cpp.

                                                      {
       double g,cgamma;
       g=fdmex->GetInertial()->gravity();
       cgamma=cos(fgic->GetFlightPathAngleRadIC());
       _p = 0;
       _q = g*(_targetNlf-cgamma)/fgic->GetVtrueFpsIC();
       _r = 0.;
 
       fgic->SetQRadpsIC(_q);
       return FGColumnVector3(_p,_q,_r);
 }

Here is the caller graph for this function:

◆ UpdateRatesTurn()

FGColumnVector3 UpdateRatesTurn	(	double	psi,
		double	theta,
		double	phi,
		double	phiW
	)

Updates angular rates for turn trim according to turning trim constraints.

Parameters

psi,theta,phi

Returns: p, q, r

Definition at line 914 of file FGTrimAnalysis.cpp.

                                                                                                 {
       _psi = psi;
       setupTurn(phiW); // calls updateRates: updates _p,_q,_r
       return FGColumnVector3(_p,_q,_r);
 }

Here is the caller graph for this function:

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

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FGTrimAnalysis()

Member Function Documentation

◆ AddControl()

◆ CalculatePhiWFromTargetNlfTurn()

◆ ClearControls()

◆ EditState()

◆ GetCostFunctionValue()

◆ GetGamma()

◆ GetGammaFallback()

◆ GetGammaRad()

◆ GetMode()

◆ GetPhiRad()

◆ GetPhiWRad()

◆ GetPsiRad()

◆ GetResultsFile()

◆ GetTargetNlf()

◆ GetThetaRad()

◆ GetTolerance()

◆ GetTrimFailed()

◆ GetVtFps()

◆ Load()

◆ RemoveControl()

◆ Report()

◆ SetCostFunctionValue()

◆ SetDottedValues()

◆ SetEulerAngles()

◆ SetGammaFallback()

◆ SetMaxCycles()

◆ SetMode()

◆ SetResultsFile()

◆ SetState()

◆ SetTargetNlf()

◆ SetTolerance()

◆ SetTrimFailed()

◆ UpdateRatesPullup()

◆ UpdateRatesTurn()