BlackoilWellModelRescoup.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_BLACKOILWELLMODEL_RESCOUP_HEADER_INCLUDED
#define OPM_BLACKOILWELLMODEL_RESCOUP_HEADER_INCLUDED
 
#include <opm/simulators/flow/rescoup/ReservoirCouplingEnabled.hpp>
 
#ifdef RESERVOIR_COUPLING_ENABLED
 
#include <opm/models/utils/basicproperties.hh>
 
#include <opm/simulators/flow/rescoup/ReservoirCoupling.hpp>
 
#include <optional>
 
namespace Opm {
    class DeferredLogger;
    enum class Phase;
    class Schedule;
    class SummaryState;
    template<class TypeTag> class BlackoilWellModel;
    template<class Scalar, class IndexTraits> class GroupStateHelper;
    template<class Scalar, class IndexTraits> class WellState;
    template<class Scalar> class ReservoirCouplingMaster;
    template<class Scalar> class ReservoirCouplingSlave;
}
 
namespace Opm::ReservoirCoupling { class CouplingInfo; }
 
namespace Opm {
 
template<typename TypeTag>
class BlackoilWellModelRescoup {
    using FluidSystem     = GetPropType<TypeTag, Properties::FluidSystem>;
    using Scalar          = GetPropType<TypeTag, Properties::Scalar>;
    using IndexTraits     = typename FluidSystem::IndexTraitsType;
    using Simulator       = GetPropType<TypeTag, Properties::Simulator>;
    using ModelParameters = BlackoilModelParameters<Scalar>;
    using WellInterfacePtr = typename BlackoilWellModel<TypeTag>::WellInterfacePtr;
 
public:
    explicit BlackoilWellModelRescoup(BlackoilWellModel<TypeTag>& well_model);
 
    // === Mode queries and rescoup-facade forwarders ===
 
    bool isReservoirCouplingMaster() const { return well_model_.isReservoirCouplingMaster(); }
    bool isReservoirCouplingSlave()  const { return well_model_.isReservoirCouplingSlave(); }
 
    ReservoirCouplingMaster<Scalar>& reservoirCouplingMaster()
    { return well_model_.reservoirCouplingMaster(); }
    const ReservoirCouplingMaster<Scalar>& reservoirCouplingMaster() const
    { return well_model_.reservoirCouplingMaster(); }
 
    ReservoirCouplingSlave<Scalar>& reservoirCouplingSlave()
    { return well_model_.reservoirCouplingSlave(); }
    const ReservoirCouplingSlave<Scalar>& reservoirCouplingSlave() const
    { return well_model_.reservoirCouplingSlave(); }
 
    // === Common-state accessor forwarders ===
 
    GroupStateHelper<Scalar, IndexTraits>& groupStateHelper()
    { return well_model_.groupStateHelper(); }
    const GroupStateHelper<Scalar, IndexTraits>& groupStateHelper() const
    { return well_model_.groupStateHelper(); }
 
    WellState<Scalar, IndexTraits>& wellState()
    { return well_model_.wellState(); }
    const WellState<Scalar, IndexTraits>& wellState() const
    { return well_model_.wellState(); }
 
    const Schedule& schedule() const { return well_model_.schedule(); }
 
    std::vector<WellInterfacePtr>& wellContainer()
    { return well_model_.wellContainer(); }
 
    // === Rescoup flow methods ===
 
    void evalGroupAndFieldUDQs();
 
    bool lastSentMasterGroupNodePressuresIsFinal() const
    { return last_sent_master_group_node_pressures_is_final_; }
 
    bool masterNetworkHasMasterGroupLeaves() const;
 
    bool masterIsInCoupledNetworkIteration() const;
 
    void receiveCoupledNetworkActiveStatus();
 
    void receiveGroupConstraintsFromMaster();
 
    void receiveMasterGroupNodePressuresFromMaster();
 
    void receiveSlaveGroupData();
 
    void receiveRefreshedGroupConstraintsFromMaster();
 
    void refreshAndSendGroupConstraints();
 
    void refreshSlaveGroupTargets();
 
    void rescoupSyncSummaryData();
 
    void sendCoupledNetworkActiveStatus();
 
    void sendMasterGroupConstraintsToSlaves();
 
    void sendMasterGroupNodePressuresToSlaves(bool is_final);
 
    void maybeExchangeNetworkSubIterationWithSlaves();
 
    void maybeExchangeNetworkOuterIterationWithSlaves(bool more_network_update);
 
    void sendSlaveGroupDataToMaster();
 
    std::optional<ReservoirCoupling::ScopedLoggerGuard> setupScopedLogger(DeferredLogger& local_logger);
 
    void storeSlaveGroupInjectionTargets();
 
    void storeSlaveGroupProductionTargets();
 
private:
    std::optional<Scalar>
    effectiveSlaveGroupInjectionTarget_(const std::string& gname,
                                        const Phase phase,
                                        const int reportStepIdx,
                                        const ReservoirCoupling::CouplingInfo& rescoup,
                                        const SummaryState& summary_state) const;
 
    std::optional<Scalar>
    effectiveSlaveGroupProductionTarget_(const std::string& gname,
                                         const Group::ProductionCMode cmode,
                                         const int reportStepIdx,
                                         const ReservoirCoupling::CouplingInfo& rescoup,
                                         const SummaryState& summary_state) const;
 
    bool masterNetworkHasMasterGroupLeavesForSlave_(std::size_t slave_idx) const;
 
    Scalar scheduleInjectionTarget_(const std::string& gname,
                                    const Phase phase,
                                    const int reportStepIdx,
                                    const SummaryState& summary_state) const;
 
    Scalar scheduleProductionTarget_(const std::string& gname,
                                     const Group::ProductionCMode cmode,
                                     const int reportStepIdx,
                                     const SummaryState& summary_state) const;
 
    bool slaveGroupIsFixedPressureNodeInOwnNetwork_(const std::string& group_name) const;
 
    bool wellIsBelowOverriddenNode_(const std::string& group_name,
                                    const std::map<std::string, Scalar>& overrides) const;
 
    BlackoilWellModel<TypeTag>& well_model_;
    BlackoilWellModelNetwork<TypeTag>& network_;
    Simulator& simulator_;
    const ModelParameters& param_;
 
    // See lastSentMasterGroupNodePressuresIsFinal().
    bool last_sent_master_group_node_pressures_is_final_{true};
};
 
} // namespace Opm
 
#include "BlackoilWellModelRescoup_impl.hpp"
 
#endif // RESERVOIR_COUPLING_ENABLED
#endif // OPM_BLACKOILWELLMODEL_RESCOUP_HEADER_INCLUDED