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
  Distgraphcomm
Distributed graph topology intracommunicator
  Errhandler
Error Handler
  Exception
Exception
  File
File
  Graphcomm
General graph topology intracommunicator
  Grequest
Generalized request
  Group
Group
  Info
Info
  Intercomm
Intercommunicator
  Intracomm
Intracommunicator
  Message
Message
  Op
Op
  Prequest
Persistent request
  Request
Request
  Status
Status
  Topocomm
Topology intracommunicator
  Win
Window
Functions [hide private]
 
Add_error_class()
Add an error class to the known error classes
 
Add_error_code(int errorclass)
Add an error code to an error class
 
Add_error_string(int errorcode, string)
Associate an error string with an error class or errorcode
 
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)
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 the error string for a given error class or error code
 
Get_library_version()
Obtain the version string of the MPI library
 
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_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, port_name, info=INFO_NULL)
Publish a service name
 
Query_thread()
Return the level of thread support provided by the MPI library
 
Register_datarep(datarep, read_fn, write_fn, extent_fn)
Register user-defined data representations
 
Unpublish_name(service_name, port_name, info=INFO_NULL)
Unpublish a service name
 
Wtick()
Return the resolution of Wtime
 
Wtime()
Return an elapsed time on the calling processor
 
_addressof(arg)
Memory address of the underlying MPI handle
 
_handleof(arg)
Unsigned integer value with the underlying MPI handle
 
_sizeof(arg)
Size in bytes of the underlying MPI handle
 
