node.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 NODE_H_
#define NODE_H_

#include "Elements/element.h"

#include <string>

class Network;
class Emitter;
class QualSource;
class MemPool;


class Node: public Element
{
  public:

    enum NodeType  {JUNCTION, TANK, RESERVOIR};

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

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

    virtual int    type() = 0;
    virtual void   convertUnits(Network* nw) = 0;
    virtual void   initialize(Network* nw);

    // Overridden for Junction nodes
    virtual void   findFullDemand(double multiplier, double patternFactor) { }
    virtual double findActualDemand(Network* nw, double h, double& dqdh) { return 0; }
    virtual double findEmitterFlow(double h, double& dqdh) { return 0; }
    virtual void   setFixedGrade() { fixedGrade = false; }
    virtual bool   isPressureDeficient(Network* nw) { return false; }
    virtual bool   hasEmitter() { return false; }

    // Overridden for Tank nodes
    virtual void   validate() { }
    virtual bool   isReactive() { return false; }
    virtual bool   isFull() { return false; }
    virtual bool   isEmpty() { return false; }
    virtual bool   isClosed(double flow) { return false; }
    virtual double getVolume() { return 0.0; }

    // Input Parameters
    bool           rptFlag;       
    double         elev;          
    double         xCoord;        
    double         yCoord;        
    double         initQual;      
    QualSource*    qualSource;    

    // Computed Variables
    bool           fixedGrade;    
    double         head;          
    double         qGrad;         
    double         fullDemand;    
    double         actualDemand;  
    double         outflow;       
    double         quality;       
};

#endif