Skip to content

Commit

Permalink
#672: docs: reference context component properly
Browse files Browse the repository at this point in the history
  • Loading branch information
lifflander committed Jun 16, 2020
1 parent 2887c0f commit 46a4e84
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions src/context.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
\page context Context
\brief Node-aware context

The context component, accessed via `vt::theContext()`, provides context-aware
querying of the current node (analogous to MPI's \c MPI_Comm_rank), number of
nodes (analogous to MPI's \c MPI_Comm_size), and kernel threading/ULT
information if worker threads are enabled. The context also provides the MPI
communicator that an instance of \vt is currently using.
The context component `vt::ctx::Context`, accessed via `vt::theContext()`,
provides context-aware querying of the current node (analogous to MPI's \c
MPI_Comm_rank), number of nodes (analogous to MPI's \c MPI_Comm_size), and
kernel threading/ULT information if worker threads are enabled. The context also
provides the MPI communicator that an instance of \vt is currently using.

\copybrief vt::ctx::Context
\copydetails vt::ctx::Context
Expand All @@ -33,4 +33,4 @@ vt::NodeType num_nodes = vt::theContext()->getNumNodes();
\endcode

\note The result from \c getNode or \c getNumNodes will depend on the
communicator that was passed to VT during initialization.
communicator that was passed to VT during initialization.

0 comments on commit 46a4e84

Please sign in to comment.