PAvgCalculatorCollection.hpp

/*
  Copyright 2020, 2023 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 PAVE_CALC_COLLECTIONHPP
#define PAVE_CALC_COLLECTIONHPP

#include <cstddef>
#include <functional>
#include <memory>
#include <unordered_map>
#include <vector>

namespace Opm {
    template<class Scalar> class PAvgCalculator;
} // namespace Opm

namespace Opm {

template<class Scalar>
class PAvgCalculatorCollection
{
public:
    using CalculatorPtr = std::unique_ptr<PAvgCalculator<Scalar>>;

    using ActivePredicate = std::function<
        std::vector<bool>(const std::vector<std::size_t>&)>;

    PAvgCalculatorCollection() = default;

    ~PAvgCalculatorCollection() = default;

    PAvgCalculatorCollection(const PAvgCalculatorCollection&) = delete;

    PAvgCalculatorCollection(PAvgCalculatorCollection&&) = default;

    PAvgCalculatorCollection& operator=(const PAvgCalculatorCollection&) = delete;

    PAvgCalculatorCollection& operator=(PAvgCalculatorCollection&&) = default;

    std::size_t setCalculator(const std::size_t wellID, CalculatorPtr calculator);

    void pruneInactiveWBPCells(ActivePredicate isActive);

    PAvgCalculator<Scalar>& operator[](const std::size_t i);

    const PAvgCalculator<Scalar>& operator[](const std::size_t i) const;

    bool empty() const;

    std::size_t numCalculators() const;

    std::vector<std::size_t> allWBPCells() const;

private:
    using CalcIndex = typename std::vector<CalculatorPtr>::size_type;

    std::unordered_map<std::size_t, CalcIndex> index_{};

    std::vector<CalculatorPtr> calculators_{};
};

} // namespace Opm

#endif // PAVE_CALC_COLLECTIONHPP