Package mpi4py :: Module MPI
[hide private]
[frames] | no frames]

Module MPI

Message Passing Interface.
Classes [hide private]
Cartcomm
Cartesian topology intracommunicator
Comm
Communicator
Datatype
Datatype
Errhandler
Error Handler
Exception
Exception
File
File
Graphcomm
Graph topology intracommunicator
Grequest
Generalized request
Group
Group
Info
Info
Intercomm
Intercommunicator
Intracomm
Intracommunicator
Op
Op
Prequest
Persistent request
Request
Request
Status
Status
Win
Window
_p_Pickler
_p_greq
_p_msg_cco
_p_msg_io
_p_msg_p2p
_p_msg_rma
Functions [hide private]
 
Alloc_mem(Aint size, Info info=INFO_NULL)
Allocate memory for message passing and RMA
 
Attach_buffer(memory)
Attach a user-provided buffer for sending in buffered mode
 
Close_port(port_name, Info info=INFO_NULL)
Close a port
 
Compute_dims(int nnodes, dims)
Return a balanced distribution of processes per coordinate direction
 
Detach_buffer()
Remove an existing attached buffer
 
Finalize()
Terminate the MPI execution environment
 
Free_mem(memory)
Free memory allocated with Alloc\_mem()
 
Get_address(location)
Get the address of a location in memory
 
Get_error_class(int errorcode)
Convert an error code into an error class
 
Get_error_string(int errorcode)
Return a string for a given error code
 
Get_processor_name()
Obtain the name of the calling processor
 
Get_version()
Obtain the version number of the MPI standard supported by the implementation as a tuple (version, subversion)
 
Init()
Initialize the MPI execution environment
 
Init_thread(int required=THREAD_MULTIPLE)
Initialize the MPI execution environment
 
Is_finalized()
Indicates whether Finalize has completed
 
Is_initialized()
Indicates whether Init has been called
 
Is_thread_main()
Indicate whether this thread called Init or Init_thread
 
Lookup_name(service_name, Info info=INFO_NULL)
Lookup a port name given a service name
 
Open_port(Info info=INFO_NULL)
Return an address that can be used to establish connections between groups of MPI processes
 
Pcontrol(int level)
Control profiling
 
Publish_name(service_name, Info info, port_name)
Publish a service name
 
Query_thread()
Return the level of thread support provided by the MPI library
 
Unpublish_name(service_name, Info info, port_name)
Unpublish a service name
 
Wtick()
Return the resolution of Wtime
 
Wtime()
Return an elapsed time on the calling processor
 
