docs-mini/README.uiuc

   1 ************************************************
   2 *                                              *
   3 *  FGFS Reconfigurable Aircraft Flight Model   *
   4 *  Input File Documentation                    *
   5 *  Version 0.64, March 28, 2000                *
   6 *                                              *
   7 *  Authors:                                    *
   8 *  Jeff Scott (jscott@mail.com)                *
   9 *  Bipin Sehgal (bsehgal@uiuc.edu)             *
  10 *  Michael Selig (m-selig@uiuc.edu)            *
  11 *  Dept of Aero and Astro Engineering          *
  12 *  University of Illinois at Urbana-Champaign  *
  13 *  Urbana, IL                                  *
  14 *  http://amber.aae.uiuc.edu/~m-selig          *
  15 *                                              *
  16 ************************************************
  17
  18
  19 **********************************************************************
  20 This documentation includes:
  21  - Required and optional input lines.
  22  - Input line formats and conventions.
  23
  24   Viewing this file in emacs makefile-mode with color makes this file
  25   easier to read.
  26 **********************************************************************
  27
  28 **********************************************************************
  29 I. Conventions and Notations and Reading this Document:
  30
  31  # ...     Comments
  32  |         Input line not yet implemented
  33  |         Optional data
  34  |         Sometimes indicates a feature not yet used,
  35            but proposed convention is indicated nevertheless.
  36  <...>     Value or file name to be placed here
  37  ||        Input line disabled
  38  ||        Option disabled
  39  ...       Repeat similar data
  40  ->        Continue onto next line
  41 **********************************************************************
  42
  43 **********************************************************************
  44 II. General Input Line Format:
  45
  46 Examples input lines include
  47
  48 Cm Cmo 0.194            # []          Bray pg 33
  49 Cm Cm_a -2.12           # [/rad]      Bray pg 33
  50 CL CLfa CLfa.dat        # []          Bray pg 50, Table 4.7
  51
  52 These follow the more general input line form
  53
  54 keyword  variableName  <value -or- file> | ->
  55     <value -or- file>  # [units]  <data source>
  56
  57 Each term of the input line will be discussed in turn.
  58
  59 (1) KEYWORDS
  60 ============
  61
  62 There currently exist 15 types of variable keywords:
  63
  64 init            Initial values for equation of motion
  65 geometry        Aircraft-specific geometric quantities
  66 controlSurface  Control surface deflections and properties
  67 |controlsMixer  Control surface mixer options
  68 mass            Aircraft-specific mass properties
  69 engine          Propulsion data
  70 CD              Aerodynamic x-force quantities (longitudinal)
  71 CL              Aerodynamic z-force quantities (longitudinal)
  72 Cm              Aerodynamic m-moment quantities (longitudinal)
  73 CY              Aerodynamic y-force quantities (lateral)
  74 Cl              Aerodynamic l-moment quantities (lateral)
  75 Cn              Aerodynamic n-moment quantities (lateral)
  76 |gear           Landing gear model quantities
  77 ice             Icing model parameters
  78 record          Record desired quantites to file
  79
  80 As each line of the input file is read, the code recognizes the
  81 keyword, enters the appropriate switch statement in the code, and
  82 proceeds to read the next term in the input line.
  83
  84 (2) VARIABLE NAMES
  85 ==================
  86
  87 The variable name indicates the form of the variable itself.  This
  88 form may be a constant, a stability derivative (a specific form of a
  89 constant), or a variable-dimensional lookup table.  More variable
  90 types can be easily prescribed by defining a new convention.  The
  91 variable name may also indicate that the quantity is to be calculated
  92 from a hard-coded equation or set of equations provided at an
  93 appropriate location within the code.
  94
  95 If the parameter name denotes a constant, a numerical value will
  96 follow the variable name.  If a lookup table, the name of the table
  97 containing the data will follow.
  98
  99 More than one value or file name can be specified if the code is
 100 intended to read in multiple pieces of data when implementing the
 101 particular switch in question (see also OPTIONAL data, section (3)).
 102
 103 The conventions used for naming the variables are provided below.
 104 Several of these variable names are not currently used.
 105
 106 1) variable class
 107 _       denotes stability derivative to be multiplied by something
 108 f       "function of" (indicates an m*n matrix data table is given)
 109
 110 2) timing data (global simulator variables)
 111 Simtime   current simulator time         [s]
 112 dt        current simulator time step    [s]
 113
 114 3) aircraft state variables
 115 Dx_pilot   x-location                    [ft]
 116 Dy_pilot   y-location                    [ft]
 117 Dz_pilot   z-location                    [ft]
 118 Dx_cg      center of gravity x-location  [ft]
 119 Dy_cg      center of gravity y-location  [ft]
 120 Dz_cg      center of gravity z-location  [ft]
 121 V_north    x-velocity                    [ft/s]
 122 V_east     y-velocity                    [ft/s]
 123 V_down     z-velocity                    [ft/s]
 124 V_rel_wind total velocity                [ft/s]
 125 Dynamic_pressure  dynamic pressure       [lb/ft^2]
 126 Alpha      angle of attack               [rad]
 127 Alpha_dot  rate of change of alpha       [rad/s]
 128 Beta       sideslip angle                [rad]
 129 Beta_dot   rate of change of beta        [rad]
 130 Gamma      flight path angle             [rad]
 131 P_body     roll rate                     [rad/s]
 132 Q_body     pitch rate                    [rad/s]
 133 R_body     yaw rate                      [rad/s]
 134 Phi        bank angle                    [rad]
 135 Theta      pitch attitude angle          [rad]
 136 Theta_dot  rate change of theta          [rad/s]
 137 Psi        heading angle                 [rad]
 138 |long_trim
 139 |trim_inc
 140 M          Mach number                   []
 141 Re         Reynolds number               []
 142
 143 4) atmosphere properties
 144 Density    air density                   [slug/ft^3]
 145
 146 5) geometric variables
 147 bw        wingspan                       [ft]
 148 cbar      mean aerodynamic chord         [ft]
 149 Sw        wing planform area             [ft^2]
 150 iw        wing incidence angle           [deg]
 151 bc        canard span                    [ft]
 152 cc        canard (mean) chord            [ft]
 153 Sc        canard area                    [ft^2]
 154 ic        canard incidence angle         [deg]
 155 bh        horizontal tail span           [ft]
 156 ch        horizontal tail (mean) chord   [ft]
 157 Sh        horizontal tail area           [ft^2]
 158 ih        horizontal tail incidence angle [deg]
 159 bv        vertical tail span (height)    [ft]
 160 cv        vertical tail (mean) chord     [ft]
 161 iv        vertical tail incidence angle  [deg]
 162 Sv        vertical tail area             [ft^2]
 163
 164 6) control surface properties
 165 Sa            aileron area               [ft^2]
 166 Se            elevator area              [ft^2]
 167 Sf            flap area                  [ft^2]
 168 Sr            rudder area                [ft^2]
 169 Lat_control   roll control input         [?]
 170 Long_control  pitch control input        [?]
 171 Rudder_pedal  yaw control input          [?]
 172 aileron       aileron deflection         [rad]
 173 elevator      elevator deflection        [rad]
 174 rudder        rudder deflection          [rad]
 175 |flap         flap deflection            [rad]
 176
 177 7) mass variables
 178 |Weight   gross takeoff weight           [lb]
 179 Mass      aircraft mass (used by LaRC)   [slug]
 180 I_xx      roll inertia                   [slug-ft^2]
 181 I_yy      pitch inertia                  [slug-ft^2]
 182 I_zz      yaw inertia                    [slug-ft^2]
 183 I_xz      lateral cross inertia          [slug-ft^2]
 184
 185 8) engine/propulsion variables
 186 |thrust       thrust                          [lb]
 187 simpleSingle  simple single engine max thrust [lb]
 188 |Throttle_pct throttle input                  []  # ie, this is the stick
 189 |Throttle[3]  throttle deflection             [%] # this is what gets used to determine thrust
 190
 191 9) force/moment coefficients
 192 CD        coefficient of drag            []
 193 CY        coefficient of side-force      []
 194 CL        coefficient of lift            []
 195 Cl        coefficient of roll moment     []
 196 Cm        coefficient of pitching moment []
 197 Cn        coefficient of yaw moment      []
 198 |CT       coefficient of thrust          []
 199
 200 10) total forces/moments
 201 F_X_wind    aerodynamic x-force in wind-axes    [lb]
 202 F_Y_wind    aerodynamic y-force in wind-axes    [lb]
 203 F_Z_wind    aerodynamic z-force in wind-axes    [lb]
 204 F_X_aero    aerodynamic x-force in body-axes    [lb]
 205 F_Y_aero    aerodynamic y-force in body-axes    [lb]
 206 F_Z_aero    aerodynamic z-force in body-axes    [lb]
 207 F_X_engine  propulsion x-force in body axes     [lb]
 208 F_Y_engine  propulsion y-force in body axes     [lb]
 209 F_Z_engine  propulsion z-force in body axes     [lb]
 210 F_X_gear    gear x-force in body axes           [lb]
 211 F_Y_gear    gear y-force in body axes           [lb]
 212 F_Z_gear    gear z-force in body axes           [lb]
 213 F_X         total x-force                       [lb]
 214 F_Y         total y-force                       [lb]
 215 F_Z         total z-force                       [lb]
 216 M_l_aero    aero roll-moment in body-axes       [ft-lb]
 217 M_m_aero    aero pitch-moment in body-axes      [ft-lb]
 218 M_n_aero    aero yaw-moment in body-axes        [ft-lb]
 219 M_l_engine  prop roll-moment in body axes       [ft-lb]
 220 M_m_engine  prop pitch-moment in body axes      [ft-lb]
 221 M_n_engine  prop yaw-moment in body axes        [ft-lb]
 222 M_l_gear    gear roll-moment in body axes       [ft-lb]
 223 M_m_gear    gear pitch-moment in body axes      [ft-lb]
 224 M_n_gear    gear yaw-moment in body axes        [ft-lb]
 225 M_l_rp      total roll-moment                   [ft-lb]
 226 M_m_rp      total pitch-moment                  [ft-lb]
 227 M_n_rp      total yaw-moment                    [ft-lb]
 228
 229 11) landing gear properties
 230 |cgear  gear damping constant            [?]
 231 |kgear  gear spring constant             [?]
 232 |muGear gear rolling friction coef       [?]
 233 |strutLength  gear strut length          [ft]
 234
 235 12) icing model parameters
 236 iceTime       time when icing begins                         [s]
 237 transientTime time period over which eta increases to final  [s]
 238 eta_final     icing severity factor at end of transient time [-]
 239 kCA           icing constants for associated aero coef.      [-] (see IV)
 240
 241 13) subscripts
 242 o       value for all angles = 0 (alfa, beta, etc)
 243 a       angle of attack
 244 adot    rate change in angle alpha
 245 beta    sideslip angle
 246 |betadot  rate change in beta
 247 p       roll rate
 248 q       pitch rate
 249 r       yaw rate
 250 |pdot   rate change in p
 251 |qdot   rate change in q
 252 |rdot   rate change in r
 253 |udot   rate change in x-velocity
 254 da      aileron deflection
 255 de      elevator deflection
 256 dr      rudder deflection
 257 df      flap deflection
 258 |df2    flap deflection for second set
 259 |df3    flap deflection for third set
 260 max     maximum
 261 min     minimum
 262
 263 (3) | [OPTIONAL DATA]
 264 =====================
 265
 266 An input line may also be used to provide optional data that
 267 will be used if provided but is not necessary for the code to
 268 operate.  As with the variable data described in section (2), multiple
 269 values or data files may be provided if the code is written to use
 270 them.
 271
 272 (4) # [COMMENTS]
 273 ================
 274
 275 Appended comments should be provided with each input line to indicate
 276 units on the variable in question and to indicate the source the data
 277 was drawn from.
 278 **********************************************************************
 279
 280 **********************************************************************
 281 III. Sample Input Lines:
 282
 283 CONSTANTS
 284 =========
 285
 286 geometry bw <value>     # geometric parameter, wingspan
 287 Cm Cm_a <value>         # stability derivative, d(Cm)/d(alpha)
 288 controlSurface de <value> <value>  # max and min elevator deflections
 289
 290 LOOKUP TABLES
 291 =============
 292
 293 CD CDfCL <file.dat>     # CD(CL), drag polar data file
 294 Cm Cmfade <file.dat>    # Cm(alpha,delta_e), moment data file
 295
 296 HARD-CODED EQUATION
 297 ===================
 298
 299 CD CDfCL                # CD(CL), drag calculated in code based on CL
 300
 301 **********************************************************************
 302
 303 **********************************************************************
 304 IV. Input Line Definitions:
 305
 306 Of all the possible permutations of variable names described above in
 307 section II, only some are curently implemented in the code.  These are
 308 described below.  Comments, denoted by '#,' are used to define the
 309 lines and to indicate examples of the data if additional clarity is
 310 needed for unique situations.  Again, those lines beginning with '|'
 311 are not currently implemented in the code, but indicate planned
 312 conventions in later versions.
 313
 314 # Key  Variable  Data      Units      Description                       Where Defined
 315 #------------------------------------------------------------------------------------
 316
 317 init Dx_pilot <Dx_pilot> # [ft]       initial x-position                ls_generic.h
 318 init Dy_pilot <Dy_pilot> # [ft]       initial y-position                ls_generic.h
 319 init Dz_pilot <Dz_pilot> # [ft]       initial z-position                ls_generic.h
 320 init Dx_cg <Dx_cg>       # [ft]       initial cg x_location             ls_generic.h
 321 init Dy_cg <Dy_cg>       # [ft]       initial cg y_location             ls_generic.h
 322 init Dz_cg <Dz_cg>       # [ft]       initial cg z_location             ls_generic.h
 323 |init V_north <V_north>  # [ft/s]     initial x-velocity                ls_generic.h
 324 |init V_east <V_east>    # [ft/s]     initial y-velocity                ls_generic.h
 325 |init V_down <V_down>    # [ft/s]     initial z-velocity                ls_generic.h
 326 init P_body <P_body>     # [rad/s]    initial roll rate                 ls_generic.h
 327 init Q_body <Q_body>     # [rad/s]    initial pitch rate                ls_generic.h
 328 init R_body <R_body>     # [rad/s]    initial yaw rate                  ls_generic.h
 329 init Phi <Phi>           # [rad]      initial bank angle                ls_generic.h
 330 init Theta <Theta>       # [rad]      initial pitch attitude angle      ls_generic.h
 331 init Psi <Psi>           # [rad]      initial heading angle             ls_generic.h
 332
 333 geometry bw <bw>        # [ft]        wingspan                          uiuc_aircraft.h
 334 geometry cbar <cbar>    # [ft]        wing mean aero chord              uiuc_aircraft.h
 335 geometry Sw <Sw>        # [ft^2]      wing reference area               uiuc_aircraft.h
 336 |geometry iw <iw>       # [deg]       wing incidence angle              uiuc_aircraft.h
 337 |geometry bc <bc>       # [ft]        canard span                       uiuc_aircraft.h
 338 |geometry cc <cc>       # [ft]        canard chord                      uiuc_aircraft.h
 339 |geometry Sc <Sc>       # [sq-ft]     canard area                       uiuc_aircraft.h
 340 |geometry ic <ic>       # [deg]       canard incidence angle            uiuc_aircraft.h
 341 |geometry bh <bh>       # [ft]        horizontal tail span              uiuc_aircraft.h
 342 |geometry ch <ch>       # [ft]        horizontal tail chord             uiuc_aircraft.h
 343 |geometry Sh <Sh>       # [sq-ft]     horizontal tail area              uiuc_aircraft.h
 344 |geometry ih <ih>       # [deg]       horiz tail incidence angle        uiuc_aircraft.h
 345 |geometry bv <bv>       # [ft]        vertical tail span                uiuc_aircraft.h
 346 |geometry cv <cv>       # [ft]        vertical tail chord               uiuc_aircraft.h
 347 |geometry Sv <Sv>       # [sq-ft]     vertical tail area                uiuc_aircraft.h
 348 |geometry iv <iv>       # [deg]       vert tail incidence angle         uiuc_aircraft.h
 349
 350 |controlSurface Se <Se>  # [ft^2]     elevator area                     uiuc_aircraft.h
 351 |controlSurface Sa <Sa>  # [ft^2]     aileron area                      uiuc_aircraft.h
 352 |controlSurface Sr <Sr>  # [ft^2]     rudder area                       uiuc_aircraft.h
 353 |controlSurface Sf <Sf>  # [ft^2]     flap area                         uiuc_aircraft.h
 354 controlSurface de <demax> <demin>   # [deg]  max/min elev deflections   uiuc_aircraft.h
 355 controlSurface da <damax> <damin>   # [deg]  max/min ail deflections    uiuc_aircraft.h
 356 controlSurface dr <drmax> <drmin>   # [deg]  max/min rud deflections    uiuc_aircraft.h
 357 |controlSurface df <dfmax> <dfmin>  # [deg]  max/min flap deflections   uiuc_aircraft.h
 358 # Note: Currently demin is not used in the code, and the max/min is +-demax.
 359
 360
 361 |controlsMixer nomix <?> # []         no controls mixing                uiuc_aircraft.h
 362
 363 |mass Weight <Weight>   # [lb]        gross takeoff weight (not used)
 364 mass Mass <Mass>        # [slug]      gross takeoff mass                ls_generic.h
 365 mass I_xx <I_xx>        # [slug-ft^2] roll inertia                      ls_generic.h
 366 mass I_yy <I_yy>        # [slug-ft^2] pitch inertia                     ls_generic.h
 367 mass I_zz <I_zz>        # [slug-ft^2] yaw inertia                       ls_generic.h
 368 mass I_xz <I_xz>        # [slug-ft^2] lateral cross inertia             ls_generic.h
 369
 370
 371 # maximum and minimum engine thrust                             [lb]    uiuc_aircraft.h
 372 |engine thrust <thrustMax> <thrustMin>
 373
 374 # simple single engine maximum thrust                           [lb]    uiuc_aircraft.h
 375 engine simpleSingle <simpleSingleMaxThrust>
 376
 377 engine c172             # use Cessna 172 engine model of Tony Peden
 378
 379
 380 CL CLo <CLo>            # []          lift coef for all angles = 0      uiuc_aircraft.h
 381 CL CL_a <CL_a>          # [/rad]      lift curve slope, d(CL)/d(alpha)  uiuc_aircraft.h
 382 CL CL_adot <CL_adot>    # [/rad]      d(CL)/d(alpha)/da(time)           uiuc_aircraft.h
 383 CL CL_q <CL_q>          # [/rad]      d(CL)/delta(q)                    uiuc_aircraft.h
 384 CL CL_de <CL_de>        # [/rad]      d(CL)/d(de)                       uiuc_aircraft.h
 385
 386 # CL(alpha), conversion for CL, for alpha                           []  uiuc_aircraft.h
 387 CL CLfa <CLfa.dat> <conversion1> <conversion2>
 388
 389 # CL(alpha,delta_e), conversion for CL, for alpha, for delta_e      []  uiuc_aircraft.h
 390 CL CLfade <CLfade.dat> <conversion1> <conversion2> <conversion3>
 391
 392 |CL CLfCT <CLfCT.dat>   #             CL(thrust coef)                   uiuc_aircraft.h
 393 |CL CLfRe               #             CL(Reynolds #), equation          uiuc_aircraft.h
 394 |CL CL_afaM <CL_afaM.dat> #           CL_alpha(alpha,Mach #)            uiuc_aircraft.h
 395    # these are sample examples that might be used in later versions of the code
 396
 397
 398 # note that CD terms must come after CL for induced drag to be computed
 399 CD CDo <CDo>            # []          drag coef for all angles = 0      uiuc_aircraft.h
 400 CD CDK <CDK>            # []          constant, as in CD=CDo+K*CL^2     uiuc_aircraft.h
 401 CD CD_a <CD_a>          # [/rad]      d(CD)/d(alpha)                    uiuc_aircraft.h
 402 CD CD_de <CD_de>        # [/rad]      d(CD)/d(delta_e)                  uiuc_aircraft.h
 403
 404 # CD(alpha), conversion for CD, for alpha                           []  uiuc_aircraft.h
 405 CD CDfa <CDfa.dat> <conversion1> <conversion2>
 406
 407 # CD(alpha,delta_e), conversion for CD, for alpha, for delta_e      []  uiuc_aircraft.h
 408 CD CDfade <CDfade.dat> <conversion1> <conversion2> <conversion3>
 409
 410
 411 Cm Cmo <Cmo>            # []          pitch mom coef for all angles=0   uiuc_aircraft.h
 412 Cm Cm_a <Cm_a>          # [/rad]      d(Cm)/d(alpha)                    uiuc_aircraft.h
 413 Cm Cm_adot <Cm_adot>    # [/rad]      d(Cm)/d(alpha)/d(time)            uiuc_aircraft.h
 414 Cm Cm_q <Cm_q>          # [/rad]      d(Cm)/d(q)                        uiuc_aircraft.h
 415 Cm Cm_de <Cm_de>        # [/rad]      d(Cm)/d(de)                       uiuc_aircraft.h
 416 |Cm Cmfa <Cmfa.dat>     # []          Cm(alpha)                         uiuc_aircraft.h
 417 Cm Cmfade <Cmfade.dat>  # []          Cm(alpha,delta_e)                 uiuc_aircraft.h
 418
 419 # Cm(alpha,delta_e), conversion for Cm, for alpha, for delta_e      []  uiuc_aircraft.h
 420 Cm Cmfade <Cmfade.dat> <conversion1> <conversion2> <conversion3>
 421
 422
 423 CY CYo <CYo>            # []          side-force coef for all angles=0  uiuc_aircraft.h
 424 CY CY_beta <CY_beta>    # [/rad]      d(CY)/d(beta)                     uiuc_aircraft.h
 425 CY CY_p <CY_p>          # [/rad]      d(CY)/d(p)                        uiuc_aircraft.h
 426 CY CY_r <CY_r>          # [/rad]      d(CY)/d(r)                        uiuc_aircraft.h
 427 CY CY_da <CY_da>        # [/rad]      d(CY)/d(delta_a)                  uiuc_aircraft.h
 428 CY CY_dr <CY_dr>        # [/rad]      d(CY)/d(delta_r)                  uiuc_aircraft.h
 429
 430 # CY(alpha,delta_a), conversion for CY, for alpha, for delta_a      []  uiuc_aircraft.h
 431 CY CYfada <CYfada.dat> <conversion1> <conversion2> <conversion3>
 432
 433 # CY(beta,delta_r), conversion for CY, for beta, for delta_r        []  uiuc_aircraft.h
 434 CY CYfbetadr <CYfbetadr.dat> <conversion1> <conversion2> <conversion3>
 435
 436
 437 Cl Clo <Clo>            # []          roll mom coef for all angles=0    uiuc_aircraft.h
 438 Cl Cl_beta <Cl_beta>    # [/rad]      d(Cl)/d(beta)                     uiuc_aircraft.h
 439 Cl Cl_betafCL           # [/rad]      Cl_beta(CL) equation              uiuc_aircraft.h
 440 Cl Cl_p <Cl_p>          # [/rad]      d(Cl)/d(p)                        uiuc_aircraft.h
 441 Cl Cl_r <Cl_r>          # [/rad]      d(Cl)/d(r)                        uiuc_aircraft.h
 442 Cl Cl_rfCL              # [/rad]      Cl_r(CL) equation                 uiuc_aircraft.h
 443 Cl Cl_da <Cl_da>        # [/rad]      d(Cl)/d(delta_a)                  uiuc_aircraft.h
 444 Cl Cl_dr <Cl_dr>        # [/rad]      d(Cl)/d(delta_r)                  uiuc_aircraft.h
 445 Cl Clfada               # []          Cl(alpha,delta_a), equation       uiuc_aircraft.h
 446
 447 # Cl(alpha,delta_a), conversion for Cl, for alpha, for delta_a      []  uiuc_aircraft.h
 448 Cl Clfada <CYfada.dat> <conversion1> <conversion2> <conversion3>
 449
 450 # Cl(beta,delta_r), conversion for Cl, for beta, for delta_r        []  uiuc_aircraft.h
 451 Cl Clfbetadr <CYfbetadr.dat> <conversion1> <conversion2> <conversion3>
 452
 453
 454 Cn Cno <Cno>            # []          yaw mom coef for all angles=0     uiuc_aircraft.h
 455 Cn Cn_beta <Cn_beta>    # [/rad]      d(Cn)/d(beta)                     uiuc_aircraft.h
 456 Cn Cn_betafCL           # [/rad]      Cn_beta(CL) equation              uiuc_aircraft.h
 457 Cn Cn_p <Cn_p>          # [/rad]      d(Cn)/d(p)                        uiuc_aircraft.h
 458 Cn Cn_pfCL              # [/rad]      Cn_p(CL) equation                 uiuc_aircraft.h
 459 Cn Cn_r <Cn_r>          # [/rad]      d(Cn)/d(r)                        uiuc_aircraft.h
 460 Cn Cn_rfCL              # [/rad]      Cn_r(CL) equation                 uiuc_aircraft.h
 461 Cn Cn_da <Cn_da>        # [/rad]      d(Cn)/d(da)                       uiuc_aircraft.h
 462 Cn Cn_dr <Cn_dr>        # [/rad]      d(Cn)/d(dr)                       uiuc_aircraft.h
 463 Cn Cn_drfCL             # [/rad]      Cn_dr(CL) equation                uiuc_aircraft.h
 464
 465 # Cn(alpha,delta_a), conversion for Cn, for alpha, for delta_a      []  uiuc_aircraft.h
 466 Cn Cnfada <Cnfada.dat> <conversion1> <conversion2> <conversion3>
 467
 468 # Cn(beta,delta_r), conversion for Cn, for beta, for delta_r        []  uiuc_aircraft.h
 469 Cn Cnfbetadr <Cnfbetadr.dat> <conversion1> <conversion2> <conversion3>
 470
 471 =============================CONVERSION CODES================================
 472
 473 To calculate the aero forces, angles (eg, alfa, beta, elevator deflection, etc)
 474 must be in radians.  To convert input data in degree to radian, use a
 475 conversion code of 1.  To use no conversion, use a conversion code of 0.
 476
 477 ------------------------------------------------
 478 conversion1
 479 conversion2
 480 conversion3   Action
 481 ------------------------------------------------
 482   0           no conversion (multiply by 1)
 483   1           convert degrees to radians
 484 =============================================================================
 485
 486 |gear kgear <kgear>     # []          gear spring constant(s)           uiuc_aircraft.h
 487 |gear muRoll <muRoll>   # []          gear rolling friction coef(s)     uiuc_aircraft.h
 488 |gear cgear <cgear>     # []          gear damping constant(s)          uiuc_aircraft.h
 489 |gear strutLength <sL>  # [ft]        gear strut length                 uiuc_aircraft.h
 490
 491 ice iceTime <iceTime>   # [s]         time when icing begins            uiuc_aircraft.h
 492 ice transientTime <tT>  # [s]         period for eta to reach eta_final uiuc_aircraft.h
 493 ice eta_final <eta_f>   # []          icing severity factor             uiuc_aircraft.h
 494 ice kCDo <kCDo>         # []          icing constant for CDo            uiuc_aircraft.h
 495 ice kCDK <kCDo>         # []          icing constant for CDK            uiuc_aircraft.h
 496 ice kCD_a <kCD_a>       # []          icing constant for CD_a           uiuc_aircraft.h
 497 |ice kCD_q <kCD_q>      # []          icing constant for CD_q           uiuc_aircraft.h
 498 ice kCD_de <kCD_de>     # []          icing constant for CD_de          uiuc_aircraft.h
 499 |ice kCD_dr <kCD_dr>    # []          icing constant for CD_dr          uiuc_aircraft.h
 500 |ice kCD_df <kCD_df>    # []          icing constant for CD_df          uiuc_aircraft.h
 501 |ice kCD_adf <kCD_adf>  # []          icing constant for CD_adf         uiuc_aircraft.h
 502 ice kCLo <kCLo>         # []          icing constant for CLo            uiuc_aircraft.h
 503 ice kCL_a <kCL_a>       # []          icing constant for CL_a           uiuc_aircraft.h
 504 ice kCL_adot <kCL_adot> # []          icing constant for CL_adot        uiuc_aircraft.h
 505 ice kCL_q <kCL_q>       # []          icing constant for CL_q           uiuc_aircraft.h
 506 ice kCL_de <kCL_de>     # []          icing constant for CL_de          uiuc_aircraft.h
 507 |ice kCL_df <kCL_df>    # []          icing constant for CL_df          uiuc_aircraft.h
 508 |ice kCL_adf <kCL_adf>  # []          icing constant for CL_adf         uiuc_aircraft.h
 509 ice kCmo <kCmo>         # []          icing constant for Cmo            uiuc_aircraft.h
 510 ice kCm_a <kCm_a>       # []          icing constant for Cm_a           uiuc_aircraft.h
 511 ice kCm_adot <kCm_adot> # []          icing constant for Cm_adot        uiuc_aircraft.h
 512 ice kCm_q <kCm_q>       # []          icing constant for Cm_q           uiuc_aircraft.h
 513 |ice kCm_r <kCm_r>      # []          icing constant for Cm_r           uiuc_aircraft.h
 514 ice kCm_de <kCm_de>     # []          icing constant for Cm_de          uiuc_aircraft.h
 515 |ice kCm_df <kCm_df>    # []          icing constant for Cm_df          uiuc_aircraft.h
 516 ice kCYo <kCYo>         # []          icing constant for CYo            uiuc_aircraft.h
 517 ice kCY_beta <kCy_beta> # []          icing constant for CY_beta        uiuc_aircraft.h
 518 ice kCY_p <kCY_p>       # []          icing constant for CY_p           uiuc_aircraft.h
 519 ice kCY_r <kCY_r>       # []          icing constant for CY_r           uiuc_aircraft.h
 520 ice kCY_da <kCY_da>     # []          icing constant for CY_da          uiuc_aircraft.h
 521 ice kCY_dr <kCY_dr>     # []          icing constant for CY_dr          uiuc_aircraft.h
 522 ice kClo <kClo>         # []          icing constant for Clo            uiuc_aircraft.h
 523 ice kCl_beta <kCl_beta> # []          icing constant for Cl_beta        uiuc_aircraft.h
 524 ice kCl_p <kCl_p>       # []          icing constant for Cl_p           uiuc_aircraft.h
 525 ice kCl_r <kCl_r>       # []          icing constant for Cl_r           uiuc_aircraft.h
 526 ice kCl_da <kCl_da>     # []          icing constant for Cl_da          uiuc_aircraft.h
 527 ice kCl_dr <kCl_dr>     # []          icing constant for Cl_dr          uiuc_aircraft.h
 528 ice kCno <kCno>         # []          icing constant for Cno            uiuc_aircraft.h
 529 ice kCn_beta <kCn_beta> # []          icing constant for Cn_beta        uiuc_aircraft.h
 530 ice kCn_p <kCn_p>       # []          icing constant for Cn_p           uiuc_aircraft.h
 531 ice kCn_r <kCn_r>       # []          icing constant for Cn_r           uiuc_aircraft.h
 532 ice kCn_da <kCn_da>     # []          icing constant for Cn_da          uiuc_aircraft.h
 533 ice kCn_dr <kCn_dr>     # []          icing constant for Cn_dr          uiuc_aircraft.h
 534
 535 record Dx_pilot               # [ft]      x-location                    ls_generic.h
 536 record Dy_pilot               # [ft]      y-loaction                    ls_generic.h
 537 record Dz_pilot               # [ft]      z-location                    ls_generic.h
 538 record Dx_cg                  # [ft]      cg x_location                 ls_generic.h
 539 record Dy_cg                  # [ft]      cg y_location                 ls_generic.h
 540 record Dz_cg                  # [ft]      cg z_location                 ls_generic.h
 541 record V_north                # [ft/s]    x-velocity                    ls_generic.h
 542 record V_east                 # [ft/s]    y-velocity                    ls_generic.h
 543 record V_down                 # [ft/s]    z-velocity                    ls_generic.h
 544 record V_rel_wind             # [ft/s]    total velocity                ls_generic.h
 545 record Dynamic_pressure       # [lb/ft^2] dynamic pressure              ls_generic.h
 546 record Alpha                  # [rad]     angle of attack               ls_generic.h
 547 record Alpha_dot              # [rad/s]   rate of change of alpha       ls_generic.h
 548 record Beta                   # [rad]     sideslip angle                ls_generic.h
 549 record Beta_dot               # [rad/s]   rate of change of beta        ls_generic.h
 550 record Gamma                  # [rad]     flight path angle             ls_generic.h
 551 record P_body                 # [rad]     roll rate                     ls_generic.h
 552 record Q_body                 # [rad]     pitch rate                    ls_generic.h
 553 record R_body                 # [rad]     yaw rate                      ls_generic.h
 554 record Phi                    # [rad]     bank angle                    ls_generic.h
 555 record Theta                  # [rad]     pitch attitude angle          ls_generic.h
 556 record Theta_dot              # [rad]     rate change of theta          ls_generic.h
 557 record Psi                    # [rad]     heading angle                 ls_generic.h
 558 |record long_trim
 559 |record trim_inc
 560 record Density                # [slug/ft^3] air density                 ls_generic.h
 561 record Mass                   # [slug]    aircraft mass                 ls_generic.h
 562 record Simtime                # [s]       current sim time              global
 563 record dt                     # [s]       current time step             global
 564 record Long_control           # []        pitch input                   ls_cockpit.h
 565 record Lat_control            # []        roll input                    ls_cockpit.h
 566 record Rudder_pedal           # []        yaw input                     ls_cockpit.h
 567 |record Throttle_pct          # [%]       throttle input                ls_cockpit.h
 568 record elevator               # [rad]     elevator deflection           uiuc_aircraft.h
 569 record aileron                # [rad]     aileron deflection            uiuc_aircraft.h
 570 record rudder                 # [rad]     rudder deflection             uiuc_aircraft.h
 571 |record Throttle[3]           # [%]       throttle deflection           ls_cockpit.h
 572 record CDfaI                  # []        CD(alpha)                     uiuc_aircraft.h
 573 record CDfadeI                # []        CD(alpha,delta_e)             uiuc_aircraft.h
 574 record CD                     # []        drag coefficient              uiuc_aircraft.h
 575 record CLfaI                  # []        CL(alpha)                     uiuc_aircraft.h
 576 record CLfadeI                # []        CL(alpha,delta_e)             uiuc_aircraft.h
 577 record CL                     # []        lift coefficient              uiuc_aircraft.h
 578 record CmfadeI                # []        Cm(alpha,delta_e)             uiuc_aircraft.h
 579 record Cm                     # []        pitch moment coefficient      uiuc_aircraft.h
 580 record CYfadaI                # []        CY(alpha,delta_a)             uiuc_aircraft.h
 581 record CYfbetadrI             # []        CY(beta,delta_r)              uiuc_aircraft.h
 582 record CY                     # []        side-force coefficient        uiuc_aircraft.h
 583 record ClfadaI                # []        Cl(alpha,delta_a)             uiuc_aircraft.h
 584 record ClfbetadrI             # []        Cl(beta,delta_r)              uiuc_aircraft.h
 585 record Cl                     # []        roll moment coefficient       uiuc_aircraft.h
 586 record CnfadaI                # []        Cn(alpha,delta_a)             uiuc_aircraft.h
 587 record CnfbetadrI             # []        Cn(beta,delta_r)              uiuc_aircraft.h
 588 record Cn                     # []        yaw moment coefficient        uiuc_aircraft.h
 589 record F_X_wind               # [lb]      aero x-force in wind-axes     ls_generic.h
 590 record F_Y_wind               # [lb]      aero y-force in wind-axes     ls_generic.h
 591 record F_Z_wind               # [lb]      aero z-force in wind-axes     ls_generic.h
 592 record F_X_aero               # [lb]      aero x-force in body-axes     ls_generic.h
 593 record F_Y_aero               # [lb]      aero y-force in body-axes     ls_generic.h
 594 record F_Z_aero               # [lb]      aero z-force in body-axes     ls_generic.h
 595 record F_X_engine             # [lb]      prop x-force in body-axes     ls_generic.h
 596 record F_Y_engine             # [lb]      prop y-force in body-axes     ls_generic.h
 597 record F_Z_engine             # [lb]      prop z-force in body-axes     ls_generic.h
 598 record F_X_gear               # [lb]      gear x-force in body-axes     ls_generic.h
 599 record F_Y_gear               # [lb]      gear y-force in body-axes     ls_generic.h
 600 record F_Z_gear               # [lb]      gear z-force in body-axes     ls_generic.h
 601 record F_X                    # [lb]      total x-force in body-axes    ls_generic.h
 602 record F_Y                    # [lb]      total y-force in body-axes    ls_generic.h
 603 record F_Z                    # [lb]      total z-force in body-axes    ls_generic.h
 604 record M_l_aero               # [ft-lb]   aero roll mom in body axes    ls_generic.h
 605 record M_m_aero               # [ft-lb]   aero pitch mom in body axes   ls_generic.h
 606 record M_n_aero               # [ft-lb]   aero yaw mom in body axes     ls_generic.h
 607 record M_l_engine             # [ft-lb]   prop roll mom in body axes    ls_generic.h
 608 record M_m_engine             # [ft-lb]   prop pitch mom in body axes   ls_generic.h
 609 record M_n_engine             # [ft-lb]   prop yaw mom in body axes     ls_generic.h
 610 record M_l_gear               # [ft-lb]   gear roll mom in body axes    ls_generic.h
 611 record M_m_gear               # [ft-lb]   gear pitch mom in body axes   ls_generic.h
 612 record M_n_gear               # [ft-lb]   gear yaw mom in body axes     ls_generic.h
 613 record M_l_rp                 # [ft-lb]   total roll mom in body axes   ls_generic.h
 614 record M_m_rp                 # [ft-lb]   total pitch mom in body axes  ls_generic.h
 615 record M_n_rp                 # [ft-lb]   total yaw mom in body axes    ls_generic.h
 616
 617 **********************************************************************
 618
 619 **********************************************************************
 620 V. Mandatory Input:
 621
 622 The following data is required for the simulator to function;
 623 otherwise either the UIUC Aero Model or LaRCsim parts of the code will
 624 probably crash.
 625
 626 1) initial aircraft state  (LaRCsim)
 627 Dx_pilot   x-location                    [ft]
 628 Dy_pilot   y-location                    [ft]
 629 Dz_pilot   z-location                    [ft]
 630
 631 (items below causing conflict with Flight Gear)
 632 |V_north   x-velocity                    [ft/s]
 633 |V_east    y-velocity                    [ft/s]
 634 |V_down    z-velocity                    [ft/s]
 635
 636 P_body     roll rate                     [rad/s]
 637 Q_body     pitch rate                    [rad/s]
 638 R_body     yaw rate                      [rad/s]
 639 Phi        bank angle                    [rad]
 640 Theta      pitch attitude angle          [rad]
 641 Psi        heading angle                 [rad]
 642
 643 2) aircraft geometry   (UIUC Aero Model)
 644 bw        wingspan                       [ft]
 645 cbar      mean aerodynamic chord         [ft]
 646 Sw        wing planform area             [ft^2]
 647
 648 3) engine properties   (UIUC Engine Model)
 649 (some engine model must be specified, such as...)
 650 engine simpleSingle
 651           <or>
 652 engine c172
 653
 654 4) mass variables   (LaRCsim)
 655 Mass      aircraft mass                  [slug]
 656 I_xx      roll inertia                   [slug-ft^2]
 657 I_yy      pitch inertia                  [slug-ft^2]
 658 I_zz      yaw inertia                    [slug-ft^2]
 659 I_xz      lateral cross inertia          [slug-ft^2]
 660
 661 5) aerodynamic force/moment components   (Aero Model)
 662 CLo       lift coef for all angles = 0   []
 663 CL_a      lift curve slope, d(CL)/d(alpha) [/rad]
 664 CDo       drag coef for all angles = 0   []
 665 CDK       constant, as in CD=CDo+K*CL^2  []
 666           <or>
 667 CD_a      d(CD)/d(alpha)                 [/rad]
 668 Cmo       pitch mom coef for all angles=0 []
 669 Cm_a      d(Cm)/d(alpha)                 [/rad]
 670 CY_beta   d(CY)/d(beta)                  [/rad]
 671 Cl_beta   d(Cl)/d(beta)                  [/rad]
 672 Cn_beta   d(Cn)/d(beta)                  [/rad]
 673
 674 7) gear properties   (none yet)
 675
 676 With the current version, the C172 model gear model is used for *ALL*
 677 aircraft.  This can produce some interesting effects with heavy
 678 aircraft (eg, Convair model), and light aircraft (eg, Pioneer UAV)
 679
 680 **********************************************************************