FGBuoyantForces Class Reference

#include <FGBuoyantForces.h>

Inherits FGModel, and FGXMLFileRead.

List of all members.

---

Detailed Description

This class owns and contains the list of force/coefficients that define the Buoyant properties of an air vehicle.

Here's an example of a gas cell specification:

    <buoyant_forces>

      <!-- Interface properties -->
      <property>ballonets/in-flow-ft3ps[0]</property>

      <gas_cell type="HYDROGEN">
        <location unit="M">
          <x> 18.8 </x>
          <y> 0.0 </y>
          <z> 0.0 </z>
        </location>
        <x_radius unit="M"> 22.86 </x_radius>
        <y_radius unit="M">  4.55 </y_radius>
        <z_radius unit="M">  4.55 </z_radius>
        <max_overpressure unit="PA"> 340.0 </max_overpressure> 
        <valve_coefficient unit="M4*SEC/KG"> 0.015 </valve_coefficient>
      </gas_cell>
      
      ... {other gas cells} ...
      
    </buoyant_forces>

See FGGasCell for the full configuration file format for gas cells.

Author:

Anders Gidenstam, Jon S. Berndt

Version:

Id

FGBuoyantForces.h,v 1.7 2009/04/14 18:48:14 andgi Exp

Definition at line 106 of file FGBuoyantForces.h.

Public Member Functions
	FGBuoyantForces (FGFDMExec *Executive)
	Constructor.
string	GetBuoyancyStrings (string delimeter)
	Gets the strings for the current set of gas cells.
string	GetBuoyancyValues (string delimeter)
	Gets the coefficient values.
const FGColumnVector3 &	GetForces (void) const
	Gets the total Buoyant force vector.
double	GetGasMass (void)
	Gets the total gas mass.
const FGMatrix33 &	GetGasMassInertia (void)
	Gets the total moments of inertia for the gas mass.
const FGColumnVector3 &	GetGasMassMoment (void)
	Gets the total moment from the gas mass.
const FGColumnVector3 &	GetMoments (void) const
	Gets the total Buoyancy moment vector.
bool	InitModel (void)
bool	Load (Element *element)
	Loads the Buoyant forces model.
bool	Run (void)
	Runs the Buoyant forces model; called by the Executive.
	~FGBuoyantForces ()
	Destructor.

---

Constructor & Destructor Documentation

FGBuoyantForces

(

FGFDMExec *

Executive

)

Parameters:

Executive

a pointer to the parent executive object

Definition at line 52 of file FGBuoyantForces.cpp.

---

Member Function Documentation

string GetBuoyancyStrings

(

string

delimeter

)

Parameters:

delimeter

either a tab or comma string depending on output type

Returns:

a string containing the descriptive names for all parameters

Definition at line 215 of file FGBuoyantForces.cpp.

string GetBuoyancyValues

(

string

delimeter

)

Parameters:

delimeter

either a tab or comma string depending on output type

Returns:

a string containing the numeric values for the current set of parameters

Definition at line 245 of file FGBuoyantForces.cpp.

const FGColumnVector3& GetForces

(

void

)

const [inline]

Returns:

a force vector.

Definition at line 131 of file FGBuoyantForces.h.

double GetGasMass

(

void

)

The gas mass is part of the aircraft's inertia.

Returns:

mass in slugs.

Definition at line 165 of file FGBuoyantForces.cpp.

const FGMatrix33 & GetGasMassInertia

(

void

)

Returns:

.

Definition at line 189 of file FGBuoyantForces.cpp.

const FGColumnVector3 & GetGasMassMoment

(

void

)

Returns:

a moment vector.

Definition at line 178 of file FGBuoyantForces.cpp.

const FGColumnVector3& GetMoments

(

void

)

const [inline]

Returns:

a moment vector.

Definition at line 135 of file FGBuoyantForces.h.

bool Load

(

Element *

element

)

[virtual]

The Load function for this class expects the XML parser to have found the Buoyant_forces keyword in the configuration file.

Parameters:

element

pointer to the current XML element for Buoyant forces parameters.

Returns:

true if successful

Reimplemented from FGModel.

Definition at line 113 of file FGBuoyantForces.cpp.

bool Run

(

void

)

[virtual]

Returns:

false if no error

Reimplemented from FGModel.

Definition at line 93 of file FGBuoyantForces.cpp.

---

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

• FGBuoyantForces.h
• FGBuoyantForces.cpp