FieldData.hpp

/*
  Copyright 2020 Equinor AS.

  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 FIELD_DATA_HPP
#define FIELD_DATA_HPP

#include <opm/input/eclipse/EclipseState/Grid/Box.hpp>
#include <opm/input/eclipse/EclipseState/Grid/Keywords.hpp>

#include <opm/input/eclipse/Deck/value_status.hpp>

#include <algorithm>
#include <array>
#include <cstddef>
#include <functional>
#include <optional>
#include <stdexcept>
#include <string>
#include <vector>

namespace Opm {
    class KeywordLocation;
} // namespace Opm

namespace Opm::Fieldprops {

    template <typename T>
    static void compress(std::vector<T>&          data,
                         const std::vector<bool>& active_map,
                         const std::size_t values_per_cell = 1)
    {
       const std::size_t num_cells = active_map.size();
       if (data.size() != num_cells * values_per_cell) {
           throw std::invalid_argument("Data size does not match the size of active_map times values_per_cell.");
       }

       std::size_t shift = 0;
       for (std::size_t value_index = 0; value_index < values_per_cell; ++value_index) {
           for (std::size_t g = 0; g < active_map.size(); ++g) {
               if (active_map[g] && shift > 0) {
                   const std::size_t orig_index = value_index * num_cells + g;
                   data[orig_index - shift] = data[orig_index];
                   continue;
               }
               if (!active_map[g]) {
                   shift += 1;
               }
           }
       }

        data.resize(data.size() - shift);
    }

    template <typename T>
    struct FieldData
    {
        std::vector<T> data{};
        std::vector<value::status> value_status{};
        keywords::keyword_info<T> kw_info{};
        std::optional<std::vector<T>> global_data{};
        std::optional<std::vector<value::status>> global_value_status{std::nullopt};
        mutable bool all_set{false};

        bool operator==(const FieldData& other) const
        {
            return this->data == other.data &&
                   this->value_status == other.value_status &&
                   this->kw_info == other.kw_info &&
                   this->global_data == other.global_data &&
                   this->global_value_status == other.global_value_status;
        }

        FieldData() = default;

        FieldData(const keywords::keyword_info<T>& info,
                  const std::size_t                active_size,
                  const std::size_t                global_size)
            : data        (active_size * info.num_value)
            , value_status(active_size * info.num_value, value::status::uninitialized)
            , kw_info     (info)
            , all_set     (false)
        {
            if (global_size != 0) {
                this->global_data.emplace(global_size * this->numValuePerCell());
                this->global_value_status.emplace(global_size * this->numValuePerCell(), value::status::uninitialized);
            }

            if (info.scalar_init) {
                this->default_assign(*info.scalar_init);
            }
        }

        std::size_t numCells() const
        {
            return this->data.size() / this->numValuePerCell();
        }

        std::size_t dataSize() const
        {
            return this->data.size();
        }

        std::size_t numValuePerCell() const
        {
            return this->kw_info.num_value;
        }

        bool valid() const
        {
            if (this->all_set) {
                return true;
            }

            // Object is "valid" if the 'value_status' of every element is
            // neither uninitialised nor empty.
            return this->all_set =
                std::ranges::none_of(this->value_status,
                                     [](const value::status& status)
                                     {
                                         return (status == value::status::uninitialized)
                                             || (status == value::status::empty_default);
                                     });
        }

        bool valid_default() const
        {
            return std::ranges::all_of(this->value_status,
                                       [](const value::status& status)
                                       { return status == value::status::valid_default; });
        }

        void compress(const std::vector<bool>& active_map)
        {
            Fieldprops::compress(this->data, active_map, this->numValuePerCell());
            Fieldprops::compress(this->value_status, active_map, this->numValuePerCell());
        }

        void checkInitialisedCopy(const FieldData&                    src,
                                  const std::vector<Box::cell_index>& index_list,
                                  const std::string&                  from,
                                  const std::string&                  to,
                                  const KeywordLocation&              loc,
                                  const bool                          global = false);

        void default_assign(T value)
        {
            std::ranges::fill(this->data, value);
            std::ranges::fill(this->value_status, value::status::valid_default);

            if (this->global_data) {
                std::ranges::fill(*this->global_data, value);

                std::ranges::fill(*this->global_value_status, value::status::valid_default);
            }
        }

        void default_assign(const std::vector<T>& src)
        {
            if (src.size() != this->dataSize()) {
                throw std::invalid_argument {
                    "Size mismatch got: " + std::to_string(src.size()) +
                    ", expected: " + std::to_string(this->dataSize())
                };
            }

            std::ranges::copy(src, this->data.begin());
            std::ranges::fill(this->value_status, value::status::valid_default);
        }

        void default_assign_global(const std::vector<T>& src)
        {
            if (!global_data) {
                throw std::invalid_argument {
                    "Cannot call default_assign_global on keyword with local storage"
                };
            }

            if (src.size() != this->global_data->size()) {
                throw std::invalid_argument {
                    "Size mismatch got: " + std::to_string(src.size()) +
                    ", expected: " + std::to_string(this->dataSize())
                };
            }

            std::ranges::copy(src, this->global_data->begin());
            std::ranges::fill(*this->global_value_status, value::status::valid_default);
        }

        void update_local_from_global(std::function<std::size_t(std::size_t)> local_to_global)
        {
            if (!global_data) {
                throw std::invalid_argument {
                    "Cannot call update_local_from_gloabl on keyword with local storage"
                };
            }
            std::size_t i{};
            auto current_status = this->value_status.begin();
            for(auto current = this->data.begin(); current != this->data.end(); ++current, ++current_status, ++i)
            {
                const auto& global = local_to_global(i);
                *current = (*global_data)[global];
                *current_status = (*global_value_status)[global];
            }
        }

        void default_update(const std::vector<T>& src)
        {
            if (src.size() != this->dataSize()) {
                throw std::invalid_argument {
                    "Size mismatch got: " + std::to_string(src.size()) +
                    ", expected: " + std::to_string(this->dataSize())
                };
            }

            for (std::size_t i = 0; i < src.size(); ++i) {
                if (!value::has_value(this->value_status[i])) {
                    this->value_status[i] = value::status::valid_default;
                    this->data[i] = src[i];
                }
            }
        }

        void update(const std::size_t index,
                    T value,
                    const value::status status)
        {
            this->data[index] = value;
            this->value_status[index] = status;
        }
    };

} // namespace Opm::Fieldprops

#endif // FIELD_DATA_HPP