YASim.cxx

Go to the documentation of this file.

 
#ifdef HAVE_CONFIG_H
#  include "config.h"
#endif
 
#include <cstdlib>
#include <cstdio>
 
#include <simgear/debug/logstream.hxx>
#include <simgear/math/sg_geodesy.hxx>
#include <simgear/misc/sg_path.hxx>
#include <simgear/scene/model/placement.hxx>
#include <simgear/xml/easyxml.hxx>
 
#include <Main/globals.hxx>
#include <Main/fg_props.hxx>
 
#include "yasim-common.hpp"
#include "FGFDM.hpp"
#include "Atmosphere.hpp"
#include "Math.hpp"
#include "Airplane.hpp"
#include "Model.hpp"
#include "Integrator.hpp"
#include "Glue.hpp"
#include "Gear.hpp"
#include "Hook.hpp"
#include "Launchbar.hpp"
#include "FGGround.hpp"
#include "PropEngine.hpp"
#include "PistonEngine.hpp"
 
#include "YASim.hxx"
 
using namespace yasim;
using std::string;
 
YASim::YASim(double dt) :
    _simTime(0)
{
//     set_delta_t(dt);
    _fdm = new FGFDM();
 
    _dt = dt;
 
    _fdm->getAirplane()->getModel()->setGroundCallback( new FGGround(this) );
    _fdm->getAirplane()->getModel()->getIntegrator()->setInterval(_dt);
}
 
YASim::~YASim()
{
    delete _fdm;
 
    _gearProps.clear();
}
 
void YASim::property_associations(
        std::function<void(const std::string& from, const std::string& to)> fn
        )
{
    return _fdm->property_associations(fn);
}
 
void YASim::report()
{
    Airplane* a = _fdm->getAirplane();
 
    float aoa = a->getCruiseAoA() * RAD2DEG;
    float tail = -1 * a->getTailIncidence() * RAD2DEG;
    float drag = 1000 * a->getDragCoefficient();
 
    SG_LOG(SG_FLIGHT,SG_INFO,"YASim solution results:");
    SG_LOG(SG_FLIGHT,SG_INFO,"       Iterations: "<<a->getSolutionIterations());
    SG_LOG(SG_FLIGHT,SG_INFO," Drag Coefficient: "<< drag);
    SG_LOG(SG_FLIGHT,SG_INFO,"       Lift Ratio: "<<a->getLiftRatio());
    SG_LOG(SG_FLIGHT,SG_INFO,"       Cruise AoA: "<< aoa);
    SG_LOG(SG_FLIGHT,SG_INFO,"   Tail Incidence: "<< tail);
    SG_LOG(SG_FLIGHT,SG_INFO,"Approach Elevator: "<<a->getApproachElevator());
 
    float cg[3];
    char buf[256];
    a->getModel()->getBody()->getCG(cg);
    snprintf(buf, 256, "            CG: %.3f, %.3f, %.3f", cg[0], cg[1], cg[2]);
    SG_LOG(SG_FLIGHT, SG_INFO, buf);
 
    if(a->getFailureMsg()) {
        SG_LOG(SG_FLIGHT, SG_POPUP, std::string("YASim flight dynamics problem:") + a->getFailureMsg()+"\nThe aircraft may not fly correctly");
        //throw sg_error(std::string("YASim SOLUTION FAILURE:") + a->getFailureMsg(););
    }
}
 
