link.h

Go to the documentation of this file.

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


#ifndef LINK_H_
#define LINK_H_

#include "Elements/element.h"

#include <string>
#include <iostream>

class Node;
class Network;
class MemPool;


class Link: public Element
{
  public:

    enum LinkType     {PIPE, PUMP, VALVE};
    enum LinkStatus   {LINK_CLOSED, LINK_OPEN, VALVE_ACTIVE, TEMP_CLOSED};
    enum LinkReaction {BULK, WALL};

    Link(std::string name_);
    virtual ~Link();

    static  Link*  factory(int type_, std::string name_, MemPool* memPool);

    virtual int         type() = 0;
    virtual std::string typeStr() = 0;
    virtual void        convertUnits(Network* nw) = 0;
    virtual double      convertSetting(Network* nw, double s) { return s; }
    virtual void        validate(Network* nw) { }
    virtual bool        isReactive() { return false; }

    // Initializes hydraulic settings
    virtual void   initialize(bool initFlow);
    virtual void   setInitFlow() {}
    virtual void   setInitStatus(int s) {}
    virtual void   setInitSetting(double s) {}
    virtual void   setResistance(Network* nw) {}
    virtual void   setFlowThreshold(const double viscos);
    virtual bool   reduceFlowThreshold();

    // Retrieves hydraulic variables
    virtual double getVelocity() {return 0.0;}
    virtual double getRe(const double q, const double viscos) {return 0.0;}
    virtual double getResistance() {return 0.0;}
    virtual double getUnitHeadLoss();
    virtual double getSetting(Network* nw) { return setting; }

    // Computes head loss, energy usage, and leakage
    virtual void   findHeadLoss(Network* nw, double q) = 0;
    virtual double updateEnergyUsage(Network* nw, int dt) { return 0.0; }
    virtual bool   canLeak() { return false; }
    virtual double findLeakage(Network* nw, double h, double& dqdh) { return 0.0; }


    // Determines special types of links
    virtual bool   isPRV() {return false;}
    virtual bool   isPSV() {return false;}
    virtual bool   isHpPump() {return false;}

    // Used to update and adjust link status/setting
    virtual void   updateStatus(double q, double h1, double h2) { }
    virtual bool   changeStatus(int newStatus,
                                bool makeChange,
                                const std::string reason,
                                std::ostream& msgLog)
                                { return false; }
    virtual bool   changeSetting(double newSetting,
                                 bool makeChange,
                                 const std::string reason,
                                 std::ostream& msgLog)
                                 { return false; }
    virtual void   validateStatus(Network* nw, double qTol) { }
    virtual void   applyControlPattern(std::ostream& msgLog) { }
    std::string    writeStatusChange(int oldStatus);

    // Used for water quality routing
    virtual double getVolume() { return 0.0; }

    // Properties
    bool           rptFlag;          
    Node*          fromNode;         
    Node*          toNode;           
    int            initStatus;       
    double         diameter;         
    double         lossCoeff;        
    double         initSetting;      

    // Computed Variables
    int            status;           
    double         flowThresh0;      
    double         flowThresh;       
    double         flow;             
    double         leakage;          
    double         hLoss;            
    double         hGrad;            
    double         setting;          
    double         quality;          
};

#endif