Reference documentation for deal.II version 9.2.0
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Private Attributes | List of all members
Utilities::MPI::CollectiveMutex::ScopedLock Class Reference

#include <deal.II/base/mpi.h>

Public Member Functions

 ScopedLock (CollectiveMutex &mutex, const MPI_Comm &comm)
 
 ~ScopedLock ()
 

Private Attributes

CollectiveMutexmutex
 
const MPI_Comm comm
 

Detailed Description

This helper class provides a scoped lock for the CollectiveMutex.

See the class documentation of CollectiveMutex for details.

Definition at line 330 of file mpi.h.

Constructor & Destructor Documentation

◆ ScopedLock()

Utilities::MPI::CollectiveMutex::ScopedLock::ScopedLock ( CollectiveMutex mutex,
const MPI_Comm &  comm 
)
inlineexplicit

Constructor. Blocks until it can acquire the lock.

Definition at line 336 of file mpi.h.

◆ ~ScopedLock()

Utilities::MPI::CollectiveMutex::ScopedLock::~ScopedLock ( )
inline

Destructor. Releases the lock.

Definition at line 346 of file mpi.h.

Member Data Documentation

◆ mutex

CollectiveMutex& Utilities::MPI::CollectiveMutex::ScopedLock::mutex
private

A reference to the mutex.

Definition at line 355 of file mpi.h.

◆ comm

const MPI_Comm Utilities::MPI::CollectiveMutex::ScopedLock::comm
private

The communicator.

Definition at line 359 of file mpi.h.


The documentation for this class was generated from the following file: