tankmixmodel.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 TANKMIXMODEL_H_
#define TANKMIXMODEL_H_

class Tank;
class QualModel;
class SegPool;
struct Segment;


class TankMixModel
{
  public:

    enum MixingModel {
        MIX1,          
        MIX2,          
        FIFO,          
        LIFO           
    };

    static const char* MixingModelWords[];

    // Constructor / Destructor
    TankMixModel();
    ~TankMixModel();

    // Methods
    void   init(Tank* tank, SegPool* segPool, double _cTol);
    double findQuality(double vNet, double vIn, double wIn, SegPool* segPool);
    double react(Tank* tank, QualModel* qualModel, double tstep);
    double storedMass();

    // Properties
    int      type;           
    double   cTol;           
    double   fracMixed;      

  private:
    // Methods
    double findMIX1Quality(double vNet, double vIn, double wIn);
    double findMIX2Quality(double vNet, double vIn, double wIn);
    double findFIFOQuality(double vNet, double vIn, double wIn, SegPool* segPool);
    double findLIFOQuality(double vNet, double vIn, double wIn, SegPool* segPool);

    // Properties
    double   cTank;          
    double   vMixed;         
    Segment* firstSeg;       
    Segment* lastSeg;        
};

#endif // TANKMIXING_H_