void YASim::bind()
{
    // Run the superclass bind to set up a bunch of property ties
    FGInterface::bind();
 
//Torsten Dreyer: we shouldn't do this anymore because we don't set these values nomore
    // Now UNtie the ones that we are going to set ourselves.
//    fgUntie("/consumables/fuel/tank[0]/level-gal_us");
//    fgUntie("/consumables/fuel/tank[1]/level-gal_us");
 
    char buf[256];
    for(int i=0; i<_fdm->getAirplane()->getModel()->numThrusters(); i++) {
        snprintf(buf, 256, "/engines/engine[%d]/fuel-flow-gph", i);
        fgUntieIfDefined(buf);
        snprintf(buf, 256, "/engines/engine[%d]/rpm", i);
        fgUntieIfDefined(buf);
        snprintf(buf, 256, "/engines/engine[%d]/mp-osi", i);
        fgUntieIfDefined(buf);
        snprintf(buf, 256, "/engines/engine[%d]/egt-degf", i);
        fgUntieIfDefined(buf);
        snprintf(buf, 256, "/engines/engine[%d]/oil-temperature-degf", i);
        fgUntieIfDefined(buf);
    }
}
 
YASim::GearProps::GearProps(SGPropertyNode_ptr gear_root) :
    has_brake(gear_root->getNode("has-brake", true)),
    wow(gear_root->getNode("wow", true)),
    compression_norm(gear_root->getNode("compression-norm", true)),
    compression_m(gear_root->getNode("compression-m", true)),
    caster_angle_deg(gear_root->getNode("caster-angle-deg", true)),
    rollspeed_ms(gear_root->getNode("rollspeed-ms", true)),
    ground_is_solid(gear_root->getNode("ground-is-solid", true)),
    ground_friction_factor(gear_root->getNode("ground-friction-factor", true))
{
}
 
void YASim::init()
{
    Airplane* airplane = _fdm->getAirplane();
    Model* model = airplane->getModel();
 
    _crashed         = fgGetNode("/sim/crashed", true);
    _pressure_inhg   = fgGetNode("/environment/pressure-inhg", true);
    _temp_degc       = fgGetNode("/environment/temperature-degc", true);
    _density_slugft3 = fgGetNode("/environment/density-slugft3", true);
    _gear_agl_m      = fgGetNode("/position/gear-agl-m", true);
    _gear_agl_ft     = fgGetNode("/position/gear-agl-ft", true);
    _pilot_g         = fgGetNode("/accelerations/pilot-g", true);
    _speed_setprop   = fgGetNode("/sim/presets/speed-set", true);
 
    // Superclass hook
    common_init();
 
    model->setCrashed(false);
    _crashed->setBoolValue(false);
 
    // Figure out the initial speed type
    string speed_set = _speed_setprop->getStringValue();
    if ((speed_set == "") || (speed_set == "UVW"))
        _speed_set = UVW;
    else if (speed_set == "NED")
        _speed_set = NED;
    else if (speed_set == "knots")
        _speed_set = KNOTS;
    else if (speed_set == "mach")
        _speed_set = MACH;
    else {
        _speed_set = UVW;
        SG_LOG(SG_FLIGHT, SG_ALERT, "Unknown speed type " << speed_set);
    }
 
    // Build a filename and parse it
    SGPath f(fgGetString("/sim/aircraft-dir"));
    f.append(fgGetString("/sim/aero"));
    f.concat(".xml");
    try {
        readXML(f, *_fdm);
    } catch (const sg_exception &e) {
        SG_LOG(SG_FLIGHT, SG_ALERT,
               "Error reading YASim FDM: '" << f << "'" << std::endl
               << e.getFormattedMessage());
        throw e;
    }
 
    // Compile it into a real airplane, and tell the user what they got
    airplane->compile();
    report();
 
    _fdm->init();
 
    if (model->getLaunchbar())
    {
        _catapult_launch_cmd         = fgGetNode("/controls/gear/catapult-launch-cmd", true);
        _launchbar_position_norm     = fgGetNode("/gear/launchbar/position-norm", true);
        _launchbar_holdback_pos_norm = fgGetNode("/gear/launchbar/holdback-position-norm", true);
        _launchbar_state             = fgGetNode("/gear/launchbar/state", true);
        _launchbar_strop             = fgGetNode("/gear/launchbar/strop", true);
    }
    if (airplane->getHook())
    {
        _tailhook_position_norm = fgGetNode("/gear/tailhook/position-norm", 0, true);
    }
 
    // Create some FG{Eng|Gear}Interface objects
    for(int i=0; i<airplane->numGear(); i++) {
        Gear* g = airplane->getGear(i);
        SGPropertyNode * node = fgGetNode("gear/gear", i, true);
        float pos[3];
        g->getPosition(pos);
        node->setDoubleValue("xoffset-in", pos[0] * M2FT * 12);
        node->setDoubleValue("yoffset-in", pos[1] * M2FT * 12);
        node->setDoubleValue("zoffset-in", pos[2] * M2FT * 12);
 
        node->setDoubleValue("xoffset-m", pos[0]);
        node->setDoubleValue("yoffset-m", pos[1]);
        node->setDoubleValue("zoffset-m", pos[2]);
 
        node->setDoubleValue("wheel-radius-m", g->getWheelRadius());
        node->setDoubleValue("tyre-radius-m", g->getTyreRadius());
 
        node->setDoubleValue("spring", g->getSpring());
        node->setDoubleValue("damping", g->getDamping());
        
        _gearProps.push_back(GearProps(node));
    }
 
    // Are we at ground level?  If so, lift the plane up so the gear
    // clear the ground.
    bool respect_external_gear_state = fgGetBool("/fdm/yasim/respect-external-gear-state");
    double runway_altitude = get_Runway_altitude();
    if(get_Altitude() - runway_altitude < 50) {
        bool gear_state = fgGetBool("/controls/gear/gear-down");
        fgSetBool("/controls/gear/gear-down", false);
        float minGearZ = 1e18;
        for(int i=0; i<airplane->numGear(); i++) {
            Gear* g = airplane->getGear(i);
            float pos[3];
            g->getPosition(pos);
            pos[2] -= (g->getWheelRadius() + g->getTyreRadius());
            if(pos[2] < minGearZ)
                minGearZ = pos[2];
        }
        _set_Altitude(runway_altitude - minGearZ*M2FT);
        // ground start-up: gear down
        fgSetBool("/controls/gear/gear-down", respect_external_gear_state ? gear_state : true);
    }
    else if (! respect_external_gear_state)
    {
        // airborne start-up: gear up
        fgSetBool("/controls/gear/gear-down", false);
    }
 
    // Blank the state, and copy in ours
    yasim::State s;
    model->setState(&s);
    copyToYASim(true);
 
    _fdm->getExternalInput();
    _fdm->getAirplane()->initEngines();
 
    set_inited(true);
}
 
