AggregateGroupData.hpp

/*
  Copyright (c) 2018 Statoil 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 OPM_AGGREGATE_GROUP_DATA_HPP
#define OPM_AGGREGATE_GROUP_DATA_HPP

#include <opm/output/eclipse/WindowedArray.hpp>

#include <opm/io/eclipse/PaddedOutputString.hpp>

#include <cstddef>
#include <string>
#include <vector>
#include <map>

namespace Opm {
class Schedule;
class SummaryState;
class UnitSystem;
} // Opm

namespace Opm { namespace RestartIO { namespace Helpers {

class AggregateGroupData
{
public:
    explicit AggregateGroupData(const std::vector<int>& inteHead);

    void captureDeclaredGroupData(const Opm::Schedule&        sched,
                         const Opm::UnitSystem&               units,
                         const std::size_t                    simStep,
                         const Opm::SummaryState&             sumState,
                         const std::vector<int>&              inteHead);


    void captureDeclaredGroupDataLGR(const Opm::Schedule&        sched,
                                     const Opm::UnitSystem&      units,
                                     const std::size_t           simStep,
                                     const Opm::SummaryState&    sumState,
                                     const std::string&          lgr_tag);

    const std::vector<int>& getIGroup() const
    {
        return this->iGroup_.data();
    }

    const std::vector<float>& getSGroup() const
    {
        return this->sGroup_.data();
    }

    const std::vector<double>& getXGroup() const
    {
        return this->xGroup_.data();
    }

    const std::vector<EclIO::PaddedOutputString<8>>& getZGroup() const
    {
        return this->zGroup_.data();
    }

    const std::vector<std::string> restart_group_keys = {"GOPP", "GWPP", "GOPR", "GWPR", "GGPR",
                                                         "GVPR", "GWIR", "GGIR", "GWCT", "GGOR",
                                                         "GOPT", "GWPT", "GGPT", "GVPT",
                                                         "GOPTS", "GGPTS",
                                                         "GWIT" , "GGIT" , "GVIT",
                                                         "GOPTH", "GWPTH", "GGPTH",
                                                         "GWITH", "GGITH",
                                                         "GOPGR", "GWPGR", "GGPGR", "GVPGR",
                                                         "GOIGR", "GWIGR", "GGIGR",
                                                         "GGCR", "GGIMR", "GGCT", "GGIMT",
                                                        };

    // Note: guide rates don't exist at the FIELD level.
    const std::vector<std::string> restart_field_keys = {"FOPP", "FWPP", "FOPR", "FWPR", "FGPR",
                                                         "FVPR", "FWIR", "FGIR", "FWCT", "FGOR",
                                                         "FOPT", "FWPT", "FGPT", "FVPT",
                                                         "FOPTS", "FGPTS",
                                                         "FWIT" , "FGIT" , "FVIT",
                                                         "FOPTH", "FWPTH", "FGPTH",
                                                         "FGCR", "FGCT", "FGIMR", "FGIMT",

                                                         "FWITH", "FGITH"};

    const std::vector<std::string> restart_well_keys = {"WOPP",  "WWPP", "WOPR", "WWPR", "WGPR",
                                                        "WVPR",  "WWIR", "WGIR", "WWCT", "WGOR",
                                                        "WOPT",  "WWPT", "WGPT", "WVPT",
                                                        "WOPTS", "WGPTS",
                                                        "WWIT" , "WGIT", "WVIT",
                                                        "WOPTH", "WWPTH", "WGPTH",
                                                        /*"WGCR",*/  /*"WGCT",*/ /*"WGIMR",*/ /*"WGIMT",*/
                                                        "WWITH", "WGITH"};

    const std::map<std::string, size_t> groupKeyToIndex = {
                                                           {"GOPR",  0},
                                                           {"GWPR",  1},
                                                           {"GGPR",  2},
                                                           {"GVPR",  3},
                                                           {"GWIR",  5},
                                                           {"GGIR",  6},
                                                           {"GWCT",  8},
                                                           {"GGOR",  9},
                                                           {"GOPT", 10},
                                                           {"GWPT", 11},
                                                           {"GGPT", 12},
                                                           {"GVPT", 13},
                                                           {"GWIT", 15},
                                                           {"GGIT", 16},
                                                           {"GVIT", 17},
                                                           {"GGCR", 19},
                                                           {"GGCT", 21},
                                                           {"GOPP", 22},
                                                           {"GWPP", 23},
                                                           {"GGIMR", 51},
                                                           {"GGIMT", 52},
                                                           {"GOPTS", 73},
                                                           {"GGPTS", 74},
                                                           {"GOPGR", 85},
                                                           {"GWPGR", 86},
                                                           {"GGPGR", 87},
                                                           {"GVPGR", 88},
                                                           {"GOIGR", 89},
                                                           {"GWIGR", 91},
                                                           {"GGIGR", 93},
                                                           {"GOPTH", 135},
                                                           {"GWPTH", 139},
                                                           {"GWITH", 140},
                                                           {"GGPTH", 143},
                                                           {"GGITH", 144},
    };

    const std::map<std::string, size_t> fieldKeyToIndex = {
                                                           {"FOPR",  0},
                                                           {"FWPR",  1},
                                                           {"FGPR",  2},
                                                           {"FVPR",  3},
                                                           {"FWIR",  5},
                                                           {"FGIR",  6},
                                                           {"FWCT",  8},
                                                           {"FGOR",  9},
                                                           {"FOPT", 10},
                                                           {"FWPT", 11},
                                                           {"FGPT", 12},
                                                           {"FVPT", 13},
                                                           {"FWIT", 15},
                                                           {"FGIT", 16},
                                                           {"FVIT", 17},
                                                           {"FGCR", 19},
                                                           {"FGCT", 21},
                                                           {"FOPP", 22},
                                                           {"FWPP", 23},
                                                           {"FGIMR", 51},
                                                           {"FGIMT", 52},
                                                           {"FOPTS", 73},
                                                           {"FGPTS", 74},
                                                           {"FOPTH", 135},
                                                           {"FWPTH", 139},
                                                           {"FWITH", 140},
                                                           {"FGPTH", 143},
                                                           {"FGITH", 144},
    };

        const std::map<std::string, size_t> wellKeyToIndex = {
                                                           {"WOPR",  0},
                                                           {"WWPR",  1},
                                                           {"WGPR",  2},
                                                           {"WVPR",  3},
                                                           {"WWIR",  5},
                                                           {"WGIR",  6},
                                                           {"WWCT",  8},
                                                           {"WGOR",  9},
                                                           {"WOPT", 10},
                                                           {"WWPT", 11},
                                                           {"WGPT", 12},
                                                           {"WVPT", 13},
                                                           {"WWIT", 15},
                                                           {"WGIT", 16},
                                                           {"WVIT", 17},
                                                           //{"WGCR", 19},
                                                           {"WGCT", 21},
                                                           {"WOPP", 22},
                                                           {"WWPP", 23},
                                                           {"WGIMR", 51},
                                                           {"WGIMT", 52},
                                                           {"WOPTS", 73},
                                                           {"WGPTS", 74},
                                                           {"WOPGR", 85},
                                                           {"WWPGR", 86},
                                                           {"WGPGR", 87},
                                                           {"WVPGR", 88},
                                                           {"WOIGR", 89},
                                                           {"WWIGR", 91},
                                                           {"WGIGR", 93},
                                                           {"WOPTH", 135},
                                                           {"WWPTH", 139},
                                                           {"WWITH", 140},
                                                           {"WGPTH", 143},
                                                           {"WGITH", 144},
    };

private:
    WindowedArray<int> iGroup_;

    WindowedArray<float> sGroup_;

    WindowedArray<double> xGroup_;

    WindowedArray<EclIO::PaddedOutputString<8>> zGroup_;

    int nWGMax_;

    int nGMaxz_;
};

}}} // Opm::RestartIO::Helpers

#endif // OPM_AGGREGATE_WELL_DATA_HPP