FDM/flight.cxx

   1 // flight.c -- a general interface to the various flight models
   2 //
   3 // Written by Curtis Olson, started May 1997.
   4 //
   5 // Copyright (C) 1997  Curtis L. Olson  - curt@infoplane.com
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22 // (Log is kept at end of this file)
  23
  24
  25 #include <stdio.h>
  26
  27 #include "flight.hxx"
  28 #include "LaRCsim.hxx"
  29
  30 #include <Debug/logstream.hxx>
  31 #include <Flight/External/external.hxx>
  32 #include <Flight/LaRCsim/ls_interface.h>
  33 #include <Include/fg_constants.h>
  34 #include <Math/fg_geodesy.hxx>
  35
  36
  37 // base_fdm_state is the internal state that is updated in integer
  38 // multiples of "dt".  This leads to "jitter" with respect to the real
  39 // world time, so we introduce cur_fdm_state which is extrapolated by
  40 // the difference between sim time and real world time
  41
  42 FGState cur_fdm_state;
  43 FGState base_fdm_state;
  44
  45
  46 // Initialize the flight model parameters
  47 int fgFlightModelInit(int model, FGState& f, double dt) {
  48     double save_alt = 0.0;
  49
  50     FG_LOG( FG_FLIGHT ,FG_INFO, "Initializing flight model" );
  51
  52     base_fdm_state = f;
  53
  54     if ( model == FGState::FG_SLEW ) {
  55         // fgSlewInit(dt);
  56     } else if ( model == FGState::FG_LARCSIM ) {
  57
  58         // lets try to avoid really screwing up the LaRCsim model
  59         if ( base_fdm_state.get_Altitude() < -9000.0 ) {
  60             save_alt = base_fdm_state.get_Altitude();
  61             base_fdm_state.set_Altitude( 0.0 );
  62         }
  63
  64         // translate FG to LaRCsim structure
  65         FGState_2_LaRCsim(base_fdm_state);
  66
  67         // initialize LaRCsim
  68         fgLaRCsimInit(dt);
  69
  70         FG_LOG( FG_FLIGHT, FG_INFO, "FG pos = " <<
  71                 base_fdm_state.get_Latitude() );
  72
  73         // translate LaRCsim back to FG structure
  74         fgLaRCsim_2_FGState(base_fdm_state);
  75
  76         // but lets restore our original bogus altitude when we are done
  77         if ( save_alt < -9000.0 ) {
  78             base_fdm_state.set_Altitude( save_alt );
  79         }
  80     } else if ( model == FGState::FG_EXTERNAL ) {
  81         fgExternalInit(base_fdm_state, dt);
  82     } else {
  83         FG_LOG( FG_FLIGHT, FG_WARN,
  84                   "Unimplemented flight model == " << model );
  85     }
  86
  87     f = base_fdm_state;
  88
  89     return 1;
  90 }
  91
  92
  93 // Run multiloop iterations of the flight model
  94 int fgFlightModelUpdate(int model, FGState& f, int multiloop, int jitter) {
  95     double time_step, start_elev, end_elev;
  96
  97     // printf("Altitude = %.2f\n", FG_Altitude * 0.3048);
  98
  99     // base_fdm_state = f;
 100
 101     time_step = (1.0 / DEFAULT_MODEL_HZ) * multiloop;
 102     start_elev = base_fdm_state.get_Altitude();
 103
 104     if ( model == FGState::FG_SLEW ) {
 105         // fgSlewUpdate(f, multiloop);
 106     } else if ( model == FGState::FG_LARCSIM ) {
 107         fgLaRCsimUpdate(base_fdm_state, multiloop);
 108     } else if ( model == FGState::FG_EXTERNAL ) {
 109         // fgExternalUpdate(f, multiloop);
 110     } else {
 111         FG_LOG( FG_FLIGHT, FG_WARN,
 112                 "Unimplemented flight model == " <<  model );
 113     }
 114
 115     end_elev = base_fdm_state.get_Altitude();
 116
 117     if ( time_step > 0.0 ) {
 118         // feet per second
 119         base_fdm_state.set_Climb_Rate( (end_elev - start_elev) / time_step );
 120     }
 121
 122     f = base_fdm_state;
 123
 124     return 1;
 125 }
 126
 127
 128 // Set the altitude (force)
 129 void fgFlightModelSetAltitude(int model, double alt_meters) {
 130     double sea_level_radius_meters;
 131     double lat_geoc;
 132
 133     // Set the FG variables first
 134     fgGeodToGeoc( base_fdm_state.get_Latitude(), alt_meters,
 135                   &sea_level_radius_meters, &lat_geoc);
 136
 137     base_fdm_state.set_Altitude( alt_meters * METER_TO_FEET );
 138     base_fdm_state.set_Radius_to_vehicle( base_fdm_state.get_Altitude() +
 139                                           (sea_level_radius_meters *
 140                                            METER_TO_FEET) );
 141
 142     // additional work needed for some flight models
 143     if ( model == FGState::FG_LARCSIM ) {
 144         ls_ForceAltitude( base_fdm_state.get_Altitude() );
 145     }
 146 }
 147
 148
 149 // $Log$
 150 // Revision 1.8  1999/01/08 03:23:51  curt
 151 // Beginning work on compensating for sim time vs. real world time "jitter".
 152 //
 153 // Revision 1.7  1998/12/18 23:37:07  curt
 154 // Collapsed out the FGState variables not currently needed.  They are just
 155 // commented out and can be readded easily at any time.  The point of this
 156 // exersize is to determine which variables were or were not currently being
 157 // used.
 158 //
 159 // Revision 1.6  1998/12/05 15:54:11  curt
 160 // Renamed class fgFLIGHT to class FGState as per request by JSB.
 161 //
 162 // Revision 1.5  1998/12/04 01:29:39  curt
 163 // Stubbed in a new flight model called "External" which is expected to be driven
 164 // from some external source.
 165 //
 166 // Revision 1.4  1998/12/03 01:16:40  curt
 167 // Converted fgFLIGHT to a class.
 168 //
 169 // Revision 1.3  1998/11/06 21:18:03  curt
 170 // Converted to new logstream debugging facility.  This allows release
 171 // builds with no messages at all (and no performance impact) by using
 172 // the -DFG_NDEBUGNDEBUG flag.
 173 //
 174 // Revision 1.2  1998/10/16 23:27:40  curt
 175 // C++-ifying.
 176 //
 177 // Revision 1.1  1998/10/16 20:16:41  curt
 178 // Renamed flight.[ch] to flight.[ch]xx
 179 //
 180 // Revision 1.19  1998/09/29 14:57:38  curt
 181 // c++-ified comments.
 182 //
 183 // Revision 1.18  1998/09/29 02:02:40  curt
 184 // Added a rate of climb calculation.
 185 //
 186 // Revision 1.17  1998/08/24 20:09:07  curt
 187 // .
 188 //
 189 // Revision 1.16  1998/08/22  14:49:55  curt
 190 // Attempting to iron out seg faults and crashes.
 191 // Did some shuffling to fix a initialization order problem between view
 192 // position, scenery elevation.
 193 //
 194 // Revision 1.15  1998/07/30 23:44:36  curt
 195 // Beginning to add support for multiple flight models.
 196 //
 197 // Revision 1.14  1998/07/12 03:08:27  curt
 198 // Added fgFlightModelSetAltitude() to force the altitude to something
 199 // other than the current altitude.  LaRCsim doesn't let you do this by just
 200 // changing FG_Altitude.
 201 //
 202 // Revision 1.13  1998/04/25 22:06:28  curt
 203 // Edited cvs log messages in source files ... bad bad bad!
 204 //
 205 // Revision 1.12  1998/04/21 16:59:33  curt
 206 // Integrated autopilot.
 207 // Prepairing for C++ integration.
 208 //
 209 // Revision 1.11  1998/04/18 04:14:04  curt
 210 // Moved fg_debug.c to it's own library.
 211 //
 212 // Revision 1.10  1998/02/07 15:29:37  curt
 213 // Incorporated HUD changes and struct/typedef changes from Charlie Hotchkiss
 214 // <chotchkiss@namg.us.anritsu.com>
 215 //
 216 // Revision 1.9  1998/01/27 00:47:53  curt
 217 // Incorporated Paul Bleisch's <pbleisch@acm.org> new debug message
 218 // system and commandline/config file processing code.
 219 //
 220 // Revision 1.8  1998/01/19 19:27:03  curt
 221 // Merged in make system changes from Bob Kuehne <rpk@sgi.com>
 222 // This should simplify things tremendously.
 223 //
 224 // Revision 1.7  1998/01/19 18:40:23  curt
 225 // Tons of little changes to clean up the code and to remove fatal errors
 226 // when building with the c++ compiler.
 227 //
 228 // Revision 1.6  1998/01/19 18:35:43  curt
 229 // Minor tweaks and fixes for cygwin32.
 230 //
 231 // Revision 1.5  1997/12/30 20:47:37  curt
 232 // Integrated new event manager with subsystem initializations.
 233 //
 234 // Revision 1.4  1997/12/10 22:37:42  curt
 235 // Prepended "fg" on the name of all global structures that didn't have it yet.
 236 // i.e. "struct WEATHER {}" became "struct fgWEATHER {}"
 237 //
 238 // Revision 1.3  1997/08/27 03:30:04  curt
 239 // Changed naming scheme of basic shared structures.
 240 //
 241 // Revision 1.2  1997/05/29 22:39:57  curt
 242 // Working on incorporating the LaRCsim flight model.
 243 //
 244 // Revision 1.1  1997/05/29 02:35:04  curt
 245 // Initial revision.
 246 //