void YASim::update(double dt)
{
    if (is_suspended())
        return;
 
    int iterations = _calc_multiloop(dt);
 
    // If we're crashed, then we don't care
    if(_crashed->getBoolValue() || _fdm->getAirplane()->getModel()->isCrashed()) {
        if(!_crashed->getBoolValue())
            _crashed->setBoolValue(true);
        _fdm->getAirplane()->getModel()->setCrashed(false);
        return;
    }
 
    // ground.  Calculate a cartesian coordinate for the ground under
    // us, find the (geodetic) up vector normal to the ground, then
    // use that to find the final (radius) term of the plane equation.
    float v[3] = {
      static_cast<float>(get_uBody()),
      static_cast<float>(get_vBody()),
      static_cast<float>(get_wBody())
    };
    float lat = get_Latitude(); float lon = get_Longitude();
    float alt = get_Altitude() * FT2M; double xyz[3];
    sgGeodToCart(lat, lon, alt, xyz);
    // build the environment cache.
    float vr = _fdm->getVehicleRadius();
    vr += 2.0*FT2M*dt*Math::mag3(v);
    prepare_ground_cache_m( _simTime, _simTime + dt, xyz, vr );
 
    // Track time increments.
    FGGround* gr
      = (FGGround*)_fdm->getAirplane()->getModel()->getGroundCallback();
 
    int i;
    for(i=0; i<iterations; i++) {
        gr->setTimeOffset(_simTime + i*_dt);
        copyToYASim(false);
        _fdm->iterate(_dt);
        copyFromYASim();
    }
 
    // Increment the local sim time
    _simTime += dt;
    gr->setTimeOffset(_simTime);
}
 
