WellCollection.hpp

Go to the documentation of this file.

/*
  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/>.
*/
#ifndef OPM_WELLCOLLECTION_HPP
#define OPM_WELLCOLLECTION_HPP
 
#include <vector>
#include <memory>
 
#include <opm/core/wells/WellsGroup.hpp>
#include <opm/core/grid.h>
#include <opm/core/props/phaseUsageFromDeck.hpp>
 
#include <opm/parser/eclipse/EclipseState/Schedule/Well.hpp>
#include <opm/parser/eclipse/EclipseState/Schedule/Group.hpp>
 
namespace Opm
{
 
    class WellCollection
    {
    public:
 
        void addField(const Group& fieldGroup, size_t timeStep, const PhaseUsage& phaseUsage);
 
        void addWell(const Well* wellChild, size_t timeStep, const PhaseUsage& phaseUsage);
 
        void addGroup(const Group& groupChild, std::string parent_name,
                      size_t timeStep, const PhaseUsage& phaseUsage);
 
        void addChild(std::shared_ptr<WellsGroupInterface>& child_node,
                      const std::string& parent);
 
        void addChild(std::shared_ptr<WellsGroupInterface>& child_node);
 
        bool conditionsMet(const std::vector<double>& well_bhp,
                           const std::vector<double>& well_reservoirrates_phase,
                           const std::vector<double>& well_surfacerates_phase);
 
        void setWellsPointer(Wells* wells);
 
        const std::vector<WellNode*>& getLeafNodes() const;
 
        WellsGroupInterface* findNode(const std::string& name);
 
        const WellsGroupInterface* findNode(const std::string& name) const;
 
 
        WellNode& findWellNode(const std::string& name) const;
 
 
        void applyGroupControls();
 
        void applyExplicitReinjectionControls(const std::vector<double>& well_reservoirrates_phase,
                                              const std::vector<double>& well_surfacerates_phase);
 
 
        void applyVREPGroupControls(const std::vector<double>& well_voidage_rates,
                                    const std::vector<double>& conversion_coeffs);
 
        bool needUpdateWellTargets() const;
 
        bool needUpdateInjectionTargets() const;
 
        bool needUpdateProductionTargets() const;
 
        void updateWellTargets(const std::vector<double>& well_rates);
 
        bool havingVREPGroups() const;
 
        bool groupControlActive() const;
 
        bool groupControlApplied() const;
 
        // It is considered converged if eitehr the group targets are matched or the group targets are not matched while the wells are
        // running under their own limits so that they can not produce more
        // It is considered not converged if the group targets are not matched while some of the wells are still running under group control
        // The strategy may need to be adjusted when more complicated multi-layered group control situation applied, not sure about thatyet.
        bool groupTargetConverged(const std::vector<double>& well_rates) const;
 
 
        void setGuideRatesWithPotentials(const Wells* wells,
                                         const PhaseUsage& phase_usage,
                                         const std::vector<double>& well_potentials) const;
 
 
        bool requireWellPotentials() const;
 
    private:
        // To account for the possibility of a forest
        std::vector<std::shared_ptr<WellsGroupInterface> > roots_;
 
        // This will be used to traverse the bottom nodes.
        std::vector<WellNode*> leaf_nodes_;
 
        bool having_vrep_groups_ = false;
 
        bool group_control_active_ = false;
 
        // This is used to mark whether apply or update the group control
        bool group_control_applied_ = false;
    };
 
} // namespace Opm
 
#endif  /* OPM_WELLCOLLECTION_HPP */