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(GroupConstPtr fieldGroup, size_t timeStep, const PhaseUsage& phaseUsage);

        void addWell(WellConstPtr wellChild, size_t timeStep, const PhaseUsage& phaseUsage);

        void addGroup(GroupConstPtr 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;

        void applyGroupControls();

        void applyExplicitReinjectionControls(const std::vector<double>& well_reservoirrates_phase,
                                              const std::vector<double>& well_surfacerates_phase);

    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_;


    };

} // namespace Opm
#endif  /* OPM_WELLCOLLECTION_HPP */