Loading...
Searching...
No Matches
GuideRate.hpp
/*
Copyright 2019, 2020 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 <opm/input/eclipse/Schedule/Group/Group.hpp>
#include <opm/input/eclipse/Schedule/Group/GuideRateModel.hpp>
#include <cstddef>
#include <ctime>
#include <limits>
#include <memory>
#include <string>
#include <unordered_map>
#include <utility>
namespace Opm {
class Schedule;
enum class WellGuideRateTarget : std::uint8_t;
} // namespace Opm
namespace Opm {
class GuideRate
{
public:
// used for potentials and well rates
struct RateVector {
RateVector() = default;
RateVector(const double orat, const double grat, const double wrat)
: oil_rat(orat)
, gas_rat(grat)
, wat_rat(wrat)
{}
static RateVector serializationTestObject()
{
return RateVector{1.0, 2.0, 3.0};
}
double eval(const WellGuideRateTarget target) const;
double eval(const Group::GuideRateProdTarget target) const;
double eval(const GuideRateModel::Target target) const;
template<class Serializer>
void serializeOp(Serializer& serializer)
{
serializer(oil_rat);
serializer(gas_rat);
serializer(wat_rat);
}
double oil_rat{0.0};
double gas_rat{0.0};
double wat_rat{0.0};
};
struct GuideRateValue {
GuideRateValue() = default;
GuideRateValue(const double t, const double v, const GuideRateModel::Target tg)
: sim_time(t)
, value (v)
, target (tg)
{}
static GuideRateValue serializationTestObject()
{
return GuideRateValue{1.0, 2.0, GuideRateModel::Target::LIQ};
}
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);
}
template<class Serializer>
void serializeOp(Serializer& serializer)
{
serializer(sim_time);
serializer(value);
serializer(target);
}
double sim_time { std::numeric_limits<double>::lowest() };
double value { std::numeric_limits<double>::lowest() };
GuideRateModel::Target target { GuideRateModel::Target::NONE };
};
explicit GuideRate(const Schedule& schedule);
void setSerializationTestData();
void compute(const std::string& wgname,
const std::size_t report_step,
const double sim_time,
const double oil_pot,
const double gas_pot,
const double wat_pot);
void compute(const std::string& wgname,
const Phase& phase,
const std::size_t report_step,
const std::optional<double> guide_rate);
bool has(const std::string& name) const;
bool hasPotentials(const std::string& name) const;
bool has(const std::string& name, const Phase& phase) const;
double get(const std::string& well, const WellGuideRateTarget target, const RateVector& rates) const;
double get(const std::string& group, const Group::GuideRateProdTarget target, const RateVector& rates) const;
double get(const std::string& name, const GuideRateModel::Target model_target, const RateVector& rates) const;
double get(const std::string& group, const Phase& phase) const;
double getSI(const std::string& well, const WellGuideRateTarget target, const RateVector& rates) const;
double getSI(const std::string& group, const Group::GuideRateProdTarget target, const RateVector& rates) const;
double getSI(const std::string& wgname, const GuideRateModel::Target target, const RateVector& rates) const;
double getSI(const std::string& group, const Phase& phase) const;
void init_grvalue(const std::size_t report_step, const std::string& wgname, GuideRateValue value);
void init_grvalue_SI(const std::size_t report_step, const std::string& wgname, GuideRateValue value);
void updateGuideRateExpiration(const double sim_time,
const std::size_t report_step);
template<class Serializer>
void serializeOp(Serializer& serializer)
{
serializer(values);
serializer(injection_group_values);
serializer(potentials);
serializer(guide_rates_expired);
}
private:
struct GRValState
{
GuideRateValue curr{};
GuideRateValue prev{};
static GRValState serializationTestObject()
{
return GRValState{GuideRateValue::serializationTestObject(),
GuideRateValue::serializationTestObject()};
}
template<class Serializer>
void serializeOp(Serializer& serializer)
{
serializer(curr);
serializer(prev);
}
};
struct pair_hash
{
template <class T1, class T2>
std::size_t operator()(const std::pair<T1, T2>& pair) const
{
return std::hash<T1>()(pair.first) ^ std::hash<T2>()(pair.second);
}
};
using GRValPtr = std::unique_ptr<GRValState>;
using pair = std::pair<Phase, std::string>;
void well_compute(const std::string& wgname,
const std::size_t report_step,
const double sim_time,
const double oil_pot,
const double gas_pot,
const double wat_pot);
void group_compute(const std::string& wgname,
const std::size_t report_step,
const double sim_time,
const double oil_pot,
const double gas_pot,
const double wat_pot);
double eval_form(const GuideRateModel& model,
const std::string& wgId,
const double oil_pot,
const double gas_pot,
const double wat_pot) const;
void assign_grvalue(const std::string& wgname,
const GuideRateModel& model,
GuideRateValue&& value);
double get_grvalue_result(const GRValState& gr) const;
const Schedule& schedule;
std::unordered_map<std::string, GRValPtr> values{};
std::unordered_map<pair, double, pair_hash> injection_group_values{};
std::unordered_map<std::string, RateVector> potentials{};
bool guide_rates_expired {false};
};
} // namespace Opm
#endif
Opm::Schedule
Definition Schedule.hpp:101
Opm::Serializer
Class for (de-)serializing.
Definition Serializer.hpp:94
Opm
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30
Opm::GuideRate::GuideRateValue
Definition GuideRate.hpp:77
Opm::GuideRate::RateVector
Definition GuideRate.hpp:47