mirror of
https://github.com/OPM/opm-simulators.git
synced 2024-12-19 05:53:28 -06:00
327 lines
12 KiB
C++
327 lines
12 KiB
C++
/*
|
|
Copyright 2011 SINTEF ICT, Applied Mathematics.
|
|
|
|
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/>.
|
|
*/
|
|
|
|
#include "config.h"
|
|
#include <opm/core/wells/WellCollection.hpp>
|
|
|
|
#include <opm/parser/eclipse/EclipseState/Schedule/Well.hpp>
|
|
#include <opm/parser/eclipse/EclipseState/Schedule/Group.hpp>
|
|
|
|
#include <boost/lexical_cast.hpp>
|
|
|
|
#include <memory>
|
|
|
|
namespace Opm
|
|
{
|
|
void WellCollection::addField(const Group& fieldGroup, size_t timeStep, const PhaseUsage& phaseUsage) {
|
|
WellsGroupInterface* fieldNode = findNode(fieldGroup.name());
|
|
if (fieldNode) {
|
|
OPM_THROW(std::runtime_error, "Trying to add FIELD node, but this already exists. Can only have one FIELD node.");
|
|
}
|
|
|
|
roots_.push_back(createGroupWellsGroup(fieldGroup, timeStep, phaseUsage));
|
|
}
|
|
|
|
void WellCollection::addGroup(const Group& groupChild, std::string parent_name,
|
|
size_t timeStep, const PhaseUsage& phaseUsage) {
|
|
WellsGroupInterface* parent = findNode(parent_name);
|
|
if (!parent) {
|
|
OPM_THROW(std::runtime_error, "Trying to add child group to group named " << parent_name << ", but this does not exist in the WellCollection.");
|
|
}
|
|
|
|
if (findNode(groupChild.name())) {
|
|
OPM_THROW(std::runtime_error, "Trying to add child group named " << groupChild.name() << ", but this group is already in the WellCollection.");
|
|
|
|
}
|
|
|
|
if (groupChild.isProductionGroup(timeStep) || groupChild.isInjectionGroup(timeStep)) {
|
|
group_control_active_ = true;
|
|
}
|
|
|
|
std::shared_ptr<WellsGroupInterface> child = createGroupWellsGroup(groupChild, timeStep, phaseUsage);
|
|
|
|
if (child->injSpec().control_mode_ == InjectionSpecification::VREP) {
|
|
having_vrep_groups_ = true;
|
|
}
|
|
|
|
WellsGroup* parent_as_group = static_cast<WellsGroup*> (parent);
|
|
if (!parent_as_group) {
|
|
OPM_THROW(std::runtime_error, "Trying to add child group to group named " << parent->name() << ", but it's not a group.");
|
|
}
|
|
parent_as_group->addChild(child);
|
|
child->setParent(parent);
|
|
}
|
|
|
|
void WellCollection::addWell(const Well* wellChild, size_t timeStep, const PhaseUsage& phaseUsage) {
|
|
if (wellChild->getStatus(timeStep) == WellCommon::SHUT) {
|
|
//SHUT wells are not added to the well collection
|
|
return;
|
|
}
|
|
|
|
WellsGroupInterface* parent = findNode(wellChild->getGroupName(timeStep));
|
|
if (!parent) {
|
|
OPM_THROW(std::runtime_error, "Trying to add well " << wellChild->name() << " Step: " << boost::lexical_cast<std::string>(timeStep) << " to group named " << wellChild->getGroupName(timeStep) << ", but this group does not exist in the WellCollection.");
|
|
}
|
|
|
|
std::shared_ptr<WellsGroupInterface> child = createWellWellsGroup(wellChild, timeStep, phaseUsage);
|
|
|
|
WellsGroup* parent_as_group = static_cast<WellsGroup*> (parent);
|
|
if (!parent_as_group) {
|
|
OPM_THROW(std::runtime_error, "Trying to add well to group named " << wellChild->getGroupName(timeStep) << ", but it's not a group.");
|
|
}
|
|
parent_as_group->addChild(child);
|
|
|
|
leaf_nodes_.push_back(static_cast<WellNode*>(child.get()));
|
|
|
|
child->setParent(parent);
|
|
}
|
|
|
|
const std::vector<WellNode*>& WellCollection::getLeafNodes() const {
|
|
return leaf_nodes_;
|
|
}
|
|
|
|
WellsGroupInterface* WellCollection::findNode(const std::string& name)
|
|
{
|
|
|
|
for (size_t i = 0; i < roots_.size(); i++) {
|
|
WellsGroupInterface* result = roots_[i]->findGroup(name);
|
|
if (result) {
|
|
return result;
|
|
}
|
|
}
|
|
return NULL;
|
|
}
|
|
|
|
const WellsGroupInterface* WellCollection::findNode(const std::string& name) const
|
|
{
|
|
|
|
for (size_t i = 0; i < roots_.size(); i++) {
|
|
WellsGroupInterface* result = roots_[i]->findGroup(name);
|
|
if (result) {
|
|
return result;
|
|
}
|
|
}
|
|
return NULL;
|
|
}
|
|
|
|
|
|
WellNode& WellCollection::findWellNode(const std::string& name) const
|
|
{
|
|
auto well_node = std::find_if(leaf_nodes_.begin(), leaf_nodes_.end(),
|
|
[&] ( WellNode* w) {
|
|
return w->name() == name;
|
|
});
|
|
|
|
// Does not find the well
|
|
if (well_node == leaf_nodes_.end()) {
|
|
OPM_THROW(std::runtime_error, "Could not find well " << name << " in the well collection!\n");
|
|
}
|
|
|
|
return *(*well_node);
|
|
}
|
|
|
|
/// Adds the child to the collection
|
|
/// and appends it to parent's children.
|
|
/// \param[in] child the child node
|
|
/// \param[in] parent name of parent node
|
|
|
|
void WellCollection::addChild(std::shared_ptr<WellsGroupInterface>& child_node,
|
|
const std::string& parent_name)
|
|
{
|
|
WellsGroupInterface* parent = findNode(parent_name);
|
|
if (parent == NULL) {
|
|
OPM_THROW(std::runtime_error, "Parent with name = " << parent_name << " not found.");
|
|
}
|
|
assert(!parent->isLeafNode());
|
|
static_cast<WellsGroup*>(parent)->addChild(child_node);
|
|
if (child_node->isLeafNode()) {
|
|
leaf_nodes_.push_back(static_cast<WellNode*>(child_node.get()));
|
|
}
|
|
|
|
}
|
|
|
|
/// Adds the node to the collection (as a root node)
|
|
|
|
void WellCollection::addChild(std::shared_ptr<WellsGroupInterface>& child_node)
|
|
{
|
|
roots_.push_back(child_node);
|
|
if (child_node->isLeafNode()) {
|
|
leaf_nodes_.push_back(static_cast<WellNode*> (child_node.get()));
|
|
}
|
|
}
|
|
|
|
bool WellCollection::conditionsMet(const std::vector<double>& well_bhp,
|
|
const std::vector<double>& well_reservoirrates_phase,
|
|
const std::vector<double>& well_surfacerates_phase)
|
|
{
|
|
for (size_t i = 0; i < roots_.size(); i++) {
|
|
WellPhasesSummed phases;
|
|
if (!roots_[i]->conditionsMet(well_bhp,
|
|
well_reservoirrates_phase,
|
|
well_surfacerates_phase,
|
|
phases)) {
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
void WellCollection::setWellsPointer(Wells* wells) {
|
|
for(size_t i = 0; i < leaf_nodes_.size(); i++) {
|
|
leaf_nodes_[i]->setWellsPointer(wells, i);
|
|
}
|
|
}
|
|
|
|
void WellCollection::applyGroupControls()
|
|
{
|
|
for (size_t i = 0; i < roots_.size(); ++i) {
|
|
roots_[i]->applyProdGroupControls();
|
|
roots_[i]->applyInjGroupControls();
|
|
}
|
|
}
|
|
|
|
/// Applies explicit reinjection controls. This must be called at each timestep to be correct.
|
|
/// \param[in] well_reservoirrates_phase
|
|
/// A vector containing reservoir rates by phase for each well.
|
|
/// Is assumed to be ordered the same way as the related Wells-struct,
|
|
/// with all phase rates of a single well adjacent in the array.
|
|
/// \param[in] well_surfacerates_phase
|
|
/// A vector containing surface rates by phase for each well.
|
|
/// Is assumed to be ordered the same way as the related Wells-struct,
|
|
/// with all phase rates of a single well adjacent in the array.
|
|
|
|
void WellCollection::applyExplicitReinjectionControls(const std::vector<double>& well_reservoirrates_phase,
|
|
const std::vector<double>& well_surfacerates_phase)
|
|
{
|
|
for (size_t i = 0; i < roots_.size(); ++i) {
|
|
roots_[i]->applyExplicitReinjectionControls(well_reservoirrates_phase, well_surfacerates_phase);
|
|
}
|
|
}
|
|
|
|
|
|
void WellCollection::applyVREPGroupControls(const std::vector<double>& well_voidage_rates,
|
|
const std::vector<double>& conversion_coeffs)
|
|
{
|
|
for (size_t i = 0; i < roots_.size(); ++i) {
|
|
roots_[i]->applyVREPGroupControls(well_voidage_rates, conversion_coeffs);
|
|
}
|
|
}
|
|
|
|
|
|
// TODO: later, it should be extended to update group targets
|
|
bool WellCollection::needUpdateWellTargets() const
|
|
{
|
|
return needUpdateInjectionTargets() || needUpdateProductionTargets();
|
|
}
|
|
|
|
|
|
bool WellCollection::needUpdateInjectionTargets() const
|
|
{
|
|
// TODO: it should based on individual group
|
|
// With current approach, it will potentially result in more update,
|
|
// thus more iterations, while it will not cause result wrong.
|
|
// If the group control and individual control is mixed, then it need to
|
|
// update the well targets
|
|
bool any_group_control_node = false;
|
|
bool any_individual_control_node = false;
|
|
|
|
for (size_t i = 0; i < leaf_nodes_.size(); ++i) {
|
|
if (leaf_nodes_[i]->isInjector()) {
|
|
if (leaf_nodes_[i]->individualControl()) {
|
|
any_individual_control_node = true;
|
|
} else {
|
|
any_group_control_node = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
return (any_group_control_node && any_individual_control_node);
|
|
}
|
|
|
|
|
|
// These two functions should be made one
|
|
bool WellCollection::needUpdateProductionTargets() const
|
|
{
|
|
// TODO: it should based on individual group
|
|
// With current approach, it will potentially result in more update,
|
|
// thus more iterations, while it will not cause result wrong.
|
|
// If the group control and individual control is mixed, then it need to
|
|
// update the well targets
|
|
bool any_group_control_node = false;
|
|
bool any_individual_control_node = false;
|
|
|
|
for (size_t i = 0; i < leaf_nodes_.size(); ++i) {
|
|
if (leaf_nodes_[i]->isProducer()) {
|
|
if (leaf_nodes_[i]->individualControl()) {
|
|
any_individual_control_node = true;
|
|
} else {
|
|
any_group_control_node = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
return (any_group_control_node && any_individual_control_node);
|
|
}
|
|
|
|
|
|
void WellCollection::updateWellTargets(const std::vector<double>& well_rates)
|
|
{
|
|
if ( !needUpdateWellTargets() ) {
|
|
return;
|
|
}
|
|
|
|
// set the target_updated to be false
|
|
for (WellNode* well_node : leaf_nodes_) {
|
|
well_node->setTargetUpdated(false);
|
|
}
|
|
|
|
// TODO: currently, we only handle the level of the well groups for the moment, i.e. the level just above wells
|
|
// We believe the relations between groups are similar to the relations between different wells inside the same group.
|
|
// While there will be somre more complication invloved for sure.
|
|
for (size_t i = 0; i < leaf_nodes_.size(); ++i) {
|
|
// find a node needs to update targets, then update targets for all the wellls inside the group.
|
|
// if (leaf_nodes_[i]->shouldUpdateWellTargets() && !leaf_nodes_[i]->individualControl()) {
|
|
if (!leaf_nodes_[i]->individualControl() && !leaf_nodes_[i]->targetUpdated()) {
|
|
WellsGroupInterface* parent_node = leaf_nodes_[i]->getParent();
|
|
// update the target within this group.
|
|
if (leaf_nodes_[i]->isProducer()) {
|
|
parent_node->updateWellProductionTargets(well_rates);
|
|
}
|
|
|
|
if (leaf_nodes_[i]->isInjector()) {
|
|
parent_node->updateWellInjectionTargets(well_rates);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
bool WellCollection::havingVREPGroups() const
|
|
{
|
|
return having_vrep_groups_;
|
|
}
|
|
|
|
|
|
bool WellCollection::groupControlActive() const
|
|
{
|
|
return group_control_active_;
|
|
}
|
|
|
|
}
|