From bb59fa82d1fc44c84aefe40cd64112e587ee8a20 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A5kon=20H=C3=A6gland?= Date: Mon, 19 Jan 2026 11:36:14 +0100 Subject: [PATCH] Condensing and polishing comment wordings --- .../flow/rescoup/ReservoirCouplingMasterReportStep.hpp | 6 +++--- .../flow/rescoup/ReservoirCouplingSlaveReportStep.hpp | 6 +++--- opm/simulators/timestepping/AdaptiveTimeStepping_impl.hpp | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/opm/simulators/flow/rescoup/ReservoirCouplingMasterReportStep.hpp b/opm/simulators/flow/rescoup/ReservoirCouplingMasterReportStep.hpp index f69cc0ced0..4c2f6f23fe 100644 --- a/opm/simulators/flow/rescoup/ReservoirCouplingMasterReportStep.hpp +++ b/opm/simulators/flow/rescoup/ReservoirCouplingMasterReportStep.hpp @@ -135,7 +135,7 @@ public: /// @return Reference to the potentials data for the specified group const Potentials& getSlaveGroupPotentials(const std::string &master_group_name) const; - /// @brief Check if this is the first substep of within a "sync" timestep. + /// @brief Check if this is the first substep within a "sync" timestep. /// @details This flag is used to control reservoir coupling synchronization. /// Master-slave data exchange should only happen at the start of each "sync" timestep, /// not on internal substeps or at retries after convergence chops. @@ -190,7 +190,7 @@ public: std::size_t slave_idx, const std::vector& production_targets ) const; - /// @brief Set whether this is the first substep of within a "sync" timestep. + /// @brief Set whether this is the first substep within a "sync" timestep. /// @param value true at start of sync timestep, false after first runSubStep_() call void setFirstSubstepOfSyncTimestep(bool value) { is_first_substep_of_sync_timestep_ = value; } @@ -233,7 +233,7 @@ private: /// Injection data for each slave group (map key: master group name) std::map> slave_group_injection_data_; - /// Flag to track if this is the first substep of within a "sync" timestep. + /// Flag to track if this is the first substep within a "sync" timestep. /// Used to control reservoir coupling synchronization. bool is_first_substep_of_sync_timestep_{true}; }; diff --git a/opm/simulators/flow/rescoup/ReservoirCouplingSlaveReportStep.hpp b/opm/simulators/flow/rescoup/ReservoirCouplingSlaveReportStep.hpp index 7a7af35c08..d3195ee723 100644 --- a/opm/simulators/flow/rescoup/ReservoirCouplingSlaveReportStep.hpp +++ b/opm/simulators/flow/rescoup/ReservoirCouplingSlaveReportStep.hpp @@ -68,7 +68,7 @@ public: /// @return MPI communicator handle for communication with the master process MPI_Comm getSlaveMasterComm() const { return this->slave_.getMasterComm(); } - /// @brief Check if this is the first substep of within a "sync" timestep. + /// @brief Check if this is the first substep within a "sync" timestep. /// @details This flag is used to control reservoir coupling synchronization. /// Master-slave data exchange should only happen at the start of each "sync" timestep, /// not on internal substeps or at retries after convergence chops. @@ -103,7 +103,7 @@ public: /// @note Must be called before the master attempts to receive injection data void sendInjectionDataToMaster(const std::vector &injection_data) const; - /// @brief Set whether this is the first substep of within a "sync" timestep. + /// @brief Set whether this is the first substep within a "sync" timestep. /// @param value true at start of sync timestep, false after first runSubStep_() call void setFirstSubstepOfSyncTimestep(bool value) { is_first_substep_of_sync_timestep_ = value; } @@ -140,7 +140,7 @@ private: /// Reference to the parent ReservoirCouplingSlave object ReservoirCouplingSlave &slave_; - // Flag to track if this is the first substep of within a "sync" timestep. + // Flag to track if this is the first substep within a "sync" timestep. // Used to control reservoir coupling synchronization. bool is_first_substep_of_sync_timestep_{true}; }; diff --git a/opm/simulators/timestepping/AdaptiveTimeStepping_impl.hpp b/opm/simulators/timestepping/AdaptiveTimeStepping_impl.hpp index 0ab4ec6534..0d68649fd9 100644 --- a/opm/simulators/timestepping/AdaptiveTimeStepping_impl.hpp +++ b/opm/simulators/timestepping/AdaptiveTimeStepping_impl.hpp @@ -672,7 +672,7 @@ runStepReservoirCouplingMaster_() current_time + current_step_length, step_end_time ); // Mark this as the first substep of the "sync" timestep. This flag controls - // whether master-slave data exchange should occur in beginTimeStep() in the well model.. + // whether master-slave data exchange should occur in beginTimeStep() in the well model. // It will be cleared after the first runSubStep_() call. reservoirCouplingMaster_().setFirstSubstepOfSyncTimestep(true); SubStepIteration substepIteration{*this, substep_timer, current_step_length, final_step}; @@ -724,7 +724,7 @@ runStepReservoirCouplingSlave_() current_time + timestep, step_end_time ); // Mark this as the first substep of the "sync" timestep. This flag controls - // whether master-slave data exchange should occur in beginTimeStep() in the well model.. + // whether master-slave data exchange should occur in beginTimeStep() in the well model. // It will be cleared after the first runSubStep_() call. reservoirCouplingSlave_().setFirstSubstepOfSyncTimestep(true); SubStepIteration substepIteration{*this, substep_timer, timestep, final_step};