Detailed Description

Manages the external and/or arbitrary forces and moments.

The external reactions capability in JSBSim really should be named "arbitrary forces and moments", because this feature can be used to model a wide variety of forces and moments that act on a vehicle. Some examples include: parachutes, catapult, arresting hook, and tow line.

This class acts similarly to the other "manager classes" (FGPropulsion, FGFCS, FGGroundReactions, FGAerodynamics) because it manages collections of constituent elements. The individual forces and moments are implemented with the FGExternalForce class.

The format of the optional external reactions section in the config file is as follows:

<external_reactions>
 
  <!-- Interface properties, a.k.a. property declarations -->
  <property> ... </property>
    
  <force name="name" frame="BODY | LOCAL | WIND">
    ...
  </force>
  <moment name="name" frame="BODY | LOCAL | WIND">
    ...
  </moment>
 
  <!-- Additional force and moment definitions may follow -->
  <force name="name" frame="BODY | LOCAL | WIND">
    ...
  </force>
  <moment name="name" frame="BODY | LOCAL | WIND">
    ...
  </moment>
 
</external_reactions>

See the FGExternalForce class for more information on the format of the force and moment specifications.

When force or moment elements are encountered in the configuration file, a new instance of the FGExternalForce class is created and a pointer to the class is pushed onto the Forces vector.

This class is one of a few of the manager classes that allows properties to be "declared". In code, these are represented by the interface_properties vector. Properties that have not yet been created in an already parsed section of the configuration file and that are used in the definition of an external force or moment should be declared in the external_reactions section because they will not be created automatically, and so would cause an error, since the property cannot be found to exist.

See the FGExternalForce documentation for details on how forces and moments are actually calculated.

Definition at line 122 of file FGExternalReactions.h.

#include <FGExternalReactions.h>

Inheritance diagram for FGExternalReactions:

Collaboration diagram for FGExternalReactions:

Public Member Functions
	FGExternalReactions (const FGExternalReactions &)=delete
	The model owns its forces, so it cannot be copied.

	FGExternalReactions (FGFDMExec *fdmex)
	Constructor.

	~FGExternalReactions (void) override
	Destructor.

void	Add (std::unique_ptr< FGExternalForce > force)
	Adds a force or moment created in code to the external reactions.

double	GetForces (int idx) const

const FGColumnVector3 &	GetForces (void) const
	Retrieves the total forces defined in the external reactions.

double	GetMoments (int idx) const

const FGColumnVector3 &	GetMoments (void) const
	Retrieves the total moment resulting from the forces defined in the external reactions.

bool	InitModel (void) override

bool	Load (Element *el) override
	Loads the external forces from the XML configuration file.

FGExternalReactions &	operator= (const FGExternalReactions &)=delete

bool	Run (bool Holding) override
	Sum all the constituent forces for this cycle.

Public Member Functions inherited from FGModel
	FGModel (FGFDMExec *, const std::string &name)
	Constructor.

	~FGModel () override
	Destructor.

virtual SGPath	FindFullPathName (const SGPath &path) const

FGFDMExec *	GetExec (void) const

const std::string &	GetName (void) const

unsigned int	GetRate (void) const
	Get the output rate for the model in frames.

bool	InitModel (void) override

void	SetPropertyManager (std::shared_ptr< FGPropertyManager > fgpm)

void	SetRate (unsigned int tt)
	Set the ouput rate for the model in frames.

Public Member Functions inherited from FGModelFunctions
std::string	GetFunctionStrings (const std::string &delimeter) const
	Gets the strings for the current set of functions.

std::string	GetFunctionValues (const std::string &delimeter) const
	Gets the function values.

std::shared_ptr< FGFunction >	GetPreFunction (const std::string &name)
	Get one of the "pre" function.

bool	Load (Element el, FGFDMExec fdmex, std::string prefix="")

void	PostLoad (Element el, FGFDMExec fdmex, std::string prefix="")

void	PreLoad (Element el, FGFDMExec fdmex, std::string prefix="")

void	RunPostFunctions (void)

void	RunPreFunctions (void)

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

virtual	~FGJSBBase ()
	Destructor for FGJSBBase.

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

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

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

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

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

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

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

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

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

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

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

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

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

static constexpr 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.

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

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

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

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

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

static const std::string &	GetVersion (void)
	Returns the version number of JSBSim.

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

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

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

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

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

static constexpr double	sign (double num)

Static Public Attributes inherited from FGJSBBase
static short	debug_lvl = 1

Protected Member Functions inherited from FGModel
bool	Upload (Element *el, bool preLoad)
	Uploads this model in memory.

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

Protected Attributes inherited from FGModel
bool	enabled = true

unsigned int	exe_ctr

FGFDMExec *	FDMExec

std::string	Name

std::shared_ptr< FGPropertyManager >	PropertyManager

unsigned int	rate

Protected Attributes inherited from FGModelFunctions
FGPropertyReader	LocalProperties

std::vector< std::shared_ptr< FGFunction > >	PostFunctions

std::vector< std::shared_ptr< FGFunction > >	PreFunctions

Static Protected Attributes inherited from FGJSBBase
static constexpr double	degtorad = M_PI / 180.

static constexpr double	fpstokts = 1.0 / ktstofps

static constexpr double	fttom = 0.3048

static constexpr double	hptoftlbssec = 550.0

static constexpr double	in3tom3 = inchtoftinchtoftinchtoft/m3toft3

static constexpr double	inchtoft = 1.0/12.0

static constexpr double	inhgtopa = 3386.38

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

static constexpr double	kgtolb = 2.20462

static constexpr double	kgtoslug = 0.06852168

