From 4437abe0b091b33b5f7c6c248f0bff26025557c2 Mon Sep 17 00:00:00 2001 From: Daniel Arndt Date: Mon, 1 May 2023 13:29:17 -0400 Subject: [PATCH] Document completion queries for execution spaces --- docs/source/API/core/execution_spaces.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/API/core/execution_spaces.rst b/docs/source/API/core/execution_spaces.rst index 22b76cdd1..0abd524dd 100644 --- a/docs/source/API/core/execution_spaces.rst +++ b/docs/source/API/core/execution_spaces.rst @@ -313,6 +313,8 @@ Functions * ``const char* name() const;``: *Returns* the label of the execution space instance. +* ``bool is_running() const;``: *Returns* whether the execution space has completed all kernels submitted to it or if any of the kernels submitted are still running. + * ``bool in_parallel() const;``: *Returns* a value convertible to ``bool`` indicating whether the caller is executing as part of a Kokkos parallel pattern. *Note:* as currently implemented, there is no guarantee that ``true`` means the caller is necessarily executing as part of a pattern on the particular instance |ExecutionSpaceConcept|_; just *some* instance of |ExecutionSpaceConcept|_. This may be strengthened in the future. * ``int concurrency() const;`` *Returns* the maximum amount of concurrently executing work items in a parallel setting, i.e. the maximum number of threads utilized by an execution space instance.