ResOpt/coupledmodel.h at master · iocenter/ResOpt · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/*
 * This file is part of the ResOpt project.
 *
 * Copyright (C) 2011-2012 Aleksander O. Juell <aleksander.juell@ntnu.no>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */


#ifndef COUPLEDMODEL_H
#define COUPLEDMODEL_H

#include "model.h"

#include "realvariable.h"
#include "binaryvariable.h"
#include "intvariable.h"
#include "constraint.h"

namespace ResOpt
{
class ProductionWell;
class MidPipe;
class Separator;
class PressureBooster;


/**
 * @brief A Model where mass balance is allways feasible.
 * @details In a coupled model, the output streams from an upstream part of the project is transfered as input streams to the downstream parts of the project.
 *          This ensures that the mass balance is always honoured.
 *
 */
class CoupledModel : public Model
{
private:

    QVector<shared_ptr<BinaryVariable> > m_vars_binary;     // vector containing all binary variables
    QVector<shared_ptr<RealVariable> > m_vars_real;         // vector containing all real variables
    QVector<shared_ptr<IntVariable> > m_vars_integer;       // vector containing all integer variables
    QVector<shared_ptr<Constraint> > m_cons;                // vector containing all the constraints

    /**
    * @brief Adds the streams flowing from this well to the upstream connected pipes
    *
    * @param w
    */
    void addStreamsUpstream(ProductionWell *w);

    /**
    * @brief Adds the streams flowing from this pipe to the upstream connected pipes (or separators)
    *
    * @param p
     */
    void addStreamsUpstream(MidPipe *p, Well *from_well, double flow_frac);


    /**
     * @brief Adds the streams flowing from this separator to the upstream connected pipe
     *
     * @param s
     */
    void addStreamsUpstream(Separator *s, Well *from_well, double flow_frac);

    /**
     * @brief Adds the streams flowing from this booster to the upstream connected pipe
     *
     * @param b
     */
    void addStreamsUpstream(PressureBooster *b, Well *from_well, double flow_frac);


public:
    CoupledModel();
    CoupledModel(const CoupledModel &m);

    virtual ~CoupledModel();

    // virtual functions
    virtual Model* clone() const {return new CoupledModel(*this);}

    virtual QString description() const {return QString("COUPLED MODEL\n\n");}

    virtual void initialize();
    virtual void process();

    virtual void updateStreams();
    virtual bool updateConstraints();

    virtual QVector<shared_ptr<BinaryVariable> >& binaryVariables(bool force_refresh = false);
    virtual QVector<shared_ptr<RealVariable> >& realVariables(bool force_refresh = false);
    virtual QVector<shared_ptr<IntVariable> >& integerVariables(bool force_refresh = false);
    virtual QVector<shared_ptr<Constraint> >& constraints(bool force_refresh = false);

    virtual QVector<shared_ptr<RealVariable> > realVariables(Component *c);

    virtual int numberOfRealVariables() const {return m_vars_real.size();}
    virtual int numberOfBinaryVariables() const {return m_vars_binary.size();}
    virtual int numberOfIntegerVariables() const {return m_vars_integer.size();}
    virtual int numberOfConstraints() const {return m_cons.size();}

    virtual double realVariableValue(int i) const {return m_vars_real.at(i)->value();}
    virtual double binaryVariableValue(int i) const {return m_vars_binary.at(i)->value();}
    virtual double integerVariableValue(int i) const {return m_vars_integer.at(i)->value();}
    virtual double constraintValue(int i) const {return m_cons.at(i)->value();}

};


} // namespace ResOpt

#endif // COUPLEDMODEL_H