get_vendor()
Infomation about the underlying MPI implementation
Variables [hide private]
  AINT = <mpi4py.MPI.Datatype object at 0x7fa16152b1c8>
  ANY_SOURCE = -2
  ANY_TAG = -1
  APPNUM = 1681915917
  BAND = <mpi4py.MPI.Op object at 0x7fa1613f24e0>
  BOOL = <mpi4py.MPI.Datatype object at 0x7fa16152b378>
  BOR = <mpi4py.MPI.Op object at 0x7fa1613f2508>
  BOTTOM = 0
  BSEND_OVERHEAD = 96
  BXOR = <mpi4py.MPI.Op object at 0x7fa1613f23c8>
  BYTE = <mpi4py.MPI.Datatype object at 0x7fa16152b1b0>
  CART = 2
  CHAR = <mpi4py.MPI.Datatype object at 0x7fa16152b210>
  CHARACTER = <mpi4py.MPI.Datatype object at 0x7fa16152b5a0>
  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_BLOCK = 19
  COMBINER_HVECTOR = 6
  COMBINER_INDEXED = 7
  COMBINER_INDEXED_BLOCK = 10
  COMBINER_NAMED = 1
  COMBINER_RESIZED = 18
  COMBINER_STRUCT = 12
  COMBINER_SUBARRAY = 13
  COMBINER_VECTOR = 4
  COMM_NULL = <mpi4py.MPI.Comm object at 0x7fa16152b840>
  COMM_SELF = <mpi4py.MPI.Intracomm object at 0x7fa16152b858>
  COMM_TYPE_SHARED = 1
  COMM_WORLD = <mpi4py.MPI.Intracomm object at 0x7fa16152b870>
  COMPLEX = <mpi4py.MPI.Datatype object at 0x7fa16152b618>
  COMPLEX16 = <mpi4py.MPI.Datatype object at 0x7fa16152b7b0>
  COMPLEX32 = <mpi4py.MPI.Datatype object at 0x7fa16152b7c8>
  COMPLEX4 = <mpi4py.MPI.Datatype object at 0x7fa16152b780>
  COMPLEX8 = <mpi4py.MPI.Datatype object at 0x7fa16152b798>
  CONGRUENT = 1
  COUNT = <mpi4py.MPI.Datatype object at 0x7fa16152b1f8>
  CXX_BOOL = <mpi4py.MPI.Datatype object at 0x7fa16152b4b0>
  CXX_DOUBLE_COMPLEX = <mpi4py.MPI.Datatype object at 0x7fa16152...
  CXX_FLOAT_COMPLEX = <mpi4py.MPI.Datatype object at 0x7fa16152b...
  CXX_LONG_DOUBLE_COMPLEX = <mpi4py.MPI.Datatype object at 0x7fa...
  C_BOOL = <mpi4py.MPI.Datatype object at 0x7fa16152b378>
  C_COMPLEX = <mpi4py.MPI.Datatype object at 0x7fa16152b450>
  C_DOUBLE_COMPLEX = <mpi4py.MPI.Datatype object at 0x7fa16152b480>
  C_FLOAT_COMPLEX = <mpi4py.MPI.Datatype object at 0x7fa16152b468>
  C_LONG_DOUBLE_COMPLEX = <mpi4py.MPI.Datatype object at 0x7fa16...
  DATATYPE_NULL = <mpi4py.MPI.Datatype object at 0x7fa16152b150>
  DISPLACEMENT_CURRENT = -54278278
  DISP_CUR = -54278278
  DISTRIBUTE_BLOCK = 121
  DISTRIBUTE_CYCLIC = 122
  DISTRIBUTE_DFLT_DARG = -49767
  DISTRIBUTE_NONE = 123
  DIST_GRAPH = 3
  DOUBLE = <mpi4py.MPI.Datatype object at 0x7fa16152b348>
  DOUBLE_COMPLEX = <mpi4py.MPI.Datatype object at 0x7fa16152b630>
  DOUBLE_INT = <mpi4py.MPI.Datatype object at 0x7fa16152b570>
  DOUBLE_PRECISION = <mpi4py.MPI.Datatype object at 0x7fa16152b600>
  ERRHANDLER_NULL = <mpi4py.MPI.Errhandler object at 0x7fa16152b...
  ERRORS_ARE_FATAL = <mpi4py.MPI.Errhandler object at 0x7fa16152...
  ERRORS_RETURN = <mpi4py.MPI.Errhandler object at 0x7fa16152b120>
  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_ATTACH = 56
  ERR_RMA_CONFLICT = 49
  ERR_RMA_FLAVOR = 58
  ERR_RMA_RANGE = 55
  ERR_RMA_SHARED = 57
  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 0x7fa16152c0b0>
  FLOAT = <mpi4py.MPI.Datatype object at 0x7fa16152b330>
  FLOAT_INT = <mpi4py.MPI.Datatype object at 0x7fa16152b558>
  F_BOOL = <mpi4py.MPI.Datatype object at 0x7fa16152b5b8>
  F_COMPLEX = <mpi4py.MPI.Datatype object at 0x7fa16152b618>
  F_DOUBLE = <mpi4py.MPI.Datatype object at 0x7fa16152b600>
  F_DOUBLE_COMPLEX = <mpi4py.MPI.Datatype object at 0x7fa16152b630>
  F_FLOAT = <mpi4py.MPI.Datatype object at 0x7fa16152b5e8>
  F_FLOAT_COMPLEX = <mpi4py.MPI.Datatype object at 0x7fa16152b618>
  F_INT = <mpi4py.MPI.Datatype object at 0x7fa16152b5d0>
  GRAPH = 1
  GROUP_EMPTY = <mpi4py.MPI.Group object at 0x7fa16152b828>
  GROUP_NULL = <mpi4py.MPI.Group object at 0x7fa16152b810>
  HOST = 1681915907
  IDENT = 0
  INFO_ENV = <mpi4py.MPI.Info object at 0x7fa16152b7f8>
  INFO_NULL = <mpi4py.MPI.Info object at 0x7fa16152b7e0>
  INT = <mpi4py.MPI.Datatype object at 0x7fa16152b270>
  INT16_T = <mpi4py.MPI.Datatype object at 0x7fa16152b3a8>
  INT32_T = <mpi4py.MPI.Datatype object at 0x7fa16152b3c0>
  INT64_T = <mpi4py.MPI.Datatype object at 0x7fa16152b3d8>
  INT8_T = <mpi4py.MPI.Datatype object at 0x7fa16152b390>
  INTEGER = <mpi4py.MPI.Datatype object at 0x7fa16152b5d0>
  INTEGER1 = <mpi4py.MPI.Datatype object at 0x7fa16152b6a8>
  INTEGER16 = <mpi4py.MPI.Datatype object at 0x7fa16152b708>
  INTEGER2 = <mpi4py.MPI.Datatype object at 0x7fa16152b6c0>
  INTEGER4 = <mpi4py.MPI.Datatype object at 0x7fa16152b6d8>
  INTEGER8 = <mpi4py.MPI.Datatype object at 0x7fa16152b6f0>
  INT_INT = <mpi4py.MPI.Datatype object at 0x7fa16152b528>
  IN_PLACE = -1
  IO = 1681915909
  KEYVAL_INVALID = 603979776
  LAND = <mpi4py.MPI.Op object at 0x7fa1613f24b8>
  LASTUSEDCODE = 1681915915
  LB = <mpi4py.MPI.Datatype object at 0x7fa16152b180>
  LOCK_EXCLUSIVE = 234
  LOCK_SHARED = 235
  LOGICAL = <mpi4py.MPI.Datatype object at 0x7fa16152b5b8>
  LOGICAL1 = <mpi4py.MPI.Datatype object at 0x7fa16152b648>
  LOGICAL2 = <mpi4py.MPI.Datatype object at 0x7fa16152b660>
  LOGICAL4 = <mpi4py.MPI.Datatype object at 0x7fa16152b678>
  LOGICAL8 = <mpi4py.MPI.Datatype object at 0x7fa16152b690>
  LONG = <mpi4py.MPI.Datatype object at 0x7fa16152b288>
  LONG_DOUBLE = <mpi4py.MPI.Datatype object at 0x7fa16152b360>
  LONG_DOUBLE_INT = <mpi4py.MPI.Datatype object at 0x7fa16152b588>
  LONG_INT = <mpi4py.MPI.Datatype object at 0x7fa16152b540>
  LONG_LONG = <mpi4py.MPI.Datatype object at 0x7fa16152b2a0>
  LOR = <mpi4py.MPI.Op object at 0x7fa1613f2530>
  LXOR = <mpi4py.MPI.Op object at 0x7fa1613f2580>
  MAX = <mpi4py.MPI.Op object at 0x7fa1613f2418>
  MAXLOC = <mpi4py.MPI.Op object at 0x7fa1613f2558>
  MAX_DATAREP_STRING = 128
  MAX_ERROR_STRING = 512
  MAX_INFO_KEY = 255
  MAX_INFO_VAL = 1024
  MAX_LIBRARY_VERSION_STRING = 8192
  MAX_OBJECT_NAME = 128
  MAX_PORT_NAME = 256
  MAX_PROCESSOR_NAME = 128
  MESSAGE_NO_PROC = <mpi4py.MPI.Message object at 0x7fa1613fe190>
  MESSAGE_NULL = <mpi4py.MPI.Message object at 0x7fa1613fe150>
  MIN = <mpi4py.MPI.Op object at 0x7fa1613f2440>
  MINLOC = <mpi4py.MPI.Op object at 0x7fa1613f25a8>
  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
  NO_OP = <mpi4py.MPI.Op object at 0x7fa1613f25f8>
  OFFSET = <mpi4py.MPI.Datatype object at 0x7fa16152b1e0>
  OP_NULL = <mpi4py.MPI.Op object at 0x7fa1613f2378>
  ORDER_C = 56
  ORDER_F = 57
  ORDER_FORTRAN = 57
  PACKED = <mpi4py.MPI.Datatype object at 0x7fa16152b198>
  PROC_NULL = -1
  PROD = <mpi4py.MPI.Op object at 0x7fa1613f2490>
  REAL = <mpi4py.MPI.Datatype object at 0x7fa16152b5e8>
  REAL16 = <mpi4py.MPI.Datatype object at 0x7fa16152b768>
  REAL2 = <mpi4py.MPI.Datatype object at 0x7fa16152b720>
  REAL4 = <mpi4py.MPI.Datatype object at 0x7fa16152b738>
  REAL8 = <mpi4py.MPI.Datatype object at 0x7fa16152b750>
  REPLACE = <mpi4py.MPI.Op object at 0x7fa1613f25d0>
  REQUEST_NULL = <mpi4py.MPI.Request object at 0x7fa1613fe110>
  ROOT = -3
  SEEK_CUR = 602
  SEEK_END = 604
  SEEK_SET = 600
  SHORT = <mpi4py.MPI.Datatype object at 0x7fa16152b258>
  SHORT_INT = <mpi4py.MPI.Datatype object at 0x7fa16152b510>
  SIGNED_CHAR = <mpi4py.MPI.Datatype object at 0x7fa16152b240>
  SIGNED_INT = <mpi4py.MPI.Datatype object at 0x7fa16152b270>
  SIGNED_LONG = <mpi4py.MPI.Datatype object at 0x7fa16152b288>
  SIGNED_LONG_LONG = <mpi4py.MPI.Datatype object at 0x7fa16152b2a0>
  SIGNED_SHORT = <mpi4py.MPI.Datatype object at 0x7fa16152b258>
  SIMILAR = 2
  SINT16_T = <mpi4py.MPI.Datatype object at 0x7fa16152b3a8>
  SINT32_T = <mpi4py.MPI.Datatype object at 0x7fa16152b3c0>
  SINT64_T = <mpi4py.MPI.Datatype object at 0x7fa16152b3d8>
  SINT8_T = <mpi4py.MPI.Datatype object at 0x7fa16152b390>
  SUBVERSION = 0
  SUCCESS = 0
  SUM = <mpi4py.MPI.Op object at 0x7fa1613f2468>
  TAG_UB = 1681915905
  THREAD_FUNNELED = 1
  THREAD_MULTIPLE = 3
  THREAD_SERIALIZED = 2
  THREAD_SINGLE = 0
  TWOINT = <mpi4py.MPI.Datatype object at 0x7fa16152b528>
  TYPECLASS_COMPLEX = 3
  TYPECLASS_INTEGER = 2
  TYPECLASS_REAL = 1
  UB = <mpi4py.MPI.Datatype object at 0x7fa16152b168>
  UINT16_T = <mpi4py.MPI.Datatype object at 0x7fa16152b408>
  UINT32_T = <mpi4py.MPI.Datatype object at 0x7fa16152b420>
  UINT64_T = <mpi4py.MPI.Datatype object at 0x7fa16152b438>
  UINT8_T = <mpi4py.MPI.Datatype object at 0x7fa16152b3f0>
  UNDEFINED = -32766
  UNEQUAL = 3
  UNIVERSE_SIZE = 1681915913
  UNSIGNED = <mpi4py.MPI.Datatype object at 0x7fa16152b2e8>
  UNSIGNED_CHAR = <mpi4py.MPI.Datatype object at 0x7fa16152b2b8>
  UNSIGNED_INT = <mpi4py.MPI.Datatype object at 0x7fa16152b2e8>
  UNSIGNED_LONG = <mpi4py.MPI.Datatype object at 0x7fa16152b300>
  UNSIGNED_LONG_LONG = <mpi4py.MPI.Datatype object at 0x7fa16152...
  UNSIGNED_SHORT = <mpi4py.MPI.Datatype object at 0x7fa16152b2d0>
  UNWEIGHTED = 140330966648620
  VERSION = 3
  WCHAR = <mpi4py.MPI.Datatype object at 0x7fa16152b228>
  WEIGHTS_EMPTY = 140330966648616
  WIN_BASE = 1711276033
  WIN_CREATE_FLAVOR = 1711276039
  WIN_DISP_UNIT = 1711276037
  WIN_FLAVOR = 1711276039
  WIN_FLAVOR_ALLOCATE = 2
  WIN_FLAVOR_CREATE = 1
  WIN_FLAVOR_DYNAMIC = 3
  WIN_FLAVOR_SHARED = 4
  WIN_MODEL = 1711276041
  WIN_NULL = <mpi4py.MPI.Win object at 0x7fa1613fe1d0>
  WIN_SEPARATE = 1
  WIN_SIZE = 1711276035
  WIN_UNIFIED = 2
  WTIME_IS_GLOBAL = 1681915911
  __package__ = 'mpi4py'
  __pyx_capi__ = {'PyMPIComm_Get': <capsule object "MPI_Comm *(P...
  _typedict = {'?': <mpi4py.MPI.Datatype object at 0x7fa16152b37...
  _typedict_c = {'?': <mpi4py.MPI.Datatype object at 0x7fa16152b...
  _typedict_f = {'?': <mpi4py.MPI.Datatype object at 0x7fa16152b...
  pickle = <mpi4py.MPI.Pickle object at 0x7fa1613f5a50>
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]

CXX_DOUBLE_COMPLEX

Value:
<mpi4py.MPI.Datatype object at 0x7fa16152b4e0>

CXX_FLOAT_COMPLEX

Value:
<mpi4py.MPI.Datatype object at 0x7fa16152b4c8>

CXX_LONG_DOUBLE_COMPLEX

Value:
<mpi4py.MPI.Datatype object at 0x7fa16152b4f8>

C_LONG_DOUBLE_COMPLEX

Value:
<mpi4py.MPI.Datatype object at 0x7fa16152b498>

ERRHANDLER_NULL

Value:
<mpi4py.MPI.Errhandler object at 0x7fa16152b108>

ERRORS_ARE_FATAL

Value:
<mpi4py.MPI.Errhandler object at 0x7fa16152b138>

UNSIGNED_LONG_LONG

Value:
<mpi4py.MPI.Datatype object at 0x7fa16152b318>

__pyx_capi__

Value:
{'PyMPIComm_Get': <capsule object "MPI_Comm *(PyObject *)" at 0x7fa161\
3e80f0>,
 'PyMPIComm_New': <capsule object "PyObject *(MPI_Comm)" at 0x7fa1613e\
80c0>,
 'PyMPIDatatype_Get': <capsule object "MPI_Datatype *(PyObject *)" at \
0x7fa161465db0>,
 'PyMPIDatatype_New': <capsule object "PyObject *(MPI_Datatype)" at 0x\
7fa161465d80>,
...

_typedict

Value:
{'?': <mpi4py.MPI.Datatype object at 0x7fa16152b378>,
 'B': <mpi4py.MPI.Datatype object at 0x7fa16152b2b8>,
 'D': <mpi4py.MPI.Datatype object at 0x7fa16152b480>,
 'F': <mpi4py.MPI.Datatype object at 0x7fa16152b468>,
 'G': <mpi4py.MPI.Datatype object at 0x7fa16152b498>,
 'H': <mpi4py.MPI.Datatype object at 0x7fa16152b2d0>,
 'I': <mpi4py.MPI.Datatype object at 0x7fa16152b2e8>,
 'L': <mpi4py.MPI.Datatype object at 0x7fa16152b300>,
...

_typedict_c

Value:
{'?': <mpi4py.MPI.Datatype object at 0x7fa16152b378>,
 'B': <mpi4py.MPI.Datatype object at 0x7fa16152b2b8>,
 'D': <mpi4py.MPI.Datatype object at 0x7fa16152b480>,
 'F': <mpi4py.MPI.Datatype object at 0x7fa16152b468>,
 'G': <mpi4py.MPI.Datatype object at 0x7fa16152b498>,
 'H': <mpi4py.MPI.Datatype object at 0x7fa16152b2d0>,
 'I': <mpi4py.MPI.Datatype object at 0x7fa16152b2e8>,
 'L': <mpi4py.MPI.Datatype object at 0x7fa16152b300>,
...

_typedict_f

Value:
{'?': <mpi4py.MPI.Datatype object at 0x7fa16152b5b8>,
 'c': <mpi4py.MPI.Datatype object at 0x7fa16152b618>,
 'c16': <mpi4py.MPI.Datatype object at 0x7fa16152b7b0>,
 'c32': <mpi4py.MPI.Datatype object at 0x7fa16152b7c8>,
 'c8': <mpi4py.MPI.Datatype object at 0x7fa16152b798>,
 'd': <mpi4py.MPI.Datatype object at 0x7fa16152b600>,
 'i': <mpi4py.MPI.Datatype object at 0x7fa16152b5d0>,
 'i1': <mpi4py.MPI.Datatype object at 0x7fa16152b6a8>,
...