opm-simulators/opm/simulators/wells/GroupState.cpp

/*
  Copyright 2021 Equinor

  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/>.
*/

#if HAVE_CONFIG_H
#include "config.h"
#endif // HAVE_CONFIG_H

#include <iterator>

#include <opm/json/JsonObject.hpp>

#include <opm/simulators/wells/GroupState.hpp>

namespace Opm {

GroupState::GroupState(std::size_t np) :
    num_phases(np)
{}

bool GroupState::operator==(const GroupState& other) const {
    return this->m_production_rates == other.m_production_rates &&
           this->production_controls == other.production_controls &&
           this->prod_red_rates == other.prod_red_rates &&
           this->inj_red_rates == other.inj_red_rates &&
           this->inj_resv_rates == other.inj_resv_rates &&
           this->inj_rein_rates == other.inj_rein_rates &&
           this->inj_vrep_rate == other.inj_vrep_rate &&
           this->inj_surface_rates == other.inj_surface_rates &&
           this->m_grat_sales_target == other.m_grat_sales_target &&
           this->injection_controls == other.injection_controls;
}

//-------------------------------------------------------------------------

bool GroupState::has_production_rates(const std::string& gname) const {
    auto group_iter = this->m_production_rates.find(gname);
    return (group_iter != this->m_production_rates.end());
}

void GroupState::update_production_rates(const std::string& gname, const std::vector<double>& rates) {
    if (rates.size() != this->num_phases)
        throw std::logic_error("Wrong number of phases");

    this->m_production_rates[gname] = rates;
}

const std::vector<double>& GroupState::production_rates(const std::string& gname) const {
    auto group_iter = this->m_production_rates.find(gname);
    if (group_iter == this->m_production_rates.end())
        throw std::logic_error("No such group");

    return group_iter->second;
}

//-------------------------------------------------------------------------

bool GroupState::has_production_reduction_rates(const std::string& gname) const {
    auto group_iter = this->prod_red_rates.find(gname);
    return (group_iter != this->prod_red_rates.end());
}

void GroupState::update_production_reduction_rates(const std::string& gname, const std::vector<double>& rates) {
    if (rates.size() != this->num_phases)
        throw std::logic_error("Wrong number of phases");

    this->prod_red_rates[gname] = rates;
}

const std::vector<double>& GroupState::production_reduction_rates(const std::string& gname) const {
    auto group_iter = this->prod_red_rates.find(gname);
    if (group_iter == this->prod_red_rates.end())
        throw std::logic_error("No such group");

    return group_iter->second;
}

//-------------------------------------------------------------------------

bool GroupState::has_injection_reduction_rates(const std::string& gname) const {
    auto group_iter = this->inj_red_rates.find(gname);
    return (group_iter != this->inj_red_rates.end());
}

void GroupState::update_injection_reduction_rates(const std::string& gname, const std::vector<double>& rates) {
    if (rates.size() != this->num_phases)
        throw std::logic_error("Wrong number of phases");

    this->inj_red_rates[gname] = rates;
}

const std::vector<double>& GroupState::injection_reduction_rates(const std::string& gname) const {
    auto group_iter = this->inj_red_rates.find(gname);
    if (group_iter == this->inj_red_rates.end())
        throw std::logic_error("No such group");

    return group_iter->second;
}
//-------------------------------------------------------------------------

bool GroupState::has_injection_surface_rates(const std::string& gname) const {
    auto group_iter = this->inj_surface_rates.find(gname);
    return (group_iter != this->inj_surface_rates.end());
}

void GroupState::update_injection_surface_rates(const std::string& gname, const std::vector<double>& rates) {
    if (rates.size() != this->num_phases)
        throw std::logic_error("Wrong number of phases");

    this->inj_surface_rates[gname] = rates;
}

const std::vector<double>& GroupState::injection_surface_rates(const std::string& gname) const {
    auto group_iter = this->inj_surface_rates.find(gname);
    if (group_iter == this->inj_surface_rates.end())
        throw std::logic_error("No such group");

    return group_iter->second;
}

//-------------------------------------------------------------------------

bool GroupState::has_injection_reservoir_rates(const std::string& gname) const {
    auto group_iter = this->inj_resv_rates.find(gname);
    return (group_iter != this->inj_resv_rates.end());
}

void GroupState::update_injection_reservoir_rates(const std::string& gname, const std::vector<double>& rates) {
    if (rates.size() != this->num_phases)
        throw std::logic_error("Wrong number of phases");

    this->inj_resv_rates[gname] = rates;
}

const std::vector<double>& GroupState::injection_reservoir_rates(const std::string& gname) const {
    auto group_iter = this->inj_resv_rates.find(gname);
    if (group_iter == this->inj_resv_rates.end())
        throw std::logic_error("No such group");

    return group_iter->second;
}

//-------------------------------------------------------------------------

void GroupState::update_injection_rein_rates(const std::string& gname, const std::vector<double>& rates) {
    if (rates.size() != this->num_phases)
        throw std::logic_error("Wrong number of phases");

    this->inj_rein_rates[gname] = rates;
}

const std::vector<double>& GroupState::injection_rein_rates(const std::string& gname) const {
    auto group_iter = this->inj_rein_rates.find(gname);
    if (group_iter == this->inj_rein_rates.end())
        throw std::logic_error("No such group");

    return group_iter->second;
}

//-------------------------------------------------------------------------

void GroupState::update_injection_vrep_rate(const std::string& gname, double rate) {
    this->inj_vrep_rate[gname] = rate;
}

double GroupState::injection_vrep_rate(const std::string& gname) const {
    auto group_iter = this->inj_vrep_rate.find(gname);
    if (group_iter == this->inj_vrep_rate.end())
        throw std::logic_error("No such group");

    return group_iter->second;
}

//-------------------------------------------------------------------------

void GroupState::update_grat_sales_target(const std::string& gname, double target) {
    this->m_grat_sales_target[gname] = target;
}

double GroupState::grat_sales_target(const std::string& gname) const {
    auto group_iter = this->m_grat_sales_target.find(gname);
    if (group_iter == this->m_grat_sales_target.end())
        throw std::logic_error("No such group");

    return group_iter->second;
}

bool GroupState::has_grat_sales_target(const std::string& gname) const {
    return (this->m_grat_sales_target.count(gname) > 0);
}

//-------------------------------------------------------------------------

bool GroupState::has_production_control(const std::string& gname) const {
    auto group_iter = this->production_controls.find(gname);
    if (group_iter == this->production_controls.end())
        return false;

    return true;
}

void GroupState::production_control(const std::string& gname, Group::ProductionCMode cmode) {
    this->production_controls[gname] = cmode;
}

Group::ProductionCMode GroupState::production_control(const std::string& gname) const {
    auto group_iter = this->production_controls.find(gname);
    if (group_iter == this->production_controls.end())
        throw std::logic_error("Could not find any control for production group: " + gname);

    return group_iter->second;
}

//-------------------------------------------------------------------------

bool GroupState::has_injection_control(const std::string& gname, Phase phase) const {
    return this->injection_controls.count(std::make_pair(phase, gname)) > 0;
}

void GroupState::injection_control(const std::string& gname, Phase phase, Group::InjectionCMode cmode) {
    this->injection_controls[ std::make_pair(phase, gname) ] = cmode;
}

Group::InjectionCMode GroupState::injection_control(const std::string& gname, Phase phase) const {
    auto key = std::make_pair(phase, gname);
    auto group_iter = this->injection_controls.find( key );
    if (group_iter == this->injection_controls.end())
        throw std::logic_error("Could not find ontrol for injection group: " + gname);

    return group_iter->second;
}

//-------------------------------------------------------------------------

GPMaint::State& GroupState::gpmaint(const std::string& gname) {
    if (!this->gpmaint_state.has(gname))
        this->gpmaint_state.add(gname, GPMaint::State{});
    return this->gpmaint_state[gname];
}


//-------------------------------------------------------------------------

void GroupState::update_gpmaint_target(const std::string& gname, double target) {
    this->m_gpmaint_target[gname] = target;
}

double GroupState::gpmaint_target(const std::string& gname) const {
    auto group_iter = this->m_gpmaint_target.find(gname);
    if (group_iter == this->m_gpmaint_target.end())
        throw std::logic_error("No such group");

    return group_iter->second;
}

bool GroupState::has_gpmaint_target(const std::string& gname) const {
    return (this->m_gpmaint_target.count(gname) > 0);
}

}