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;
    class Schedule;
    template<class TypeTag> class BlackoilWellModel;
}
 
namespace Opm {
 
template<typename TypeTag>
class BlackoilWellModelRescoup {
    using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
    using Scalar      = GetPropType<TypeTag, Properties::Scalar>;
    using IndexTraits = typename FluidSystem::IndexTraitsType;
 
public:
    explicit BlackoilWellModelRescoup(BlackoilWellModel<TypeTag>& well_model);
 
    void receiveGroupConstraintsFromMaster();
 
    void receiveSlaveGroupData();
 
    void rescoupSyncSummaryData();
 
    void sendMasterGroupConstraintsToSlaves();
 
    void sendSlaveGroupDataToMaster();
 
    std::optional<ReservoirCoupling::ScopedLoggerGuard> setupScopedLogger(DeferredLogger& local_logger);
 
private:
    BlackoilWellModel<TypeTag>& well_model_;
};
 
} // namespace Opm
 
#include "BlackoilWellModelRescoup_impl.hpp"
 
#endif // RESERVOIR_COUPLING_ENABLED
#endif // OPM_BLACKOILWELLMODEL_RESCOUP_HEADER_INCLUDED