Events.hpp

/*
  Copyright 2015 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 SCHEDULE_EVENTS_HPP
#define SCHEDULE_EVENTS_HPP

#include <cstdint>
#include <string>
#include <unordered_map>

namespace Opm
{
    namespace ScheduleEvents {
        // These values are used as bitmask - 2^n structure is essential.
        enum Events : std::uint64_t {
            NEW_WELL = (UINT64_C(1) << 0),

            WELL_WELSPECS_UPDATE = (UINT64_C(1) << 1),

            // WELL_POLYMER_UPDATE = (UINT64_C(1) << 2),

            NEW_GROUP = (UINT64_C(1) << 3),

            PRODUCTION_UPDATE = (UINT64_C(1) << 4),
            INJECTION_UPDATE = (UINT64_C(1) << 5),
            //POLYMER_UPDATES = (UINT64_C(1) << 6),

            WELL_STATUS_CHANGE = (UINT64_C(1) << 7),

            COMPLETION_CHANGE = (UINT64_C(1) << 8),

            GROUP_CHANGE = (UINT64_C(1) << 9),

            GEO_MODIFIER = (UINT64_C(1) << 10),

            TUNING_CHANGE = (UINT64_C(1) << 11),

            VFPINJ_UPDATE = (UINT64_C(1) << 12),
            VFPPROD_UPDATE = (UINT64_C(1) << 13),

            GROUP_PRODUCTION_UPDATE = (UINT64_C(1) << 14),
            GROUP_INJECTION_UPDATE = (UINT64_C(1) << 15),

            WELL_PRODUCTIVITY_INDEX = (UINT64_C(1) << 16),

            WELLGROUP_EFFICIENCY_UPDATE = (UINT64_C(1) << 17),

            INJECTION_TYPE_CHANGED = (UINT64_C(1) << 18),

            WELL_SWITCHED_INJECTOR_PRODUCER = (UINT64_C(1) << 19),

            ACTIONX_WELL_EVENT = (UINT64_C(1) << 20),

            REQUEST_OPEN_WELL = (UINT64_C(1) << 21),

            REQUEST_SHUT_WELL = (UINT64_C(1) << 22),

            TUNINGDP_CHANGE = (UINT64_C(1) << 23),
        };
    } // namespace ScheduleEvents

    class Events
    {
    public:
        static Events serializationTestObject();

        void addEvent(ScheduleEvents::Events event);

        void clearEvent(std::uint64_t eventMask);

        void reset();

        void merge(const Events& events);

        bool hasEvent(std::uint64_t eventMask) const;

        bool operator==(const Events& data) const;

        template<class Serializer>
        void serializeOp(Serializer& serializer)
        {
            serializer(m_events);
        }

    private:
        std::uint64_t m_events = 0;
    };

    class WellGroupEvents
    {
    public:
        static WellGroupEvents serializationTestObject();

        void addWell(const std::string& wname);

        void addGroup(const std::string& gname);

        void addEvent(const std::string& wgname, ScheduleEvents::Events event);

        void clearEvent(const std::string& wgname, std::uint64_t eventMask);

        void reset();

        void merge(const WellGroupEvents& events);

        bool has(const std::string& wgname) const;

        bool hasEvent(const std::string& wgname, std::uint64_t eventMask) const;

        const Events& at(const std::string& wgname) const;

        bool operator==(const WellGroupEvents& data) const;

        template<class Serializer>
        void serializeOp(Serializer& serializer)
        {
            serializer(m_wellgroup_events);
        }

    private:
        std::unordered_map<std::string, Events> m_wellgroup_events{};
    };

} // namespace Opm

#endif // SCHEDULE_EVENTS_HPP