GroupControlRetention.hpp

Go to the documentation of this file.

/*
  Copyright 2026 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_GROUP_CONTROL_RETENTION_HPP
#define OPM_GROUP_CONTROL_RETENTION_HPP
 
#include <opm/input/eclipse/Schedule/ResCoup/GrupSlav.hpp>
 
#include <optional>
 
namespace Opm::GroupStateHelpers {
 
inline bool keepsProductionControl(const bool field_or_none,
                                   const bool targeted,
                                   const bool gas_lift_group,
                                   const bool rc_master_hierarchy,
                                   const std::optional<ReservoirCoupling::GrupSlav::FilterFlag>
                                       master_target_filter)
{
    using FilterFlag = ReservoirCoupling::GrupSlav::FilterFlag;
    const bool master_sets_control_mode =
        master_target_filter.has_value() && *master_target_filter != FilterFlag::SLAV;
    return targeted
        || field_or_none
        || gas_lift_group
        || rc_master_hierarchy
        || master_sets_control_mode;
}
 
} // namespace Opm::GroupStateHelpers
 
#endif // OPM_GROUP_CONTROL_RETENTION_HPP