]> git.mxchange.org Git - flightgear.git/blobdiff - src/Systems/electrical.cxx
Boris Koenig:
[flightgear.git] / src / Systems / electrical.cxx
index 283d94f30148e7c34aefec3ee6ea04e50b77702c..72dcf3917aeba31d489307cabc3c69fdf6d69812 100644 (file)
@@ -21,7 +21,7 @@
 // $Id$
 
 
-#include <simgear/misc/exception.hxx>
+#include <simgear/structure/exception.hxx>
 #include <simgear/misc/sg_path.hxx>
 
 #include <Main/fg_props.hxx>
 
 #include "electrical.hxx"
 
-ElectricalSystem::ElectricalSystem ()
+
+FGElectricalComponent::FGElectricalComponent() :
+    kind(-1),
+    name(""),
+    volts(0.0),
+    load_amps(0.0)
 {
 }
 
-ElectricalSystem::~ElectricalSystem ()
+
+FGElectricalSupplier::FGElectricalSupplier ( SGPropertyNode *node ) {
+    kind = FG_SUPPLIER;
+
+    // cout << "Creating a supplier" << endl;
+    name = node->getStringValue("name");
+    string _model = node->getStringValue("kind");
+    // cout << "_model = " << _model << endl;
+    if ( _model == "battery" ) {
+        model = FG_BATTERY;
+    } else if ( _model == "alternator" ) {
+        model = FG_ALTERNATOR;
+    } else if ( _model == "external" ) {
+        model = FG_EXTERNAL;
+    } else {
+        model = FG_UNKNOWN;
+    }
+    volts = node->getDoubleValue("volts");
+    amps = node->getDoubleValue("amps");
+    rpm_src = node->getStringValue("rpm-source");
+
+    int i;
+    for ( i = 0; i < node->nChildren(); ++i ) {
+        SGPropertyNode *child = node->getChild(i);
+        // cout << " scanning: " << child->getName() << endl;
+        if ( !strcmp(child->getName(), "prop") ) {
+            string prop = child->getStringValue();
+            // cout << "  Adding prop = " << prop << endl;
+            add_prop( prop );
+            fgSetDouble( prop.c_str(), amps );
+        }
+    }
+
+    _rpm_node = fgGetNode( rpm_src.c_str(), true);
+}  
+
+
+double FGElectricalSupplier::get_output() {
+    if ( model == FG_BATTERY ) {
+        // cout << "battery amps = " << amps << endl;
+        return amps;
+    } else if ( model == FG_ALTERNATOR ) {
+        // scale alternator output for rpms < 600.  For rpms >= 600
+        // give full output.  This is just a WAG, and probably not how
+        // it really works but I'm keeping things "simple" to start.
+        double rpm = _rpm_node->getDoubleValue();
+        double factor = rpm / 600.0;
+        if ( factor > 1.0 ) {
+            factor = 1.0;
+        }
+        // cout << "alternator amps = " << amps * factor << endl;
+        return amps * factor;
+    } else if ( model == FG_EXTERNAL ) {
+        // cout << "external amps = " << 0.0 << endl;
+        return 0.0;
+    } else {
+        SG_LOG( SG_ALL, SG_ALERT, "unknown supplier type" );
+    }
+
+    return 0.0;
+}
+
+
+FGElectricalBus::FGElectricalBus ( SGPropertyNode *node ) {
+    kind = FG_BUS;
+
+    name = node->getStringValue("name");
+    int i;
+    for ( i = 0; i < node->nChildren(); ++i ) {
+        SGPropertyNode *child = node->getChild(i);
+        if ( !strcmp(child->getName(), "prop") ) {
+            string prop = child->getStringValue();
+            add_prop( prop );
+        }
+    }
+}  
+
+
+FGElectricalOutput::FGElectricalOutput ( SGPropertyNode *node ) {
+    kind = FG_OUTPUT;
+    output_amps = 0.1;          // arbitrary default value
+
+    name = node->getStringValue("name");
+    SGPropertyNode *draw = node->getNode("rated-draw");
+    if ( draw != NULL ) {
+        output_amps = draw->getDoubleValue();
+    }
+    // cout << "rated draw = " << output_amps << endl;
+
+    int i;
+    for ( i = 0; i < node->nChildren(); ++i ) {
+        SGPropertyNode *child = node->getChild(i);
+        if ( !strcmp(child->getName(), "prop") ) {
+            string prop = child->getStringValue();
+            add_prop( prop );
+        }
+    }
+}  
+
+
+FGElectricalSwitch::FGElectricalSwitch( SGPropertyNode *node ) :
+    switch_node( NULL ),
+    rating_amps( 0.0f ),
+    circuit_breaker( false )
 {
+    bool initial_state = true;
+    int i;
+    for ( i = 0; i < node->nChildren(); ++i ) {
+        SGPropertyNode *child = node->getChild(i);
+        string cname = child->getName();
+        string cval = child->getStringValue();
+        if ( cname == "prop" ) {
+            switch_node = fgGetNode( cval.c_str(), true );
+            // cout << "switch node = " << cval << endl;
+        } else if ( cname == "initial-state" ) {
+            if ( cval == "off" || cval == "false" ) {
+                initial_state = false;
+            }
+            // cout << "initial state = " << initial_state << endl;
+        } else if ( cname == "rating-amps" ) {
+            rating_amps = atof( cval.c_str() );
+            circuit_breaker = true;
+            // cout << "initial state = " << initial_state << endl;
+        }            
+    }
+
+    switch_node->setBoolValue( initial_state );
+    // cout << "  value = " << switch_node->getBoolValue() << endl;
 }
 
