Condensing and polishing comment wordings

This commit is contained in:
Håkon Hægland committed 2026-01-19 11:36:14 +01:00
1 parent fe6b508b28
commit bb59fa82d1
3 files changed
+8 -8

No files matched your search

@@ -135,7 +135,7 @@ public:
/// @return Reference to the potentials data for the specified group /// @return Reference to the potentials data for the specified group
const Potentials& getSlaveGroupPotentials(const std::string &master_group_name) const; 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. /// @details This flag is used to control reservoir coupling synchronization.
/// Master-slave data exchange should only happen at the start of each "sync" timestep, /// Master-slave data exchange should only happen at the start of each "sync" timestep,
/// not on internal substeps or at retries after convergence chops. /// not on internal substeps or at retries after convergence chops.
@@ -190,7 +190,7 @@ public:
std::size_t slave_idx, const std::vector<ProductionGroupTarget>& production_targets std::size_t slave_idx, const std::vector<ProductionGroupTarget>& production_targets
) const; ) 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 /// @param value true at start of sync timestep, false after first runSubStep_() call
void setFirstSubstepOfSyncTimestep(bool value) { is_first_substep_of_sync_timestep_ = value; } 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) /// Injection data for each slave group (map key: master group name)
std::map<std::string, std::vector<SlaveGroupInjectionData>> slave_group_injection_data_; std::map<std::string, std::vector<SlaveGroupInjectionData>> 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. /// Used to control reservoir coupling synchronization.
bool is_first_substep_of_sync_timestep_{true}; bool is_first_substep_of_sync_timestep_{true};
}; };
@@ -68,7 +68,7 @@ public:
/// @return MPI communicator handle for communication with the master process /// @return MPI communicator handle for communication with the master process
MPI_Comm getSlaveMasterComm() const { return this->slave_.getMasterComm(); } 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. /// @details This flag is used to control reservoir coupling synchronization.
/// Master-slave data exchange should only happen at the start of each "sync" timestep, /// Master-slave data exchange should only happen at the start of each "sync" timestep,
/// not on internal substeps or at retries after convergence chops. /// 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 /// @note Must be called before the master attempts to receive injection data
void sendInjectionDataToMaster(const std::vector<SlaveGroupInjectionData> &injection_data) const; void sendInjectionDataToMaster(const std::vector<SlaveGroupInjectionData> &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 /// @param value true at start of sync timestep, false after first runSubStep_() call
void setFirstSubstepOfSyncTimestep(bool value) { is_first_substep_of_sync_timestep_ = value; } void setFirstSubstepOfSyncTimestep(bool value) { is_first_substep_of_sync_timestep_ = value; }
@@ -140,7 +140,7 @@ private:
/// Reference to the parent ReservoirCouplingSlave object /// Reference to the parent ReservoirCouplingSlave object
ReservoirCouplingSlave<Scalar> &slave_; ReservoirCouplingSlave<Scalar> &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. // Used to control reservoir coupling synchronization.
bool is_first_substep_of_sync_timestep_{true}; bool is_first_substep_of_sync_timestep_{true};
}; };
@@ -672,7 +672,7 @@ runStepReservoirCouplingMaster_()
current_time + current_step_length, step_end_time current_time + current_step_length, step_end_time
); );
// Mark this as the first substep of the "sync" timestep. This flag controls // 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. // It will be cleared after the first runSubStep_() call.
reservoirCouplingMaster_().setFirstSubstepOfSyncTimestep(true); reservoirCouplingMaster_().setFirstSubstepOfSyncTimestep(true);
SubStepIteration<Solver> substepIteration{*this, substep_timer, current_step_length, final_step}; SubStepIteration<Solver> substepIteration{*this, substep_timer, current_step_length, final_step};
@@ -724,7 +724,7 @@ runStepReservoirCouplingSlave_()
current_time + timestep, step_end_time current_time + timestep, step_end_time
); );
// Mark this as the first substep of the "sync" timestep. This flag controls // 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. // It will be cleared after the first runSubStep_() call.
reservoirCouplingSlave_().setFirstSubstepOfSyncTimestep(true); reservoirCouplingSlave_().setFirstSubstepOfSyncTimestep(true);
SubStepIteration<Solver> substepIteration{*this, substep_timer, timestep, final_step}; SubStepIteration<Solver> substepIteration{*this, substep_timer, timestep, final_step};