From 67a6a424512748ed0957f892a7865f3906ab0df6 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Szil=C3=A1rd=20P=C3=A1ll?= Date: Wed, 18 Aug 2021 18:50:23 +0200 Subject: [PATCH] Clarify StepWorkload doxygen StepWorkload is rank-specific as it is also used on separate PME ranks. Refs #3913 --- src/gromacs/mdtypes/simulation_workload.h | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/gromacs/mdtypes/simulation_workload.h b/src/gromacs/mdtypes/simulation_workload.h index 256d8366b8..a00197dc18 100644 --- a/src/gromacs/mdtypes/simulation_workload.h +++ b/src/gromacs/mdtypes/simulation_workload.h @@ -47,18 +47,19 @@ namespace gmx { /*! \libinternal - * \brief Describes work done on this domain that may change per-step. + * \brief Describes work done on this domain by the current rank that may change per-step. * * This work description is based on the SimulationWorkload in the context of the * current particle interactions assigned to this domain as well as other * factors that may change during the lifetime of a domain. * + * Note that unlike the other workload descriptors, these flags are also used on + * dedicated PME ranks, hence the content is rank-specific (at least when it + * comes to flags related to PME). + * * Note that the contents of an object of this type is valid for * a single step and it is expected to be set at the beginning each step. * - * The initial set of flags map the legacy force flags to boolean flags; - * these have the role of directing per-step compute tasks undertaken by a PP rank. - * */ class StepWorkload { @@ -99,7 +100,7 @@ public: bool useGpuXHalo = false; //! Whether GPU forces halo exchange is active this step bool useGpuFHalo = false; - //! Whether GPU PME work is compute this step (can be false also on fast steps with MTS) + //! Whether GPU PME work is computed on the current rank this step (can be false on PP-only ranks or on fast steps with MTS) bool haveGpuPmeOnThisRank = false; //! Whether to combine the forces for multiple time stepping before the halo exchange bool combineMtsForcesBeforeHaloExchange = false; -- 2.22.0