/*
  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/>.
*/

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

#include <algorithm>
#include <set>
#include <stdexcept>
#include <string>
#include <utility>
#include <vector>

namespace Opm {

    namespace {

        const std::set<std::string> reserved_keys {
            "LOGIHEAD", "INTEHEAD", "DOUBHEAD",
            "IWEL", "XWEL", "ZWEL",
            "ICON", "XCON",
        };

    }

    bool RestartKey::operator==(const RestartKey& key2) const
    {
        return key == key2.key &&
               dim == key2.dim &&
               required == key2.required;
    }

    RestartKey RestartKey::serializationTestObject()
    {
        return RestartKey{"test_key", UnitSystem::measure::effective_Kh, true};
    }

    RestartValue::RestartValue(data::Solution sol,
                               data::Wells wells_arg,
                               data::GroupAndNetworkValues grp_nwrk_arg,
                               data::Aquifers aquifer_arg)
        : solution { std::move(sol) }
        , wells    { std::move(wells_arg) }
        , grp_nwrk { std::move(grp_nwrk_arg) }
        , aquifer  { std::move(aquifer_arg) }
    {
    }

    const std::vector<double>& RestartValue::getExtra(const std::string& key) const {
        const auto iter = std::find_if(this->extra.begin(),
                                       this->extra.end(),
                                       [&](const std::pair<RestartKey, std::vector<double>>& pair)
                                       {
                                         return (pair.first.key == key);
                                       });
        if (iter == this->extra.end())
            throw std::invalid_argument("No such extra key " + key);

        return iter->second;
    }

    bool RestartValue::hasExtra(const std::string& key) const {
        const auto iter = std::find_if(this->extra.begin(),
                                       this->extra.end(),
                                       [&](const std::pair<RestartKey, std::vector<double>>& pair)
                                       {
                                         return (pair.first.key == key);
                                       });
        return  (iter != this->extra.end());
    }

    void RestartValue::addExtra(const std::string& key, UnitSystem::measure dimension, std::vector<double> data) {
        if (key.size() > 8)
            throw std::runtime_error("The keys used for Eclipse output must be maximum 8 characters long.");

        if (this->hasExtra(key))
            throw std::runtime_error("The keys in the extra vector must be unique.");

        if (this->solution.has(key))
            throw std::runtime_error("The key " + key + " is already present in the solution section.");

        if (reserved_keys.find(key) != reserved_keys.end())
            throw std::runtime_error("Can not use reserved key:" + key);

        this->extra.push_back( std::make_pair(RestartKey(key, dimension), std::move(data)));
    }

    void RestartValue::addExtra(const std::string& key, std::vector<double> data) {
        this->addExtra(key, UnitSystem::measure::identity, std::move(data));
    }

    void RestartValue::addExtra(const std::string& key, std::vector<float> data) {
        this->addExtra(key, UnitSystem::measure::identity,
                       std::vector<double>(data.begin(), data.end()));
    }

    void RestartValue::addExtra(const std::string& key, UnitSystem::measure dimension, std::vector<float> data) {
        this->addExtra(key, dimension,
                       std::vector<double>(data.begin(), data.end()));
    }

    void RestartValue::convertFromSI(const UnitSystem& units) {
        this->solution.convertFromSI(units);
        for (auto & extra_value : this->extra) {
            const auto& restart_key = extra_value.first;
            auto & data = extra_value.second;

            units.from_si(restart_key.dim, data);
        }
    }

    void RestartValue::convertToSI(const UnitSystem& units) {
        this->solution.convertToSI(units);
        for (auto & extra_value : this->extra) {
            const auto& restart_key = extra_value.first;
            auto & data = extra_value.second;

            units.to_si(restart_key.dim, data);
        }
    }

    bool RestartValue::operator==(const RestartValue& val2) const
    {
        return (this->solution == val2.solution)
            && (this->wells == val2.wells)
            && (this->grp_nwrk == val2.grp_nwrk)
            && (this->aquifer == val2.aquifer)
            && (this->extra == val2.extra);
    }

    RestartValue RestartValue::serializationTestObject()
    {
        auto res = RestartValue {
                       data::Solution::serializationTestObject(),
                       data::Wells::serializationTestObject(),
                       data::GroupAndNetworkValues::serializationTestObject(),
                       {{1, data::AquiferData::serializationTestObjectF()},
                        {2, data::AquiferData::serializationTestObjectC()},
                        {3, data::AquiferData::serializationTestObjectN()}}
                   };
        res.extra = {{RestartKey::serializationTestObject(), {1.0, 2.0}}};

        return res;
    }

}
