|
From: Bertrand C. <bco...@us...> - 2012-02-19 14:07:30
|
Update of /cvsroot/jsbsim/JSBSim/src/models
In directory vz-cvs-3.sog:/tmp/cvs-serv9844/src/models
Modified Files:
FGAccelerations.h
Log Message:
Updated the Doxygen documentation following the recent changes in FGAccelerations
Index: FGAccelerations.h
===================================================================
RCS file: /cvsroot/jsbsim/JSBSim/src/models/FGAccelerations.h,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -r1.11 -r1.12
*** FGAccelerations.h 18 Feb 2012 19:11:37 -0000 1.11
--- FGAccelerations.h 19 Feb 2012 14:07:27 -0000 1.12
***************
*** 75,78 ****
--- 75,100 ----
are evaluated.
+ JSBSim provides several ways to calculate the influence of the gravity on
+ the vehicle. The different options can be selected via the following
+ properties :
+ @property simulation/gravity-model (read/write) Selects the gravity model.
+ Two options are available : 0 (Standard gravity assuming the Earth
+ is spherical) or 1 (WGS84 gravity taking the Earth oblateness into
+ account). WGS84 gravity is the default.
+ @property simulation/gravitational-torque (read/write) Enables/disables the
+ calculations of the gravitational torque on the vehicle. This is
+ mainly relevant for spacecrafts that are orbiting at low altitudes.
+ Gravitational torque calculations are disabled by default.
+
+ Special care is taken in the calculations to obtain maximum fidelity in
+ JSBSim results. In FGAccelerations, this is obtained by avoiding as much as
+ possible the transformations from one frame to another. As a consequence,
+ the frames in which the accelerations are primarily evaluated are dictated
+ by the frames in which FGPropagate resolves the equations of movement (the
+ ECI frame for the translations and the body frame for the rotations).
+
+ @see Mark Harris and Robert Lyle, "Spacecraft Gravitational Torques",
+ NASA SP-8024, May 1969
+
@author Jon S. Berndt, Mathias Froehlich, Bertrand Coconnier
@version $Id$
***************
*** 243,247 ****
/** Retrieves a component of the total moments applied on the body.
Retrieves a component of the total moments applied on the body. This does
! include the moments generated by friction forces.
The vector for the total moments in the body frame is organized (Mx, My
, Mz). The vector is 1-based. In other words, GetMoments(1) returns Mx.
--- 265,270 ----
/** Retrieves a component of the total moments applied on the body.
Retrieves a component of the total moments applied on the body. This does
! include the moments generated by friction forces and the gravitational
! torque (if the property \e simulation/gravitational-torque is set to true).
The vector for the total moments in the body frame is organized (Mx, My
, Mz). The vector is 1-based. In other words, GetMoments(1) returns Mx.
|