ReservoirCouplingSlaveReportStep.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_RESERVOIR_COUPLING_SLAVE_REPORT_STEP_HPP
#define OPM_RESERVOIR_COUPLING_SLAVE_REPORT_STEP_HPP
 
#include <opm/simulators/flow/rescoup/ReservoirCoupling.hpp>
 
namespace Opm {
 
// Avoid including the complete definition of ReservoirCouplingSlave here to avoid circular dependency.
template <class Scalar> class ReservoirCouplingSlave;
 
template <class Scalar>
class ReservoirCouplingSlaveReportStep {
public:
    using InjectionGroupTarget = ReservoirCoupling::InjectionGroupTarget<Scalar>;
    using ProductionGroupTarget = ReservoirCoupling::ProductionGroupTarget<Scalar>;
    using MessageTag = ReservoirCoupling::MessageTag;
    using SlaveGroupProductionData = ReservoirCoupling::SlaveGroupProductionData<Scalar>;
    using SlaveGroupInjectionData = ReservoirCoupling::SlaveGroupInjectionData<Scalar>;
 
    ReservoirCouplingSlaveReportStep(
        ReservoirCouplingSlave<Scalar> &slave
    );
 
    const Parallel::Communication &comm() const { return this->slave_.getComm(); }
 
    MPI_Comm getSlaveMasterComm() const { return this->slave_.getMasterComm(); }
 
    ReservoirCoupling::Logger& logger() const { return this->slave_.logger(); }
 
    void sendProductionDataToMaster(const std::vector<SlaveGroupProductionData> &production_data) const;
 
    void sendInjectionDataToMaster(const std::vector<SlaveGroupInjectionData> &injection_data) const;
 
    const std::string& slaveName() const { return this->slave_.getSlaveName(); }
    std::pair<std::size_t, std::size_t> receiveNumGroupTargetsFromMaster() const;
    void receiveInjectionGroupTargetsFromMaster(std::size_t num_targets) const;
    void receiveProductionGroupTargetsFromMaster(std::size_t num_targets) const;
 
private:
    template <class DataType>
    void sendDataToMaster_(
        const std::vector<DataType>& data,
        MessageTag tag,
        const std::string& data_type_name
    ) const;
 
    ReservoirCouplingSlave<Scalar> &slave_;
};
} // namespace Opm
#endif // OPM_RESERVOIR_COUPLING_SLAVE_REPORT_STEP_HPP