.TH "sc::MTMPIMemoryGrp" 3 "Sun Oct 4 2020" "Version 2.3.1" "MPQC" \" -*- nroff -*-
.ad l
.nh
.SH NAME
sc::MTMPIMemoryGrp \- This \fBMemoryGrp\fP class requires a MT-safe MPI implementation\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <memmtmpi\&.h>\fP
.PP
Inherits \fBsc::ActiveMsgMemoryGrp\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBMTMPIMemoryGrp\fP (const \fBRef\fP< \fBMessageGrp\fP > &msg, const \fBRef\fP< \fBThreadGrp\fP > &th, MPI_Comm comm=MPI_COMM_WORLD)"
.br
.RI "Construct a \fBMTMPIMemoryGrp\fP given a \fBMessageGrp\fP, \fBThreadGrp\fP, and an MPI communicator\&. "
.ti -1c
.RI "\fBMTMPIMemoryGrp\fP (const \fBRef\fP< \fBKeyVal\fP > &)"
.br
.RI "Construct a \fBMTMPIMemoryGrp\fP given a \fBKeyVal\fP input object\&. "
.ti -1c
.RI "void \fBactivate\fP ()"
.br
.RI "Activate is called before the memory is to be used\&. "
.ti -1c
.RI "void \fBdeactivate\fP ()"
.br
.RI "Deactivate is called after the memory has been used\&. "
.ti -1c
.RI "void \fBsync\fP ()"
.br
.RI "Synchronizes all the nodes\&. "
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBMTMPIThread\fP"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
This \fBMemoryGrp\fP class requires a MT-safe MPI implementation\&. 

The default \fBMessageGrp\fP must be a \fBMPIMessageGrp\fP\&. MPI must be safe with respect to the default \fBThreadGrp\fP\&. Alternately, a \fBMessageGrp\fP and a \fBThreadGrp\fP can be passed to the constructor\&. 
.br
 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "sc::MTMPIMemoryGrp::MTMPIMemoryGrp (const \fBRef\fP< \fBMessageGrp\fP > & msg, const \fBRef\fP< \fBThreadGrp\fP > & th, MPI_Comm comm = \fCMPI_COMM_WORLD\fP)"

.PP
Construct a \fBMTMPIMemoryGrp\fP given a \fBMessageGrp\fP, \fBThreadGrp\fP, and an MPI communicator\&. The communicator can be a subset of MPI_COMM_WORLD, in which case, the \fBMessageGrp\fP must refer to the same subset\&. 
.SS "sc::MTMPIMemoryGrp::MTMPIMemoryGrp (const \fBRef\fP< \fBKeyVal\fP > &)"

.PP
Construct a \fBMTMPIMemoryGrp\fP given a \fBKeyVal\fP input object\&. A fully thread safe MPI is needed (MPI_THREAD_MULTIPLE)\&. 
.SH "Member Function Documentation"
.PP 
.SS "void sc::MTMPIMemoryGrp::sync ()\fC [virtual]\fP"

.PP
Synchronizes all the nodes\&. This is useful after remote memory writes to be certain that all of the writes have completed and the data can be accessed locally, for example\&. 
.PP
Reimplemented from \fBsc::MsgMemoryGrp\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for MPQC from the source code\&.