.TH "sc::DistShellPair" 3 "Sun Oct 4 2020" "Version 2.3.1" "MPQC" \" -*- nroff -*-
.ad l
.nh
.SH NAME
sc::DistShellPair \- Distributes shell pairs either statically or dynamically\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <distshpair\&.h>\fP
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBSharedData\fP"
.br
.RI "This is used to store data that must be shared between all cooperating shell pairs\&. "
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBDistShellPair\fP (const \fBRef\fP< \fBMessageGrp\fP > &, int nthread, int mythread, const \fBRef\fP< \fBThreadLock\fP > &lock, const \fBRef\fP< \fBGaussianBasisSet\fP > &bs1, const \fBRef\fP< \fBGaussianBasisSet\fP > &bs2, bool dynamic, \fBSharedData\fP *shared=0)"
.br
.RI "The \fBDistShellPair\fP class is used to distribute shell pair indices among tasks\&. "
.ti -1c
.RI "void \fBinit\fP ()"
.br
.RI "Resets to the first shell pair\&. "
.ti -1c
.RI "void \fBset_debug\fP (int d)"
.br
.RI "How much stuff to print out\&. "
.ti -1c
.RI "void \fBset_print_percent\fP (double p)"
.br
.RI "How often to print status from node 0\&. "
.ti -1c
.RI "int \fBget_task\fP (int &P, int &Q)"
.br
.RI "Puts the current PQ shell pair into P and Q and returns 1\&. "
.in -1c
.SH "Detailed Description"
.PP 
Distributes shell pairs either statically or dynamically\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "sc::DistShellPair::DistShellPair (const \fBRef\fP< \fBMessageGrp\fP > &, int nthread, int mythread, const \fBRef\fP< \fBThreadLock\fP > & lock, const \fBRef\fP< \fBGaussianBasisSet\fP > & bs1, const \fBRef\fP< \fBGaussianBasisSet\fP > & bs2, bool dynamic, \fBSharedData\fP * shared = \fC0\fP)"

.PP
The \fBDistShellPair\fP class is used to distribute shell pair indices among tasks\&. Both static (round-robin) and dynamic methods are supported\&. 
.SH "Member Function Documentation"
.PP 
.SS "int sc::DistShellPair::get_task (int & P, int & Q)"

.PP
Puts the current PQ shell pair into P and Q and returns 1\&. When there are no more shell pairs to be processed by this processor, 0 is returned\&. Once we start doing get_tasks, we have to go to the end if dynamic load balancing is used\&.
.PP
P belongs to bs1, and Q belongs to bs2\&. If (bs1 == bs2) then P is greater or equal to Q\&. 

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