hydengine.h

Go to the documentation of this file.

/* EPANET 3
 *
 * Copyright (c) 2016 Open Water Analytics
 * Distributed under the MIT License (see the LICENSE file for details).
 *
 */


#ifndef HYDENGINE_H_
#define HYDENGINE_H_

class Network;
class HydSolver;
class MatrixSolver;


class HydEngine
{
  public:

    // Constructor/Destructor

    HydEngine();
    ~HydEngine();

    // Public Methods

    void   open(Network* nw);
    void   init(bool initFlows);
    int    solve(int* t);
    void   advance(int* tstep);
    void   close();

    int    getElapsedTime() { return currentTime; }
    double getPeakKwatts()  { return peakKwatts;  }

  private:

    // Engine state

    enum EngineState {CLOSED, OPENED, INITIALIZED};
    EngineState engineState;

    // Engine components

    Network*       network;            
    HydSolver*     hydSolver;          
    MatrixSolver*  matrixSolver;       
//    HydFile*       hydFile;            //!< hydraulics file accessor

    // Engine properties

    bool           saveToFile;         
    bool           halted;             
    int            startTime;          
    int            rptTime;            
    int            hydStep;            
    int            currentTime;        
    int            timeOfDay;          
    double         peakKwatts;         

    // Simulation sub-tasks

    void           initMatrixSolver();

    int            getTimeStep();
    int            timeToPatternChange();
    int            timeToActivateControl();
    int            timeToCloseTank();

    void           updateCurrentConditions();
    void           updateTanks();
    void           updatePatterns();
    void           updateEnergyUsage();

    bool           isPressureDeficient();
    int            resolvePressureDeficiency(int& trials);
    void           reportDiagnostics(int statusCode, int trials);
};

#endif