MiniVector.hpp

Go to the documentation of this file.

/*
  Copyright 2025 Equinor 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_GPUISTL_MINIVECTOR_HPP
#define OPM_GPUISTL_MINIVECTOR_HPP
 
#include <algorithm>
#include <array>
#include <cstddef>
#include <initializer_list>
#include <stdexcept>
#include <type_traits>
 
#include <opm/common/ErrorMacros.hpp>
#include <opm/common/utility/gpuDecorators.hpp>
 
#if HAVE_DUNE_COMMON
#include <dune/common/fvector.hh>
#endif
 
namespace Opm::gpuistl
{
 
template <class T, int Dimension>
class MiniVector
{
    static_assert(Dimension > 0, "Dimension must be positive");
 
public:
    using value_type = T;
    using size_type = std::size_t;
    using reference = value_type&;
    using const_reference = const value_type&;
    using iterator = typename std::array<T, Dimension>::iterator;
    using const_iterator = typename std::array<T, Dimension>::const_iterator;
 
    OPM_HOST_DEVICE constexpr MiniVector() noexcept(std::is_nothrow_default_constructible<value_type>::value) = default;
 
    OPM_HOST_DEVICE constexpr explicit MiniVector(const value_type& value)
    {
        fill(value);
    }
 
    explicit MiniVector(const Dune::FieldVector<T, Dimension>& fv)
    {
        for (size_type i = 0; i < Dimension; ++i) {
            data_[i] = fv[i];
        }
    }
 
    OPM_HOST_DEVICE MiniVector(std::initializer_list<value_type> init)
    {
        if (init.size() != Dimension) {
            OPM_THROW(std::runtime_error, "Opm::MiniVector – initializer‑list size mismatch");
        }
        std::copy_n(init.begin(), Dimension, data_.begin());
    }
 
    OPM_HOST_DEVICE constexpr reference operator[](size_type idx) noexcept
    {
        return data_[idx];
    }
 
    OPM_HOST_DEVICE constexpr const_reference operator[](size_type idx) const noexcept
    {
        return data_[idx];
    }
 
    OPM_HOST_DEVICE reference at(size_type idx)
    {
        if (idx >= Dimension) {
            OPM_THROW(std::out_of_range, "Opm::MiniVector::at – index out of range");
        }
        return data_[idx];
    }
    OPM_HOST_DEVICE const_reference at(size_type idx) const
    {
        if (idx >= Dimension) {
            OPM_THROW(std::out_of_range, "Opm::MiniVector::at – index out of range");
        }
        return data_[idx];
    }
 
    OPM_HOST_DEVICE constexpr iterator begin() noexcept
    {
        return data_.begin();
    }
    OPM_HOST_DEVICE constexpr const_iterator begin() const noexcept
    {
        return data_.begin();
    }
    OPM_HOST_DEVICE constexpr const_iterator cbegin() const noexcept
    {
        return data_.cbegin();
    }
 
    OPM_HOST_DEVICE constexpr iterator end() noexcept
    {
        return data_.end();
    }
    OPM_HOST_DEVICE constexpr const_iterator end() const noexcept
    {
        return data_.end();
    }
    OPM_HOST_DEVICE constexpr const_iterator cend() const noexcept
    {
        return data_.cend();
    }
 
    OPM_HOST_DEVICE static constexpr size_type size() noexcept
    {
        return Dimension;
    }
 
 
    OPM_HOST_DEVICE constexpr void fill(const value_type& value)
    {
        for (auto& x : data_) {
            x = value;
        }
    }
 
    OPM_HOST_DEVICE bool operator==(const MiniVector& other) const noexcept
    {
        for (size_type i = 0; i < Dimension; ++i) {
            if (data_[i] != other.data_[i]) {
                return false;
            }
        }
        return true;
    }
 
    OPM_HOST_DEVICE bool operator!=(const MiniVector& other) const noexcept
    {
        return !(*this == other);
    }
 
    OPM_HOST_DEVICE MiniVector& operator=(const value_type& value)
    {
        fill(value);
        return *this;
    }
 
    OPM_HOST_DEVICE MiniVector operator+(const value_type& value) const
    {
        MiniVector result = *this;
        for (auto& x : result.data_) {
            x += value;
        }
        return result;
    }
 
    OPM_HOST_DEVICE MiniVector& operator+=(const MiniVector& other)
    {
        for (size_type i = 0; i < Dimension; ++i) {
            data_[i] += other.data_[i];
        }
        return *this;
    }
 
    OPM_HOST_DEVICE MiniVector operator+(const MiniVector& other) const
    {
        MiniVector result = *this;
        result += other;
        return result;
    }
 
    OPM_HOST_DEVICE MiniVector operator-(const MiniVector& other) const
    {
        MiniVector result = *this;
        for (size_type i = 0; i < Dimension; ++i) {
            result.data_[i] -= other.data_[i];
        }
        return result;
    }
 
    OPM_HOST_DEVICE MiniVector& operator-=(const MiniVector& other)
    {
        for (size_type i = 0; i < Dimension; ++i) {
            data_[i] -= other.data_[i];
        }
        return *this;
    }
 
    OPM_HOST_DEVICE MiniVector& operator*=(const value_type& value)
    {
        for (auto& x : data_) {
            x *= value;
        }
        return *this;
    }
 
private:
    std::array<value_type, Dimension> data_ {};
};
 
} // namespace Opm::gpuistl
 
#endif // OPM_GPUISTL_MINIVECTOR_HPP