static constexpr double	ktstofps = 1852./(3600*fttom)

static constexpr double	lbtoslug = 1.0/slugtolb

static constexpr double	m3toft3 = 1.0/(fttomfttomfttom)

static const std::string	needed_cfg_version = "2.0"

static constexpr double	psftoinhg = 0.014138

static constexpr double	psftopa = 47.88

static constexpr double	radtodeg = 180. / M_PI

static constexpr double	slugtolb = 32.174049
	Note that definition of lbtoslug by the inverse of slugtolb and not to a different constant you can also get from some tables will make lbtoslug*slugtolb == 1 up to the magnitude of roundoff.

Constructor & Destructor Documentation

◆ FGExternalReactions()

FGExternalReactions ( FGFDMExec * fdmex )

Constructor.

Parameters

fdmex pointer to the main executive class.

Definition at line 53 of file FGExternalReactions.cpp.

                                                         : FGModel(fdmex, "FGExternalReactions")
{
  bind();
  Debug(0);
}

◆ ~FGExternalReactions()

~FGExternalReactions ( void )

override

Destructor.

The forces are held by unique_ptr and released automatically.

Definition at line 100 of file FGExternalReactions.cpp.

{
  Debug(1);
}

Member Function Documentation

◆ Add()

void Add ( std::unique_ptr< FGExternalForce > force )

Adds a force or moment created in code to the external reactions.

A host hands over its own FGExternalForce, or a class derived from it, and ownership passes to FGExternalReactions through the unique_ptr. Whether the object acts as a force or a moment is decided by how it was set up, so both are added the same way. The forces and moments properties are tied when the model is constructed, so a force added to an aircraft that declares no external_reactions element is reported like any other.

Parameters

force the force or moment to add. A null pointer is ignored.

Definition at line 92 of file FGExternalReactions.cpp.

{
  if (!force) return;
  Forces.push_back(std::move(force));
}

Here is the caller graph for this function:

◆ GetForces() [1/2]

double GetForces ( int idx ) const

inline

Definition at line 173 of file FGExternalReactions.h.

173{return vTotalForces(idx);}

◆ GetForces() [2/2]

const FGColumnVector3 & GetForces ( void ) const

inline

Retrieves the total forces defined in the external reactions.

Returns: the total force in pounds.

Definition at line 172 of file FGExternalReactions.h.

172{return vTotalForces;}

◆ GetMoments() [1/2]

double GetMoments ( int idx ) const

inline

Definition at line 179 of file FGExternalReactions.h.

179{return vTotalMoments(idx);}

◆ GetMoments() [2/2]

const FGColumnVector3 & GetMoments ( void ) const

inline

Retrieves the total moment resulting from the forces defined in the external reactions.

Returns: the total moment in foot-pounds.

Definition at line 178 of file FGExternalReactions.h.

178{return vTotalMoments;}

◆ InitModel()

bool InitModel ( void )

overridevirtual

Reimplemented from FGModelFunctions.

Definition at line 107 of file FGExternalReactions.cpp.

{
  if (!FGModel::InitModel()) return false;
 
  vTotalForces.InitMatrix();
  vTotalMoments.InitMatrix();
 
  return true;
}

◆ Load()

bool Load ( Element * el )

overridevirtual

Loads the external forces from the XML configuration file.

If the external_reactions section is encountered in the vehicle configuration file, this Load() method is called. All external forces will be parsed, and a FGExternalForce object will be instantiated for each force definition.

Parameters

el	a pointer to the XML element holding the external reactions definition.

Reimplemented from FGModel.

Definition at line 61 of file FGExternalReactions.cpp.

{
  // Call the base class Load() function to load interface properties.
  if (!FGModel::Upload(el, true))
    return false;
 
  Debug(2);
 
  Element* force_element = el->FindElement("force");
  while (force_element) {
    auto force = std::make_unique<FGExternalForce>(FDMExec);
    force->setForce(force_element);
    Add(std::move(force));
    force_element = el->FindNextElement("force");
  }
 
  Element* moment_element = el->FindElement("moment");
  while (moment_element) {
    auto moment = std::make_unique<FGExternalForce>(FDMExec);
    moment->setMoment(moment_element);
    Add(std::move(moment));
    moment_element = el->FindNextElement("moment");
  }
 
  PostLoad(el, FDMExec);
 
  return true;
}

Here is the call graph for this function:

◆ Run()

bool Run ( bool Holding )

overridevirtual

Sum all the constituent forces for this cycle.

Can pass in a value indicating if the executive is directing the simulation to Hold.

Parameters

Holding if true, the executive has been directed to hold the sim from advancing time. Some models may ignore this flag, such as the Input model, which may need to be active to listen on a socket for the "Resume" command to be given.

Returns: true always.

Reimplemented from FGModel.

Definition at line 119 of file FGExternalReactions.cpp.

{
  if (FGModel::Run(Holding)) return true;
  if (Holding) return false; // if paused don't execute
  if (Forces.empty()) return true;
 
  RunPreFunctions();
 
  vTotalForces.InitMatrix();
  vTotalMoments.InitMatrix();
 
  for (unsigned int i=0; i<Forces.size(); i++) {
    vTotalForces  += Forces[i]->GetBodyForces();
    vTotalMoments += Forces[i]->GetMoments();
  }
 
  RunPostFunctions();
 
  return false;
}

Here is the call graph for this function:

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

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ FGExternalReactions()

◆ ~FGExternalReactions()

Member Function Documentation

◆ Add()

◆ GetForces() [1/2]

◆ GetForces() [2/2]

◆ GetMoments() [1/2]

◆ GetMoments() [2/2]

◆ InitModel()

◆ Load()

◆ Run()