GuideRate.hpp

Go to the documentation of this file.

/*
  Copyright 2019 Equinor ASA.
 
  This file is part of the Open Porous Media project (OPM).
 
  OPM 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 3 of the License, or
  (at your option) any later version.
 
  OPM 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 OPM.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef GUIDE_RATE_HPP
#define GUIDE_RATE_HPP
 
#include <string>
#include <cstddef>
#include <ctime>
#include <unordered_map>
 
#include <opm/parser/eclipse/EclipseState/Schedule/Well/Well.hpp>
#include <opm/parser/eclipse/EclipseState/Schedule/Group/Group.hpp>
#include <opm/parser/eclipse/EclipseState/Schedule/Group/GuideRateModel.hpp>
 
namespace Opm {
 
class Schedule;
class GuideRate {
 
public:
// used for potentials and well rates
struct RateVector {
    RateVector () = default;
    RateVector (double orat, double grat, double wrat) :
        oil_rat(orat),
        gas_rat(grat),
        wat_rat(wrat)
    {}
 
 
    double eval(Group::GuideRateTarget target) const;
    double eval(Well::GuideRateTarget target) const;
    double eval(GuideRateModel::Target target) const;
 
 
    double oil_rat;
    double gas_rat;
    double wat_rat;
};
 
 
private:
 
struct GuideRateValue {
    GuideRateValue() = default;
    GuideRateValue(double t, double v, GuideRateModel::Target tg):
        sim_time(t),
        value(v),
        target(tg)
    {}
 
    bool operator==(const GuideRateValue& other) const {
        return (this->sim_time == other.sim_time &&
                this->value == other.value);
    }
 
    bool operator!=(const GuideRateValue& other) const {
        return !(*this == other);
    }
 
    double sim_time;
    double value;
    GuideRateModel::Target target;
};
 
 
public:
    GuideRate(const Schedule& schedule);
    void   compute(const std::string& wgname, size_t report_step, double sim_time, double oil_pot, double gas_pot, double wat_pot);
    double get(const std::string& well, Well::GuideRateTarget target, const RateVector& rates) const;
    double get(const std::string& group, Group::GuideRateTarget target, const RateVector& rates) const;
    double get(const std::string& name, GuideRateModel::Target model_target, const RateVector& rates) const;
    bool has(const std::string& name) const;
 
private:
    void well_compute(const std::string& wgname, size_t report_step, double sim_time, double oil_pot, double gas_pot, double wat_pot);
    void group_compute(const std::string& wgname, size_t report_step, double sim_time, double oil_pot, double gas_pot, double wat_pot);
    double eval_form(const GuideRateModel& model, double oil_pot, double gas_pot, double wat_pot, const GuideRateValue * prev) const;
    double eval_group_pot() const;
    double eval_group_resvinj() const;
 
    std::unordered_map<std::string, GuideRateValue> values;
    std::unordered_map<std::string, RateVector > potentials;
    const Schedule& schedule;
};
 
}
 
#endif