get_vendor()
Infomation about the underlying MPI implementation
Variables [hide private]
  ANY_SOURCE = -2
  ANY_TAG = -1
  APPNUM = 1681915917
  BAND = <mpi4py.MPI.Op object at 0xb8047b90>
  BOR = <mpi4py.MPI.Op object at 0xb8047638>
  BOTTOM = 0
  BSEND_OVERHEAD = 56
  BXOR = <mpi4py.MPI.Op object at 0xb8047bd8>
  BYTE = <mpi4py.MPI.Datatype object at 0xb8069160>
  CART = 2
  CHAR = <mpi4py.MPI.Datatype object at 0xb8069170>
  CHARACTER = <mpi4py.MPI.Datatype object at 0xb8069310>
  COMBINER_CONTIGUOUS = 3
  COMBINER_DARRAY = 14
  COMBINER_DUP = 2
  COMBINER_F90_COMPLEX = 16
  COMBINER_F90_INTEGER = 17
  COMBINER_F90_REAL = 15
  COMBINER_HINDEXED = 9
  COMBINER_HINDEXED_INTEGER = 8
  COMBINER_HVECTOR = 6
  COMBINER_HVECTOR_INTEGER = 5
  COMBINER_INDEXED = 7
  COMBINER_INDEXED_BLOCK = 10
  COMBINER_NAMED = 1
  COMBINER_RESIZED = 18
  COMBINER_STRUCT = 12
  COMBINER_STRUCT_INTEGER = 11
  COMBINER_SUBARRAY = 13
  COMBINER_VECTOR = 4
  COMM_NULL = <mpi4py.MPI.Comm object at 0xb80693b0>
  COMM_SELF = <mpi4py.MPI.Intracomm object at 0xb80693c0>
  COMM_WORLD = <mpi4py.MPI.Intracomm object at 0xb80693d0>
  COMPLEX = <mpi4py.MPI.Datatype object at 0xb8069270>
  CONGRUENT = 1
  DATATYPE_NULL = <mpi4py.MPI.Datatype object at 0xb8069120>
  DISPLACEMENT_CURRENT = -54278278
  DISP_CUR = -54278278
  DISTRIBUTE_BLOCK = 121
  DISTRIBUTE_CYCLIC = 122
  DISTRIBUTE_DFLT_DARG = -49767
  DISTRIBUTE_NONE = 123
  DOUBLE = <mpi4py.MPI.Datatype object at 0xb8069250>
  DOUBLE_COMPLEX = <mpi4py.MPI.Datatype object at 0xb8069280>
  DOUBLE_INT = <mpi4py.MPI.Datatype object at 0xb80692e0>
  DOUBLE_PRECISION = <mpi4py.MPI.Datatype object at 0xb8069340>
  ERRHANDLER_NULL = <mpi4py.MPI.Errhandler object at 0xb80690f0>
  ERRORS_ARE_FATAL = <mpi4py.MPI.Errhandler object at 0xb8069110>
  ERRORS_RETURN = <mpi4py.MPI.Errhandler object at 0xb8069100>
  ERR_ACCESS = 20
  ERR_AMODE = 21
  ERR_ARG = 12
  ERR_ASSERT = 53
  ERR_BAD_FILE = 22
  ERR_BASE = 46
  ERR_BUFFER = 1
  ERR_COMM = 5
  ERR_CONVERSION = 23
  ERR_COUNT = 2
  ERR_DIMS = 11
  ERR_DISP = 52
  ERR_DUP_DATAREP = 24
  ERR_FILE = 27
  ERR_FILE_EXISTS = 25
  ERR_FILE_IN_USE = 26
  ERR_GROUP = 8
  ERR_INFO = 28
  ERR_INFO_KEY = 29
  ERR_INFO_NOKEY = 31
  ERR_INFO_VALUE = 30
  ERR_INTERN = 16
  ERR_IN_STATUS = 17
  ERR_IO = 32
  ERR_KEYVAL = 48
  ERR_LASTCODE = 1073741823
  ERR_LOCKTYPE = 47
  ERR_NAME = 33
  ERR_NOT_SAME = 35
  ERR_NO_MEM = 34
  ERR_NO_SPACE = 36
  ERR_NO_SUCH_FILE = 37
  ERR_OP = 9
  ERR_OTHER = 15
  ERR_PENDING = 18
  ERR_PORT = 38
  ERR_QUOTA = 39
  ERR_RANK = 6
  ERR_READ_ONLY = 40
  ERR_REQUEST = 19
  ERR_RMA_CONFLICT = 49
  ERR_RMA_SYNC = 50
  ERR_ROOT = 7
  ERR_SERVICE = 41
  ERR_SIZE = 51
  ERR_SPAWN = 42
  ERR_TAG = 4
  ERR_TOPOLOGY = 10
  ERR_TRUNCATE = 14
  ERR_TYPE = 3
  ERR_UNKNOWN = 13
  ERR_UNSUPPORTED_DATAREP = 43
  ERR_UNSUPPORTED_OPERATION = 44
  ERR_WIN = 45
  FILE_NULL = <mpi4py.MPI.File object at 0xb8069400>
  FLOAT = <mpi4py.MPI.Datatype object at 0xb8069240>
  FLOAT_INT = <mpi4py.MPI.Datatype object at 0xb80692d0>
  F_COMPLEX = <mpi4py.MPI.Datatype object at 0xb8069350>
  F_DOUBLE_COMPLEX = <mpi4py.MPI.Datatype object at 0xb8069360>
  GRAPH = 1
  GROUP_EMPTY = <mpi4py.MPI.Group object at 0xb80693a0>
  GROUP_NULL = <mpi4py.MPI.Group object at 0xb8069390>
  HOST = 1681915907
  IDENT = 0
  INFO_NULL = <mpi4py.MPI.Info object at 0xb8069380>
  INT = <mpi4py.MPI.Datatype object at 0xb80691d0>
  INTEGER = <mpi4py.MPI.Datatype object at 0xb8069320>
  INT_INT = <mpi4py.MPI.Datatype object at 0xb80692b0>
  IN_PLACE = -1
  IO = 1681915909
  KEYVAL_INVALID = 603979776
  LAND = <mpi4py.MPI.Op object at 0xb8047b78>
  LASTUSEDCODE = 1681915915
  LB = <mpi4py.MPI.Datatype object at 0xb8069140>
  LOCK_EXCLUSIVE = 234
  LOCK_SHARED = 235
  LOGICAL = <mpi4py.MPI.Datatype object at 0xb8069300>
  LONG = <mpi4py.MPI.Datatype object at 0xb80691f0>
  LONG_DOUBLE = <mpi4py.MPI.Datatype object at 0xb8069260>
  LONG_DOUBLE_COMPLEX = <mpi4py.MPI.Datatype object at 0xb8069290>
  LONG_DOUBLE_INT = <mpi4py.MPI.Datatype object at 0xb80692f0>
  LONG_INT = <mpi4py.MPI.Datatype object at 0xb80692c0>
  LONG_LONG = <mpi4py.MPI.Datatype object at 0xb8069210>
  LONG_LONG_INT = <mpi4py.MPI.Datatype object at 0xb8069230>
  LOR = <mpi4py.MPI.Op object at 0xb8047bc0>
  LXOR = <mpi4py.MPI.Op object at 0xb8047a70>
  MAX = <mpi4py.MPI.Op object at 0xb8047aa0>
  MAXLOC = <mpi4py.MPI.Op object at 0xb8047bf0>
  MAX_DATAREP_STRING = 128
  MAX_ERROR_STRING = 1024
  MAX_INFO_KEY = 255
  MAX_INFO_VAL = 1024
  MAX_OBJECT_NAME = 128
  MAX_PORT_NAME = 256
  MAX_PROCESSOR_NAME = 128
  MIN = <mpi4py.MPI.Op object at 0xb8047ab8>
  MINLOC = <mpi4py.MPI.Op object at 0xb8047c38>
  MODE_APPEND = 128
  MODE_CREATE = 1
  MODE_DELETE_ON_CLOSE = 16
  MODE_EXCL = 64
  MODE_NOCHECK = 1024
  MODE_NOPRECEDE = 8192
  MODE_NOPUT = 4096
  MODE_NOSTORE = 2048
  MODE_NOSUCCEED = 16384
  MODE_RDONLY = 2
  MODE_RDWR = 8
  MODE_SEQUENTIAL = 256
  MODE_UNIQUE_OPEN = 32
  MODE_WRONLY = 4
  OP_NULL = <mpi4py.MPI.Op object at 0xb8047a40>
  ORDER_C = 56
  ORDER_F = 57
  ORDER_FORTRAN = 57
  PACKED = <mpi4py.MPI.Datatype object at 0xb8069150>
  PROC_NULL = -1
  PROD = <mpi4py.MPI.Op object at 0xb8047b60>
  REAL = <mpi4py.MPI.Datatype object at 0xb8069330>
  REPLACE = <mpi4py.MPI.Op object at 0xb8047b30>
  REQUEST_NULL = <mpi4py.MPI.Request object at 0xb8069370>
  ROOT = -3
  SEEK_CUR = 602
  SEEK_END = 604
  SEEK_SET = 600
  SHORT = <mpi4py.MPI.Datatype object at 0xb80691b0>
  SHORT_INT = <mpi4py.MPI.Datatype object at 0xb80692a0>
  SIGNED_CHAR = <mpi4py.MPI.Datatype object at 0xb8069190>
  SIMILAR = 2
  SUBVERSION = 1
  SUCCESS = 0
  SUM = <mpi4py.MPI.Op object at 0xb8047b48>
  TAG_UB = 1681915905
  THREAD_FUNNELED = 1
  THREAD_MULTIPLE = 3
  THREAD_SERIALIZED = 2
  THREAD_SINGLE = 0
  TWOINT = <mpi4py.MPI.Datatype object at 0xb80692b0>
  TYPECLASS_COMPLEX = 3
  TYPECLASS_INTEGER = 2
  TYPECLASS_REAL = 1
  UB = <mpi4py.MPI.Datatype object at 0xb8069130>
  UNDEFINED = -32766
  UNEQUAL = 3
  UNIVERSE_SIZE = 1681915913
  UNSIGNED = <mpi4py.MPI.Datatype object at 0xb80691e0>
  UNSIGNED_CHAR = <mpi4py.MPI.Datatype object at 0xb80691a0>
  UNSIGNED_INT = <mpi4py.MPI.Datatype object at 0xb80691e0>
  UNSIGNED_LONG = <mpi4py.MPI.Datatype object at 0xb8069200>
  UNSIGNED_LONG_LONG = <mpi4py.MPI.Datatype object at 0xb8069220>
  UNSIGNED_SHORT = <mpi4py.MPI.Datatype object at 0xb80691c0>
  VERSION = 2
  WCHAR = <mpi4py.MPI.Datatype object at 0xb8069180>
  WIN_BASE = 1711276033
  WIN_DISP_UNIT = 1711276037
  WIN_NULL = <mpi4py.MPI.Win object at 0xb80693f0>
  WIN_SIZE = 1711276035
  WTIME_IS_GLOBAL = 1681915911
  __package__ = 'mpi4py'
  __pyx_capi__ = {'PyMPIComm_Get': <PyCObject object at 0xb80478...
Function Details [hide private]

get_vendor()

 
Infomation about the underlying MPI implementation
Returns:
  • a string with the name of the MPI implementation
  • an integer 3-tuple version (major, minor, micro)

Variables Details [hide private]

__pyx_capi__

Value:
{'PyMPIComm_Get': <PyCObject object at 0xb80478c0>,
 'PyMPIComm_New': <PyCObject object at 0xb8047860>,
 'PyMPIDatatype_Get': <PyCObject object at 0xb8047740>,
 'PyMPIDatatype_New': <PyCObject object at 0xb80475a8>,
 'PyMPIErrhandler_Get': <PyCObject object at 0xb8047590>,
 'PyMPIErrhandler_New': <PyCObject object at 0xb8047950>,
 'PyMPIFile_Get': <PyCObject object at 0xb8047938>,
 'PyMPIFile_New': <PyCObject object at 0xb8047920>,
...