WellsManager.hpp

Go to the documentation of this file.

/*
  Copyright 2012 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_WELLSMANAGER_HEADER_INCLUDED
#define OPM_WELLSMANAGER_HEADER_INCLUDED


#include <opm/parser/eclipse/EclipseState/EclipseState.hpp>

#include <opm/core/wells/WellCollection.hpp>
#include <opm/core/wells/WellsGroup.hpp>
#include <opm/parser/eclipse/EclipseState/Schedule/GroupTree.hpp>

#include <opm/core/utility/CompressedPropertyAccess.hpp>

struct Wells;
struct UnstructuredGrid;


namespace Opm
{
    struct WellData
    {
        WellType type;
        bool allowCrossFlow;
        // WellControlType control;
        // double target;
        double reference_bhp_depth;
        // Opm::InjectionSpecification::InjectorType injected_phase;
        int welspecsline;
    };


    struct PerfData
    {
        int cell;
        double well_index;
    };
    class WellsManager
    {
    public:
        WellsManager();

        explicit WellsManager(struct Wells* W);

        template<class F2C, class FC>
        WellsManager(const Opm::EclipseStateConstPtr eclipseState,
                     const size_t timeStep,
                     int num_cells,
                     const int* global_cell,
                     const int* cart_dims,
                     int dimensions,
                     const F2C& f2c,
                     FC begin_face_centroids,
                     const double* permeability,
                     bool is_parallel_run=false);

        WellsManager(const Opm::EclipseStateConstPtr eclipseState,
                     const size_t timeStep,
                     const UnstructuredGrid& grid,
                     const double* permeability);
        ~WellsManager();

        bool empty() const;

        const Wells* c_wells() const;

        const WellCollection& wellCollection() const;

        bool conditionsMet(const std::vector<double>& well_bhp,
                           const std::vector<double>& well_reservoirrates_phase,
                           const std::vector<double>& well_surfacerates_phase);

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


    private:
        template<class C2F, class FC>
        void init(const Opm::EclipseStateConstPtr eclipseState,
                  const size_t timeStep,
                  int num_cells,
                  const int* global_cell,
                  const int* cart_dims,
                  int dimensions,
                  const C2F& cell_to_faces,
                  FC begin_face_centroids,
                  const double* permeability);
        // Disable copying and assignment.
        WellsManager(const WellsManager& other);
        WellsManager& operator=(const WellsManager& other);
        static void setupCompressedToCartesian(const int* global_cell, int number_of_cells, std::map<int,int>& cartesian_to_compressed );
        void setupWellControls(std::vector<WellConstPtr>& wells, size_t timeStep,
                               std::vector<std::string>& well_names, const PhaseUsage& phaseUsage,
                               const std::vector<int>& wells_on_proc);

        template<class C2F, class FC, class NTG>
        void createWellsFromSpecs( std::vector<WellConstPtr>& wells, size_t timeStep,
                                   const C2F& cell_to_faces, 
                                   const int* cart_dims,
                                   FC begin_face_centroids, 
                                   int dimensions,
                                   std::vector<double>& dz,
                                   std::vector<std::string>& well_names,
                                   std::vector<WellData>& well_data,
                                   std::map<std::string, int> & well_names_to_index,
                                   const PhaseUsage& phaseUsage,
                                   const std::map<int,int>& cartesian_to_compressed,
                                   const double* permeability,
                                   const NTG& ntg,
                                   std::vector<int>& wells_on_proc);

        void addChildGroups(GroupTreeNodeConstPtr parentNode, ScheduleConstPtr schedule, size_t timeStep, const PhaseUsage& phaseUsage);
        void setupGuideRates(std::vector<WellConstPtr>& wells, const size_t timeStep, std::vector<WellData>& well_data, std::map<std::string, int>& well_names_to_index);


        // Data
        Wells* w_;
        WellCollection well_collection_;
        // Whether this is a parallel simulation
        bool is_parallel_run_;
    };

} // namespace Opm

#include "WellsManager_impl.hpp"
#endif // OPM_WELLSMANAGER_HEADER_INCLUDED