src/Systems/electrical.cxx

   1 // electrical.cxx - a flexible, generic electrical system model.
   2 //
   3 // Written by Curtis Olson, started September 2002.
   4 //
   5 // Copyright (C) 2002  Curtis L. Olson  - curt@flightgear.org
   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
  23
  24 #include <simgear/misc/exception.hxx>
  25 #include <simgear/misc/sg_path.hxx>
  26
  27 #include <Main/fg_props.hxx>
  28 #include <Main/globals.hxx>
  29
  30 #include "electrical.hxx"
  31
  32
  33 FGElectricalComponent::FGElectricalComponent() :
  34     kind(-1),
  35     name(""),
  36     value(0.0)
  37 {
  38 }
  39
  40
  41 FGElectricalSupplier::FGElectricalSupplier ( SGPropertyNode *node ) {
  42     kind = FG_SUPPLIER;
  43
  44     // cout << "Creating a supplier" << endl;
  45     name = node->getStringValue("name");
  46     string _model = node->getStringValue("kind");
  47     // cout << "_model = " << _model << endl;
  48     if ( _model == "battery" ) {
  49         model = FG_BATTERY;
  50     } else if ( _model == "alternator" ) {
  51         model = FG_ALTERNATOR;
  52     } else if ( _model == "external" ) {
  53         model = FG_EXTERNAL;
  54     } else {
  55         model = FG_UNKNOWN;
  56     }
  57     volts = node->getDoubleValue("volts");
  58     amps = node->getDoubleValue("amps");
  59
  60     int i;
  61     for ( i = 0; i < node->nChildren(); ++i ) {
  62         SGPropertyNode *child = node->getChild(i);
  63         // cout << " scanning: " << child->getName() << endl;
  64         if ( (string)child->getName() == "prop" ) {
  65             string prop = child->getStringValue();
  66             // cout << "  Adding prop = " << prop << endl;
  67             add_prop( prop );
  68             fgSetDouble( prop.c_str(), amps );
  69         }
  70     }
  71
  72     _rpm_node = fgGetNode("/engines/engine[0]/rpm", true);
  73 }
  74
  75
  76 double FGElectricalSupplier::get_output() {
  77     if ( model == FG_BATTERY ) {
  78         // cout << "battery amps = " << amps << endl;
  79         return amps;
  80     } else if ( model == FG_ALTERNATOR ) {
  81         // scale alternator output for rpms < 600.  For rpms >= 600
  82         // give full output.  This is just a WAG, and probably not how
  83         // it really works but I'm keeping things "simple" to start.
  84         double rpm = _rpm_node->getDoubleValue();
  85         double factor = rpm / 600.0;
  86         if ( factor > 1.0 ) {
  87             factor = 1.0;
  88         }
  89         // cout << "alternator amps = " << amps * factor << endl;
  90         return amps * factor;
  91     } else if ( model == FG_EXTERNAL ) {
  92         // cout << "external amps = " << 0.0 << endl;
  93         return 0.0;
  94     } else {
  95         SG_LOG( SG_ALL, SG_ALERT, "unknown supplier type" );
  96     }
  97
  98     return 0.0;
  99 }
 100
 101
 102 FGElectricalBus::FGElectricalBus ( SGPropertyNode *node ) {
 103     kind = FG_BUS;
 104
 105     name = node->getStringValue("name");
 106     int i;
 107     for ( i = 0; i < node->nChildren(); ++i ) {
 108         SGPropertyNode *child = node->getChild(i);
 109         if ( (string)child->getName() == "prop" ) {
 110             string prop = child->getStringValue();
 111             add_prop( prop );
 112         }
 113     }
 114 }
 115
 116
 117 FGElectricalOutput::FGElectricalOutput ( SGPropertyNode *node ) {
 118     kind = FG_OUTPUT;
 119
 120     name = node->getStringValue("name");
 121     int i;
 122     for ( i = 0; i < node->nChildren(); ++i ) {
 123         SGPropertyNode *child = node->getChild(i);
 124         if ( (string)child->getName() == "prop" ) {
 125             string prop = child->getStringValue();
 126             add_prop( prop );
 127         }
 128     }
 129 }
 130
 131
 132 FGElectricalConnector::FGElectricalConnector ( SGPropertyNode *node,
 133                                                FGElectricalSystem *es ) {
 134     kind = FG_CONNECTOR;
 135     name = "connector";
 136     int i;
 137     for ( i = 0; i < node->nChildren(); ++i ) {
 138         SGPropertyNode *child = node->getChild(i);
 139         string cname = child->getName();
 140         string cval = child->getStringValue();
 141         // cout << "  " << cname << " = " << cval << endl;
 142         if ( cname == "input" ) {
 143             FGElectricalComponent *s = es->find( child->getStringValue() );
 144             if ( s != NULL ) {
 145                 add_input( s );
 146                 if ( s->get_kind() == FG_SUPPLIER ) {
 147                     s->add_output( this );
 148                 } else if ( s->get_kind() == FG_BUS ) {
 149                     s->add_output( this );
 150                 } else {
 151                     SG_LOG( SG_ALL, SG_ALERT,
 152                             "Attempt to connect to something that can't provide an output: "
 153                             << child->getStringValue() );
 154                 }
 155             } else {
 156                 SG_LOG( SG_ALL, SG_ALERT, "Can't find named source: "
 157                         << child->getStringValue() );
 158             }
 159         } else if ( cname == "output" ) {
 160             FGElectricalComponent *s = es->find( child->getStringValue() );
 161             if ( s != NULL ) {
 162                 add_output( s );
 163                 if ( s->get_kind() == FG_BUS ) {
 164                     s->add_input( this );
 165                 } else if ( s->get_kind() == FG_OUTPUT ) {
 166                     s->add_input( this );
 167                 } else {
 168                     SG_LOG( SG_ALL, SG_ALERT,
 169                             "Attempt to connect to something that can't provide an input: "
 170                             << child->getStringValue() );
 171                 }
 172             } else {
 173                 SG_LOG( SG_ALL, SG_ALERT, "Can't find named source: "
 174                         << child->getStringValue() );
 175             }
 176         } else if ( cname == "switch" ) {
 177             // set default value of switch to true
 178             // cout << "Switch = " << child->getStringValue() << endl;
 179             fgSetBool( child->getStringValue(), true );
 180             add_switch( fgGetNode( child->getStringValue(), true ) );
 181         }
 182     }
 183 }
 184
 185
 186 // return true if all switches are true, false otherwise.  A connector
 187 // could have multiple switches, but they all need to be true(closed)
 188 // for current to get through.
 189 bool FGElectricalConnector::get_state() {
 190     unsigned int i;
 191     for ( i = 0; i < switches.size(); ++i ) {
 192         if ( ! switches[i]->getBoolValue() ) {
 193             return false;
 194         }
 195     }
 196
 197     return true;
 198 }
 199
 200
 201 FGElectricalSystem::FGElectricalSystem () :
 202     enabled(false)
 203 {
 204 }
 205
 206
 207 FGElectricalSystem::~FGElectricalSystem () {
 208 }
 209
 210
 211 void FGElectricalSystem::init () {
 212     config_props = new SGPropertyNode;
 213
 214     SGPath config( globals->get_fg_root() );
 215     config.append( fgGetString("/sim/systems/electrical/path") );
 216
 217     SG_LOG( SG_ALL, SG_ALERT, "Reading electrical system model from "
 218             << config.str() );
 219     try {
 220         readProperties( config.str(), config_props );
 221
 222         if ( build() ) {
 223             enabled = true;
 224         } else {
 225             SG_LOG( SG_ALL, SG_ALERT,
 226                     "Detected an internal inconsistancy in the electrical" );
 227             SG_LOG( SG_ALL, SG_ALERT,
 228                     " system specification file.  See earlier errors for" );
 229             SG_LOG( SG_ALL, SG_ALERT,
 230                     " details.");
 231             exit(-1);
 232         }
 233     } catch (const sg_exception& exc) {
 234         SG_LOG( SG_ALL, SG_ALERT, "Failed to load electrical system model: "
 235                 << config.str() );
 236     }
 237
 238     delete config_props;
 239 }
 240
 241
 242 void FGElectricalSystem::bind () {
 243 }
 244
 245
 246 void FGElectricalSystem::unbind () {
 247 }
 248
 249
 250 void FGElectricalSystem::update (double dt) {
 251     if ( !enabled ) {
 252         return;
 253     }
 254
 255     // cout << "Updating electrical system" << endl;
 256
 257     unsigned int i;
 258
 259     // zero everything out before we start
 260     for ( i = 0; i < suppliers.size(); ++i ) {
 261         suppliers[i]->set_value( 0.0 );
 262     }
 263     for ( i = 0; i < buses.size(); ++i ) {
 264         buses[i]->set_value( 0.0 );
 265     }
 266     for ( i = 0; i < outputs.size(); ++i ) {
 267         outputs[i]->set_value( 0.0 );
 268     }
 269     for ( i = 0; i < connectors.size(); ++i ) {
 270         connectors[i]->set_value( 0.0 );
 271     }
 272
 273     // for each supplier, propogate the electrical current
 274     for ( i = 0; i < suppliers.size(); ++i ) {
 275         // cout << " Updating: " << suppliers[i]->get_name() << endl;
 276         propogate( suppliers[i], 0.0, " " );
 277     }
 278
 279 }
 280
 281
 282 bool FGElectricalSystem::build () {
 283     SGPropertyNode *node;
 284     int i;
 285
 286     int count = config_props->nChildren();
 287     for ( i = 0; i < count; ++i ) {
 288         node = config_props->getChild(i);
 289         string name = node->getName();
 290         // cout << name << endl;
 291         if ( name == "supplier" ) {
 292             FGElectricalSupplier *s =
 293                 new FGElectricalSupplier( node );
 294             suppliers.push_back( s );
 295         } else if ( name == "bus" ) {
 296             FGElectricalBus *b =
 297                 new FGElectricalBus( node );
 298             buses.push_back( b );
 299         } else if ( name == "output" ) {
 300             FGElectricalOutput *o =
 301                 new FGElectricalOutput( node );
 302             outputs.push_back( o );
 303         } else if ( name == "connector" ) {
 304             FGElectricalConnector *c =
 305                 new FGElectricalConnector( node, this );
 306             connectors.push_back( c );
 307         } else {
 308             SG_LOG( SG_ALL, SG_ALERT, "Unknown component type specified: "
 309                     << name );
 310             return false;
 311         }
 312     }
 313
 314     return true;
 315 }
 316
 317
 318 // propogate the electrical current through the network
 319 void FGElectricalSystem::propogate( FGElectricalComponent *node, double val,
 320                                     string s ) {
 321     s += " ";
 322
 323     // determine the current to carry forward
 324     double current = 0.0;
 325     if ( node->get_kind() == FG_SUPPLIER ) {
 326         // cout << s << " is a supplier" << endl;
 327         current = ((FGElectricalSupplier *)node)->get_output();
 328     } else if ( node->get_kind() == FG_BUS ) {
 329         // cout << s << " is a bus" << endl;
 330         current = val;
 331     } else if ( node->get_kind() == FG_OUTPUT ) {
 332         // cout << s << " is an output" << endl;
 333         current = val;
 334     } else if ( node->get_kind() == FG_CONNECTOR ) {
 335         // cout << s << " is a connector" << endl;
 336         if ( ((FGElectricalConnector *)node)->get_state() ) {
 337             current = val;
 338         } else {
 339             current = 0.0;
 340         }
 341         // cout << s << "  val = " << current << endl;
 342     } else {
 343         SG_LOG( SG_ALL, SG_ALERT, "unkown node type" );
 344     }
 345
 346     if ( current > node->get_value() ) {
 347         node->set_value( current );
 348     }
 349
 350     int i;
 351
 352     // publish values to specified properties
 353     for ( i = 0; i < node->get_num_props(); ++i ) {
 354         fgSetDouble( node->get_prop(i).c_str(), node->get_value() );
 355     }
 356     // cout << s << node->get_name() << " -> " << node->get_value() << endl;
 357
 358     // propogate to all children
 359     for ( i = 0; i < node->get_num_outputs(); ++i ) {
 360         propogate( node->get_output(i), current, s );
 361     }
 362 }
 363
 364
 365 // search for the named component and return a pointer to it, NULL otherwise
 366 FGElectricalComponent *FGElectricalSystem::find ( const string &name ) {
 367     unsigned int i;
 368     string s;
 369
 370     // search suppliers
 371     for ( i = 0; i < suppliers.size(); ++i ) {
 372         s = suppliers[i]->get_name();
 373         // cout <<  "    " << s << endl;
 374         if ( s == name ) {
 375             return suppliers[i];
 376         }
 377     }
 378
 379     // then search buses
 380     for ( i = 0; i < buses.size(); ++i ) {
 381         s = buses[i]->get_name();
 382         // cout <<  "    " << s << endl;
 383         if ( s == name ) {
 384             return buses[i];
 385         }
 386     }
 387
 388     // then search outputs
 389     for ( i = 0; i < outputs.size(); ++i ) {
 390         s = outputs[i]->get_name();
 391         // cout <<  "    " << s << endl;
 392         if ( s == name ) {
 393             return outputs[i];
 394         }
 395     }
 396
 397     // nothing found
 398     return NULL;
 399 }