void YASim::copyToYASim(bool copyState)
{
    // Physical state
    double lat = get_Latitude();
    double lon = get_Longitude();
    float alt = get_Altitude() * FT2M;
    float roll = get_Phi();
    float pitch = get_Theta();
    float hdg = get_Psi();
 
    // Environment
    float wind[3];
    wind[0] = get_V_north_airmass() * FT2M * -1.0;
    wind[1] = get_V_east_airmass() * FT2M * -1.0;
    wind[2] = get_V_down_airmass() * FT2M * -1.0;
 
    float pressure = _pressure_inhg->getFloatValue() * INHG2PA;
    float temp     = _temp_degc->getFloatValue() + 273.15;
    float dens     = _density_slugft3->getFloatValue() *
                            SLUG2KG * M2FT*M2FT*M2FT;
    Atmosphere atmo;
    atmo.setDensity(dens);
    atmo.setTemperature(temp);
    atmo.setPressure(pressure);
 
    // Convert and set:
    Model* model = _fdm->getAirplane()->getModel();
    yasim::State s;
    float xyz2ned[9];
    Glue::xyz2nedMat(lat, lon, xyz2ned);
 
    // position
    sgGeodToCart(lat, lon, alt, s.pos);
    {
      // allow setting of /position/[lat|long|alti]tude
      double * dp = &model->getState()->pos[0];
      dp[0] = s.pos[0]; dp[1] = s.pos[1]; dp[2] = s.pos[2];
    }
 
    // orientation
    Glue::euler2orient(roll, pitch, hdg, s.orient);
    Math::mmul33(s.orient, xyz2ned, s.orient);
 
    // Velocity
    float v[3] {0, 0, 0};
    bool needCopy = false;
    switch (_speed_set) {
    case NED:
        v[0] = get_V_north() * FT2M * -1.0;
        v[1] = get_V_east() * FT2M * -1.0;
        v[2] = get_V_down() * FT2M * -1.0;
        break;
    case UVW:
        v[0] = get_uBody() * FT2M;
        v[1] = get_vBody() * FT2M;
        v[2] = get_wBody() * FT2M;
        Math::tmul33(s.orient, v, v);
        break;
    case KNOTS:
        v[0] = atmo.speedFromVCAS(get_V_calibrated_kts()/MPS2KTS);
        v[1] = 0;
        v[2] = 0;
        Math::tmul33(s.orient, v, v);
        needCopy = true;
        break;
    case MACH:
        v[0] = atmo.speedFromMach(get_Mach_number());
        v[1] = 0;
        v[2] = 0;
        Math::tmul33(s.orient, v, v);
        needCopy = true;
        break;
    default:
        v[0] = 0;
        v[1] = 0;
        v[2] = 0;
        break;
    }
    if (!copyState)
        _speed_set = UVW;       // change to this after initial setting
    Math::set3(v, s.v);
 
    if(copyState || needCopy)
        model->setState(&s);
 
    Math::tmul33(xyz2ned, wind, wind);
    model->setWind(wind);
    model->setAtmosphere(atmo);
 
    // Query a ground plane for each gear/hook/launchbar and
    // write that value into the corresponding class.
    _fdm->getAirplane()->getModel()->updateGround(&s);
 
    Launchbar* l = model->getLaunchbar();
    if (l) {
        l->setLaunchCmd(0.0 < _catapult_launch_cmd->getFloatValue());
    }
}
 
// All the settables:
//
// These are set below:
// _set_Accels_Local
// _set_Accels_Body
// _set_Accels_CG_Body
// _set_Accels_Pilot_Body
// _set_Accels_CG_Body_N
// _set_Velocities_Local
// _set_Velocities_Ground
// _set_Velocities_Body
// _set_Omega_Body
// _set_Euler_Rates
// _set_Euler_Angles
// _set_V_rel_wind
// _set_V_ground_speed
// _set_V_equiv_kts
// _set_V_calibrated_kts
// _set_Alpha
// _set_Beta
// _set_Mach_number
// _set_Climb_Rate
// _set_Tank1Fuel
// _set_Tank2Fuel
// _set_Altitude_AGL
// _set_Geodetic_Position
// _set_Runway_altitude
 
