Skip to content

Commit

Permalink
Doc: Consume CommunicatorPipelineSharedWrapper in transform_mpi (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
rasolca committed Dec 3, 2024
1 parent 85d05e4 commit ec2c41d
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 71 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename F&gt;<br />
struct dlaf::comm::internal::MPICallHelper&lt; F &gt;</div><p>Helper type for wrapping MPI calls.</p>
<p>The wrapper explicitly releases any dla communicator objects when the pika::transform_mpi function returns (e.g. a message has been sent/posted) to prevent blocking access to many queued mpi operations. The mpi operations can complete asynchronously later, but the commmunicator is released/made available once the mpi task has been safely initiated</p>
<p>The wrapper explicitly releases any <a class="el" href="classdlaf_1_1comm_1_1_communicator_pipeline.html">CommunicatorPipeline</a>{Exclusive/Shared}Wrapper objects when the pika::transform_mpi function returns (e.g. a message has been sent/posted) to prevent blocking access to many queued mpi operations. The mpi operations can complete asynchronously later, but the <a class="el" href="classdlaf_1_1comm_1_1_communicator_pipeline.html">CommunicatorPipeline</a>{Exclusive/Shared}Wrapper is released/made available once the mpi task has been safely initiated.</p>
<p>This could in theory be a lambda inside transformMPI. However, clang at least until version 12 fails with an internal compiler error with a trailing decltype for SFINAE. GCC has no problems with a lambda. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>/home/runner/work/DLA-Future/DLA-Future/include/dlaf/sender/<a class="el" href="transform__mpi_8h_source.html">transform_mpi.h</a></li>
Expand Down
Loading

0 comments on commit ec2c41d

Please sign in to comment.