Public Member Functions | |
def | __init__ |
def | Clone |
def | Barrier |
def | MyPID |
def | NumProc |
def | CreateDistributor |
def | CreateDirectory |
def | PrintInfo |
def | Broadcast |
def | GatherAll |
def | SumAll |
def | MaxAll |
def | MinAll |
def | ScanSum |
def | __init__ |
def | Clone |
def | Barrier |
def | MyPID |
def | NumProc |
def | CreateDistributor |
def | CreateDirectory |
def | PrintInfo |
def | Broadcast |
def | GatherAll |
def | SumAll |
def | MaxAll |
def | MinAll |
def | ScanSum |
Epetra_Comm: The Epetra Communication Abstract Base Class. The Epetra_Comm class is an interface that encapsulates the general information and services needed for other Epetra classes to run on a parallel computer. An Epetra_Comm object is required for building all Epetra Map objects, which in turn are required for all other Epetra classes. Epetra_Comm has default implementations, via Epetra_SerialComm and Epetra_MpiComm, for both serial execution and MPI distributed memory execution. It is meant to insulate the user from the specifics of communication that are not required for normal manipulation of linear algebra objects. Most Epetra_Comm interfaces are similar to MPI interfaces, except that the type of data is not required as an argument since C++ can bind to the appropriate interface based on argument typing. Any implementation of the Epetra_Comm interface is also responsible for generating an Epetra_Distributor and Epetra_Directory object. C++ includes: Epetra_Comm.h
def PyTrilinos::Epetra::Comm::Barrier | ( | self, | ||
args | ||||
) |
Barrier(self) virtual void Epetra_Comm::Barrier() const =0 Epetra_Comm Barrier function. Each processor must wait at the point the barrier is called until all processors have arrived.
Reimplemented in PyTrilinos::Epetra::SerialComm, PyTrilinos::Epetra::MpiComm, PyTrilinos::Epetra::SerialComm, and PyTrilinos::Epetra::MpiComm.
def PyTrilinos::Epetra::Comm::Barrier | ( | self, | ||
args | ||||
) |
Barrier(self) virtual void Epetra_Comm::Barrier() const =0 Epetra_Comm Barrier function. Each processor must wait at the point the barrier is called until all processors have arrived.
Reimplemented in PyTrilinos::Epetra::SerialComm, PyTrilinos::Epetra::MpiComm, PyTrilinos::Epetra::SerialComm, and PyTrilinos::Epetra::MpiComm.
def PyTrilinos::Epetra::Comm::Broadcast | ( | self, | ||
args | ||||
) |
Broadcast(self, numpy.ndarray myObj, int root) Argument myObj must be a numpy array, so that the Broadcast can be performed in-place. Its scalar data type must be int, long, double or string. In C++, this routine has an integer error return code. In python, a non-zero return code is converted to an exception. virtual int Epetra_Comm::Broadcast(char *MyVals, int Count, int Root) const =0 Epetra_Comm Broadcast function. Take list of input values from the root processor and sends to all other processors. Parameters: ----------- MyVals: InOut On entry, the root processor contains the list of values. On exit, all processors will have the same list of values. Note that values must be allocated on all processor before the broadcast. Count: In On entry, contains the length of the list of Values. Root: In On entry, contains the processor from which all processors will receive a copy of Values.
def PyTrilinos::Epetra::Comm::Broadcast | ( | self, | ||
args | ||||
) |
Broadcast(self, numpy.ndarray myObj, int root) Argument myObj must be a numpy array, so that the Broadcast can be performed in-place. Its scalar data type must be int, long, double or string. In C++, this routine has an integer error return code. In python, a non-zero return code is converted to an exception. virtual int Epetra_Comm::Broadcast(char *MyVals, int Count, int Root) const =0 Epetra_Comm Broadcast function. Take list of input values from the root processor and sends to all other processors. Parameters: ----------- MyVals: InOut On entry, the root processor contains the list of values. On exit, all processors will have the same list of values. Note that values must be allocated on all processor before the broadcast. Count: In On entry, contains the length of the list of Values. Root: In On entry, contains the processor from which all processors will receive a copy of Values.
def PyTrilinos::Epetra::Comm::Clone | ( | self, | ||
args | ||||
) |
Clone(self) -> Comm virtual Epetra_Comm* Epetra_Comm::Clone() const =0 Epetra_Comm clone constructor. The clone function will return a new heap-allocated Comm instance. It is the responsibility of the caller to ensure that this new instance is properly destroyed.
Reimplemented in PyTrilinos::Epetra::SerialComm, PyTrilinos::Epetra::MpiComm, PyTrilinos::Epetra::SerialComm, and PyTrilinos::Epetra::MpiComm.
def PyTrilinos::Epetra::Comm::Clone | ( | self, | ||
args | ||||
) |
Clone(self) -> Comm virtual Epetra_Comm* Epetra_Comm::Clone() const =0 Epetra_Comm clone constructor. The clone function will return a new heap-allocated Comm instance. It is the responsibility of the caller to ensure that this new instance is properly destroyed.
Reimplemented in PyTrilinos::Epetra::SerialComm, PyTrilinos::Epetra::MpiComm, PyTrilinos::Epetra::SerialComm, and PyTrilinos::Epetra::MpiComm.
def PyTrilinos::Epetra::Comm::CreateDirectory | ( | self, | ||
args | ||||
) |
CreateDirectory(self, BlockMap Map) -> Directory virtual Epetra_Directory* Epetra_Comm::CreateDirectory(const Epetra_BlockMap &Map) const =0 Create a directory object for the given Epetra_BlockMap.
Reimplemented in PyTrilinos::Epetra::SerialComm, PyTrilinos::Epetra::MpiComm, PyTrilinos::Epetra::SerialComm, and PyTrilinos::Epetra::MpiComm.
def PyTrilinos::Epetra::Comm::CreateDirectory | ( | self, | ||
args | ||||
) |
CreateDirectory(self, BlockMap Map) -> Directory virtual Epetra_Directory* Epetra_Comm::CreateDirectory(const Epetra_BlockMap &Map) const =0 Create a directory object for the given Epetra_BlockMap.
Reimplemented in PyTrilinos::Epetra::SerialComm, PyTrilinos::Epetra::MpiComm, PyTrilinos::Epetra::SerialComm, and PyTrilinos::Epetra::MpiComm.
def PyTrilinos::Epetra::Comm::CreateDistributor | ( | self, | ||
args | ||||
) |
CreateDistributor(self) -> Distributor virtual Epetra_Distributor* Epetra_Comm::CreateDistributor() const =0 Create a distributor object.
Reimplemented in PyTrilinos::Epetra::SerialComm, PyTrilinos::Epetra::MpiComm, PyTrilinos::Epetra::SerialComm, and PyTrilinos::Epetra::MpiComm.
def PyTrilinos::Epetra::Comm::CreateDistributor | ( | self, | ||
args | ||||
) |
CreateDistributor(self) -> Distributor virtual Epetra_Distributor* Epetra_Comm::CreateDistributor() const =0 Create a distributor object.
Reimplemented in PyTrilinos::Epetra::SerialComm, PyTrilinos::Epetra::MpiComm, PyTrilinos::Epetra::SerialComm, and PyTrilinos::Epetra::MpiComm.
def PyTrilinos::Epetra::Comm::GatherAll | ( | self, | ||
args | ||||
) |
GatherAll(self, PyObject myObj) -> PyObject Argument myObj can be a numpy array or any sequence that can be converted to a numpy array. Its scalar data type must be int, long or double. The return argument is a numpy array of the same type. In C++, this routine has an integer error return code. In python, a non-zero return code is converted to an exception.
def PyTrilinos::Epetra::Comm::GatherAll | ( | self, | ||
args | ||||
) |
GatherAll(self, PyObject myObj) -> PyObject Argument myObj can be a numpy array or any sequence that can be converted to a numpy array. Its scalar data type must be int, long or double. The return argument is a numpy array of the same type. In C++, this routine has an integer error return code. In python, a non-zero return code is converted to an exception.
def PyTrilinos::Epetra::Comm::MaxAll | ( | self, | ||
args | ||||
) |
MaxAll(self, PyObject partialObj) -> PyObject Argument myObj can be a numpy array or any sequence that can be converted to a numpy array. Its scalar data type must be int, long or double. The return argument is a numpy array of the same type. In C++, this routine has an integer error return code. In python, a non-zero return code is converted to an exception.
def PyTrilinos::Epetra::Comm::MaxAll | ( | self, | ||
args | ||||
) |
MaxAll(self, PyObject partialObj) -> PyObject Argument myObj can be a numpy array or any sequence that can be converted to a numpy array. Its scalar data type must be int, long or double. The return argument is a numpy array of the same type. In C++, this routine has an integer error return code. In python, a non-zero return code is converted to an exception.
def PyTrilinos::Epetra::Comm::MinAll | ( | self, | ||
args | ||||
) |
MinAll(self, PyObject partialObj) -> PyObject Argument myObj can be a numpy array or any sequence that can be converted to a numpy array. Its scalar data type must be int, long or double. The return argument is a numpy array of the same type. In C++, this routine has an integer error return code. In python, a non-zero return code is converted to an exception.
def PyTrilinos::Epetra::Comm::MinAll | ( | self, | ||
args | ||||
) |
MinAll(self, PyObject partialObj) -> PyObject Argument myObj can be a numpy array or any sequence that can be converted to a numpy array. Its scalar data type must be int, long or double. The return argument is a numpy array of the same type. In C++, this routine has an integer error return code. In python, a non-zero return code is converted to an exception.
def PyTrilinos::Epetra::Comm::MyPID | ( | self, | ||
args | ||||
) |
MyPID(self) -> int virtual int Epetra_Comm::MyPID() const =0 Return my process ID. In MPI mode returns the rank of the calling process. In serial mode returns 0.
Reimplemented in PyTrilinos::Epetra::SerialComm, PyTrilinos::Epetra::MpiComm, PyTrilinos::Epetra::SerialComm, and PyTrilinos::Epetra::MpiComm.
def PyTrilinos::Epetra::Comm::MyPID | ( | self, | ||
args | ||||
) |
MyPID(self) -> int virtual int Epetra_Comm::MyPID() const =0 Return my process ID. In MPI mode returns the rank of the calling process. In serial mode returns 0.
Reimplemented in PyTrilinos::Epetra::SerialComm, PyTrilinos::Epetra::MpiComm, PyTrilinos::Epetra::SerialComm, and PyTrilinos::Epetra::MpiComm.
def PyTrilinos::Epetra::Comm::NumProc | ( | self, | ||
args | ||||
) |
NumProc(self) -> int virtual int Epetra_Comm::NumProc() const =0 Returns total number of processes. In MPI mode returns the size of the MPI communicator. In serial mode returns 1.
Reimplemented in PyTrilinos::Epetra::SerialComm, PyTrilinos::Epetra::MpiComm, PyTrilinos::Epetra::SerialComm, and PyTrilinos::Epetra::MpiComm.
def PyTrilinos::Epetra::Comm::NumProc | ( | self, | ||
args | ||||
) |
NumProc(self) -> int virtual int Epetra_Comm::NumProc() const =0 Returns total number of processes. In MPI mode returns the size of the MPI communicator. In serial mode returns 1.
Reimplemented in PyTrilinos::Epetra::SerialComm, PyTrilinos::Epetra::MpiComm, PyTrilinos::Epetra::SerialComm, and PyTrilinos::Epetra::MpiComm.
def PyTrilinos::Epetra::Comm::PrintInfo | ( | self, | ||
args | ||||
) |
PrintInfo(self, ostream os) virtual void Epetra_Comm::PrintInfo(ostream &os) const =0 Print object to an output stream.
Reimplemented in PyTrilinos::Epetra::SerialComm, PyTrilinos::Epetra::MpiComm, PyTrilinos::Epetra::SerialComm, and PyTrilinos::Epetra::MpiComm.
def PyTrilinos::Epetra::Comm::PrintInfo | ( | self, | ||
args | ||||
) |
PrintInfo(self, ostream os) virtual void Epetra_Comm::PrintInfo(ostream &os) const =0 Print object to an output stream.
Reimplemented in PyTrilinos::Epetra::SerialComm, PyTrilinos::Epetra::MpiComm, PyTrilinos::Epetra::SerialComm, and PyTrilinos::Epetra::MpiComm.
def PyTrilinos::Epetra::Comm::ScanSum | ( | self, | ||
args | ||||
) |
ScanSum(self, PyObject partialObj) -> PyObject Argument myObj can be a numpy array or any sequence that can be converted to a numpy array. Its scalar data type must be int, long or double. The return argument is a numpy array of the same type. In C++, this routine has an integer error return code. In python, a non-zero return code is converted to an exception.
def PyTrilinos::Epetra::Comm::ScanSum | ( | self, | ||
args | ||||
) |
ScanSum(self, PyObject partialObj) -> PyObject Argument myObj can be a numpy array or any sequence that can be converted to a numpy array. Its scalar data type must be int, long or double. The return argument is a numpy array of the same type. In C++, this routine has an integer error return code. In python, a non-zero return code is converted to an exception.
def PyTrilinos::Epetra::Comm::SumAll | ( | self, | ||
args | ||||
) |
SumAll(self, PyObject partialObj) -> PyObject Argument myObj can be a numpy array or any sequence that can be converted to a numpy array. Its scalar data type must be int, long or double. The return argument is a numpy array of the same type. In C++, this routine has an integer error return code. In python, a non-zero return code is converted to an exception.
def PyTrilinos::Epetra::Comm::SumAll | ( | self, | ||
args | ||||
) |
SumAll(self, PyObject partialObj) -> PyObject Argument myObj can be a numpy array or any sequence that can be converted to a numpy array. Its scalar data type must be int, long or double. The return argument is a numpy array of the same type. In C++, this routine has an integer error return code. In python, a non-zero return code is converted to an exception.