// Ignoring these, because they're unused:
// _set_Geocentric_Position
// _set_Geocentric_Rates
// _set_Cos_phi
// _set_Cos_theta
// _set_Earth_position_angle (WTF?)
// _set_Gamma_vert_rad
// _set_Inertias
// _set_T_Local_to_Body
// _set_CG_Position
// _set_Sea_Level_Radius
 
// Externally set via the weather code:
// _set_Velocities_Local_Airmass
// _set_Density
// _set_Static_pressure
// _set_Static_temperature
void YASim::copyFromYASim()
{
    Airplane* airplane = _fdm->getAirplane();
    Model* model = airplane->getModel();
    yasim::State* s = model->getState();
 
    // position
    double lat, lon, alt;
    sgCartToGeod(s->pos, &lat, &lon, &alt);
    _set_Geodetic_Position(lat, lon, alt*M2FT);
    double groundlevel_m = get_groundlevel_m(lat, lon, alt);
    _set_Runway_altitude(groundlevel_m*SG_METER_TO_FEET);
    _set_Altitude_AGL((alt-groundlevel_m)*SG_METER_TO_FEET);
 
    // the smallest agl of all gears
    _gear_agl_m->setFloatValue(model->getAGL());
    _gear_agl_ft->setFloatValue(model->getAGL()*M2FT);
 
    // UNUSED
    //_set_Geocentric_Position(Glue::geod2geocLat(lat), lon, alt*M2FT);
 
    // useful conversion matrix
    float xyz2ned[9];
    Glue::xyz2nedMat(lat, lon, xyz2ned);
 
    // velocity
    float v[3];
    Math::vmul33(xyz2ned, s->v, v);
    _set_Velocities_Local(M2FT*v[0], M2FT*v[1], M2FT*v[2]);
    _set_V_ground_speed(Math::sqrt(M2FT*v[0]*M2FT*v[0] +
                                   M2FT*v[1]*M2FT*v[1]));
    _set_Climb_Rate(-M2FT*v[2]);
 
    // The HUD uses this, but inverts down (?!)
    _set_Velocities_Ground(M2FT*v[0], M2FT*v[1], -M2FT*v[2]);
 
    // _set_Geocentric_Rates(M2FT*v[0], M2FT*v[1], M2FT*v[2]); // UNUSED
 
    // ecef speed in body axis
    Math::vmul33(s->orient, s->v, v);
    _set_Velocities_Body(v[0]*M2FT, -v[1]*M2FT, -v[2]*M2FT);
 
    // Airflow velocity.
    float wind[3];
    wind[0] = get_V_north_airmass() * FT2M * -1.0;  // Wind in NED
    wind[1] = get_V_east_airmass() * FT2M * -1.0;
    wind[2] = get_V_down_airmass() * FT2M * -1.0;
    Math::tmul33(xyz2ned, wind, wind);              // Wind in global
    Math::sub3(s->v, wind, v);                      // V - wind in global
    Math::vmul33(s->orient, v, v);               // to body coordinates
    _set_V_rel_wind(Math::mag3(v)*M2FT); // units?
 
    float P = _pressure_inhg->getFloatValue() * INHG2PA;
    float T = _temp_degc->getFloatValue() + 273.15;
    float D = _density_slugft3->getFloatValue()
        *SLUG2KG * M2FT*M2FT*M2FT;
    _set_V_equiv_kts(Atmosphere::calcVEAS(v[0], P, T, D)*MPS2KTS);
    _set_V_calibrated_kts(Atmosphere::calcVCAS(v[0], P, T)*MPS2KTS);
    _set_Mach_number(Atmosphere::calcMach(Math::mag3(v), T));
 
    // acceleration
    Math::vmul33(xyz2ned, s->acc, v);
    _set_Accels_Local(M2FT*v[0], M2FT*v[1], M2FT*v[2]);
 
    Math::vmul33(s->orient, s->acc, v);
    _set_Accels_Body(M2FT*v[0], -M2FT*v[1], -M2FT*v[2]);
    _set_Accels_CG_Body(M2FT*v[0], -M2FT*v[1], -M2FT*v[2]);
 
    _fdm->getAirplane()->getPilotAccel(v);
    _set_Accels_Pilot_Body(M2FT*v[0], M2FT*v[1], M2FT*v[2]);
 
    // There is no property for pilot G's, but I need it for a panel
    // instrument.  Hack this in here, and REMOVE IT WHEN IT FINDS A
    // REAL HOME!
    _pilot_g->setFloatValue(-v[2]/9.8);
 
    // The one appears (!) to want inverted pilot acceleration
    // numbers, in G's...
    Math::mul3(1.0/9.8, v, v);
    _set_Accels_CG_Body_N(v[0], -v[1], -v[2]);
 
    // orientation
    float alpha, beta;
    Glue::calcAlphaBeta(s, wind, &alpha, &beta);
    _set_Alpha(alpha);
    _set_Beta(-beta);
 
    float tmp[9];
    Math::trans33(xyz2ned, tmp);
    Math::mmul33(s->orient, tmp, tmp);
    float roll, pitch, hdg;
    Glue::orient2euler(tmp, &roll, &pitch, &hdg);
    // make heading positive value
    if(hdg < 0.0) hdg += PI2;
    _set_Euler_Angles(roll, pitch, hdg);
 
    // rotation
    Math::vmul33(s->orient, s->rot, v);
    _set_Omega_Body(v[0], -v[1], -v[2]);
 
    Glue::calcEulerRates(s, &roll, &pitch, &hdg);
    _set_Euler_Rates(roll, pitch, hdg);
 
    // Fill out our engine and gear objects
    for(int i=0; i<airplane->numGear(); i++) {
        Gear* g = airplane->getGear(i);
        GearProps& gearProps = _gearProps[i];
        gearProps.has_brake->setBoolValue(
                g->getBrake() != 0);
        gearProps.wow->setBoolValue(
                g->getCompressFraction() != 0);
        gearProps.compression_norm->setFloatValue(
                g->getCompressFraction());
        gearProps.compression_m->setFloatValue(
                g->getCompressDist());
        gearProps.caster_angle_deg->setFloatValue(
                g->getCasterAngle() * RAD2DEG);
        gearProps.rollspeed_ms->setFloatValue(
                g->getRollSpeed());
        gearProps.ground_is_solid->setBoolValue(
                g->getGroundIsSolid()!=0);
        gearProps.ground_friction_factor->setFloatValue(
                g->getGroundFrictionFactor());
    }
 
    Hook* h = airplane->getHook();
    if(h) {
        _tailhook_position_norm->setFloatValue(h->getCompressFraction());
    }
 
    Launchbar* l = airplane->getLaunchbar();
    if(l) {
        _launchbar_position_norm->setFloatValue(l->getCompressFraction());
        _launchbar_holdback_pos_norm->setFloatValue(l->getHoldbackCompressFraction());
        _launchbar_state->setStringValue(l->getState());
        _launchbar_strop->setBoolValue(l->getStrop());
    }
}

void YASim::reinit()
{
    // Process inputs. Use excessive value for dt to make sure all transition effects
    // have reached their final state (i.e. gear is extended/retracted) - which is vital
    // for many properties to be complete before the first FDM run (otherwise the gear may
    // still be up, thrust-reversers/speed-brakes/... may still be partially deployed...).
    _fdm->getExternalInput(1000);
 
    // get current FDM values from the property tree
    copyToYASim(true);
}
 
 
// Register the subsystem.
#if 0
SGSubsystemMgr::Registrant<YASim> registrantYASim;
#endif