-void
-ElectricalSystem::init ()
+
+FGElectricalConnector::FGElectricalConnector ( SGPropertyNode *node,
+                                               FGElectricalSystem *es ) {
+    kind = FG_CONNECTOR;
+    name = "connector";
+    int i;
+    for ( i = 0; i < node->nChildren(); ++i ) {
+        SGPropertyNode *child = node->getChild(i);
+        string cname = child->getName();
+        string cval = child->getStringValue();
+        // cout << "  " << cname << " = " << cval << endl;
+        if ( cname == "input" ) {
+            FGElectricalComponent *s = es->find( child->getStringValue() );
+            if ( s != NULL ) {
+                add_input( s );
+                if ( s->get_kind() == FG_SUPPLIER ) {
+                    s->add_output( this );
+                } else if ( s->get_kind() == FG_BUS ) {
+                    s->add_output( this );
+                } else {
+                    SG_LOG( SG_ALL, SG_ALERT,
+                            "Attempt to connect to something that can't provide an output: " 
+                            << child->getStringValue() );
+                }
+            } else {
+                SG_LOG( SG_ALL, SG_ALERT, "Can't find named source: " 
+                        << child->getStringValue() );
+            }
+        } else if ( cname == "output" ) {
+            FGElectricalComponent *s = es->find( child->getStringValue() );
+            if ( s != NULL ) {
+                add_output( s );
+                if ( s->get_kind() == FG_BUS ) {
+                    s->add_input( this );
+                } else if ( s->get_kind() == FG_OUTPUT ) {
+                    s->add_input( this );
+                } else {
+                    SG_LOG( SG_ALL, SG_ALERT,
+                            "Attempt to connect to something that can't provide an input: " 
+                            << child->getStringValue() );
+                }
+            } else {
+                SG_LOG( SG_ALL, SG_ALERT, "Can't find named source: " 
+                        << child->getStringValue() );
+            }
+        } else if ( cname == "switch" ) {
+             // cout << "Switch = " << child->getStringValue() << endl;
+            FGElectricalSwitch s( child );
+            add_switch( s );
+        }
+    }
+}  
+
+
+// set all switches to the specified state
+void FGElectricalConnector::set_switches( bool state ) {
+    // cout << "setting switch state to " << state << endl;
+    for ( unsigned int i = 0; i < switches.size(); ++i ) {
+        switches[i].set_state( state );
+    }
+}
+
+
+// return true if all switches are true, false otherwise.  A connector
+// could have multiple switches, but they all need to be true(closed)
+// for current to get through.
+bool FGElectricalConnector::get_state() {
+    unsigned int i;
+    for ( i = 0; i < switches.size(); ++i ) {
+        if ( ! switches[i].get_state() ) {
+            return false;
+        }
+    }
+
+    return true;
+}
+
+
+FGElectricalSystem::FGElectricalSystem () :
+    enabled(false)
 {
+}
+
+
+FGElectricalSystem::~FGElectricalSystem () {
+}
+
+
+void FGElectricalSystem::init () {
     config_props = new SGPropertyNode;
 
-    SGPath config( globals->get_fg_root() );
-    config.append( fgGetString("/systems/electrical/path") );
+    SGPropertyNode *path_n = fgGetNode("/sim/systems/electrical/path");
+    _volts_out = fgGetNode( "/systems/electrical/volts", true );
+    _amps_out = fgGetNode( "/systems/electrical/amps", true );
 
-    SG_LOG( SG_ALL, SG_ALERT, "Reading electrical system model from "
-            << config.str() );
-    try {
-        readProperties( config.str(), config_props );
-    } catch (const sg_exception& exc) {
-        SG_LOG( SG_ALL, SG_ALERT, "Failed to load electrical system model: "
+    if (path_n) {
+        SGPath config( globals->get_fg_root() );
+        config.append( path_n->getStringValue() );
+
+        SG_LOG( SG_ALL, SG_INFO, "Reading electrical system model from "
                 << config.str() );
+        try {
+            readProperties( config.str(), config_props );
+
+            if ( build() ) {
+                enabled = true;
+            } else {
+                SG_LOG( SG_ALL, SG_ALERT,
+                        "Detected an internal inconsistancy in the electrical");
+                SG_LOG( SG_ALL, SG_ALERT,
+                        " system specification file.  See earlier errors for" );
+                SG_LOG( SG_ALL, SG_ALERT,
+                        " details.");
+                exit(-1);
+            }        
+        } catch (const sg_exception& exc) {
+            SG_LOG( SG_ALL, SG_ALERT, "Failed to load electrical system model: "
+                    << config.str() );
+        }
+
+    } else {
+        SG_LOG( SG_ALL, SG_WARN,
+                "No electrical model specified for this model!");
     }
 
     delete config_props;
 }
 
-void
-ElectricalSystem::bind ()
-{
+
+void FGElectricalSystem::bind () {
 }
 
-void
-ElectricalSystem::unbind ()
-{
+
+void FGElectricalSystem::unbind () {
 }
 
-void
-ElectricalSystem::update (double dt)
-{
+
+void FGElectricalSystem::update (double dt) {
+    if ( !enabled ) {
+        _amps_out->setDoubleValue(0);
+        return;
+    }
+
+    // cout << "Updating electrical system" << endl;
+
+    unsigned int i;
+
+    // zero everything out before we start
+    for ( i = 0; i < suppliers.size(); ++i ) {
+        suppliers[i]->set_volts( 0.0 );
+        suppliers[i]->set_load_amps( 0.0 );
+    }
+    for ( i = 0; i < buses.size(); ++i ) {
+        buses[i]->set_volts( 0.0 );
+        buses[i]->set_load_amps( 0.0 );
+    }
+    for ( i = 0; i < outputs.size(); ++i ) {
+        outputs[i]->set_volts( 0.0 );
+        outputs[i]->set_load_amps( 0.0 );
+    }
+    for ( i = 0; i < connectors.size(); ++i ) {
+        connectors[i]->set_volts( 0.0 );
+        connectors[i]->set_load_amps( 0.0 );
+    }
+
+    // for each supplier, propagate the electrical current
+    for ( i = 0; i < suppliers.size(); ++i ) {
+        // cout << " Updating: " << suppliers[i]->get_name() << endl;
+        propagate( suppliers[i], 0.0, " " );
+    }
+
+    double alt_norm
+        = fgGetDouble("/systems/electrical/suppliers/alternator") / 60.0;
+
+    // impliment an extremely simplistic voltage model (assumes
+    // certain naming conventions in electrical system config)
+    // FIXME: we probably want to be able to feed power from all
+    // engines if they are running and the master-alt is switched on
+    double volts = 0.0;
+    if ( fgGetBool("/controls/engines/engine[0]/master-bat") ) {
+        volts = 24.0;
+    }
+    if ( fgGetBool("/controls/engines/engine[0]/master-alt") ) {
+        if ( fgGetDouble("/engines/engine[0]/rpm") > 800 ) {
+            double alt_contrib = 28.0;
+            if ( alt_contrib > volts ) {
+                volts = alt_contrib;
+            }
+        } else if ( fgGetDouble("/engines/engine[0]/rpm") > 200 ) {
+            double alt_contrib = 20.0;
+            if ( alt_contrib > volts ) {
+                volts = alt_contrib;
+            }
+        }
+    }
+    _volts_out->setDoubleValue( volts );
+
+    // impliment an extremely simplistic amps model (assumes certain
+    // naming conventions in the electrical system config) ... FIXME:
+    // make this more generic
+    double amps = 0.0;
+    if ( fgGetBool("/controls/engines/engine[0]/master-bat") ) {
+        if ( fgGetBool("/controls/engines/engine[0]/master-alt") &&
+             fgGetDouble("/engines/engine[0]/rpm") > 800 )
+        {
+            amps += 40.0 * alt_norm;
+        }
+        amps -= 15.0;            // normal load
+        if ( fgGetBool("/controls/switches/flashing-beacon") ) {
+            amps -= 7.5;
+        }
+        if ( fgGetBool("/controls/switches/nav-lights") ) {
+            amps -= 7.5;
+        }
+        if ( amps > 7.0 ) {
+            amps = 7.0;
+        }
+    }
+    _amps_out->setDoubleValue( amps );
+}
+
+
+bool FGElectricalSystem::build () {
+    SGPropertyNode *node;
+    int i;
+
+    int count = config_props->nChildren();
+    for ( i = 0; i < count; ++i ) {
+        node = config_props->getChild(i);
+        string name = node->getName();
+        // cout << name << endl;
+        if ( name == "supplier" ) {
+            FGElectricalSupplier *s =
+                new FGElectricalSupplier( node );
+            suppliers.push_back( s );
+        } else if ( name == "bus" ) {
+            FGElectricalBus *b =
+                new FGElectricalBus( node );
+            buses.push_back( b );
+        } else if ( name == "output" ) {
+            FGElectricalOutput *o =
+                new FGElectricalOutput( node );
+            outputs.push_back( o );
+        } else if ( name == "connector" ) {
+            FGElectricalConnector *c =
+                new FGElectricalConnector( node, this );
+            connectors.push_back( c );
+        } else {
+            SG_LOG( SG_ALL, SG_ALERT, "Unknown component type specified: " 
+                    << name );
+            return false;
+        }
+    }
+
+    return true;
+}
+
+
+// propagate the electrical current through the network, returns the
+// total current drawn by the children of this node.
+float FGElectricalSystem::propagate( FGElectricalComponent *node, double val,
+                                    string s ) {
+    s += " ";
+    
+    float current_amps = 0.0;
+
+    // determine the current to carry forward
+    double volts = 0.0;
+    if ( !fgGetBool("/systems/electrical/serviceable") ) {
+        volts = 0;
+    } else if ( node->get_kind() == FG_SUPPLIER ) {
+        // cout << s << " is a supplier" << endl;
+        volts = ((FGElectricalSupplier *)node)->get_output();
+    } else if ( node->get_kind() == FG_BUS ) {
+        // cout << s << " is a bus" << endl;
+        volts = val;
+    } else if ( node->get_kind() == FG_OUTPUT ) {
+        // cout << s << " is an output" << endl;
+        volts = val;
+        if ( volts > 1.0 ) {
+            // draw current if we have voltage
+            current_amps = ((FGElectricalOutput *)node)->get_output_amps();
+        }
+    } else if ( node->get_kind() == FG_CONNECTOR ) {
+        // cout << s << " is a connector" << endl;
+        if ( ((FGElectricalConnector *)node)->get_state() ) {
+            volts = val;
+        } else {
+            volts = 0.0;
+        }
+        // cout << s << "  val = " << volts << endl;
+    } else {
+        SG_LOG( SG_ALL, SG_ALERT, "unkown node type" );
+    }
+
+    if ( volts > node->get_volts() ) {
+        node->set_volts( volts );
+    }
+
+    int i;
+
+    // publish values to specified properties
+    for ( i = 0; i < node->get_num_props(); ++i ) {
+        fgSetDouble( node->get_prop(i).c_str(), node->get_volts() );
+    }
+    // cout << s << node->get_name() << " -> " << node->get_value() << endl;
+
+    // propagate to all children
+    for ( i = 0; i < node->get_num_outputs(); ++i ) {
+        current_amps += propagate( node->get_output(i), volts, s );
+    }
+
+    // if not an output node, register the downstream current draw
+    // with this node.  If volts are zero, current draw should be zero.
+    if ( node->get_kind() != FG_OUTPUT ) {
+        node->set_load_amps( current_amps );
+    }
+    // cout << s << node->get_name() << " -> " << current_amps << endl;
+
+    return current_amps;
+}
+
+
+// search for the named component and return a pointer to it, NULL otherwise
+FGElectricalComponent *FGElectricalSystem::find ( const string &name ) {
+    unsigned int i;
+    string s;
+
+    // search suppliers
+    for ( i = 0; i < suppliers.size(); ++i ) {
+        s = suppliers[i]->get_name();
+        // cout <<  "    " << s << endl;
+        if ( s == name ) {
+            return suppliers[i];
+        }
+    }
+
+    // then search buses
+    for ( i = 0; i < buses.size(); ++i ) {
+        s = buses[i]->get_name();
+        // cout <<  "    " << s << endl;
+        if ( s == name ) {
+            return buses[i];
+        }
+    }
+
+    // then search outputs
+    for ( i = 0; i < outputs.size(); ++i ) {
+        s = outputs[i]->get_name();
+        // cout <<  "    " << s << endl;
+        if ( s == name ) {
+            return outputs[i];
+        }
+    }
+
+    // nothing found
+    return NULL;
 }