The `mpi_array.comms` Module¶

MPI communicators and windows for locales.

Classes¶

`LocaleCommsInfo`	Communicators associated with a locale.
`LocaleComms`([peer_comm, intra_locale_comm, ...])	MPI communicators for inter and intra locale data exchange.
`CartLocaleCommsInfo`	Communicators associated with a cartesian topology locales.
`CartLocaleComms`([ndims, dims, peer_comm, ...])	Defines cartesian communication topology for locales.
`CommsAndDistribution`	A 3 element tuple `(locale_comms, distribution, this_locale)` describing the apportionment of array elements over MPI processes.
`ThisLocaleInfo`	Pair of communicator rank values `(inter_locale_rank, peer_rank)` which indicates that the rank `inter_locale_rank` of the `inter_locale_comm` communicator corresponds to the `peer_rank` rank of the `peer_comm` communicator.
`RmaWindowBuffer`(is_shared, shape, dtype, ...)	Details of the buffer allocated on a locale.

`create_locale_comms_info`([peer_comm, ...])	Creates a `LocaleCommsInfo` associated with the specified communicators.
`get_locale_comms_info`([peer_comm, ...])	Finds or creates a `LocaleCommsInfo` associated with the specified communicators.
`create_cart_locale_comms_info`([ndims, dims, ...])	Creates a `CartLocaleCommsInfo` associated with the specified communicators.
`get_cart_locale_comms_info`([ndims, dims, ...])	Finds or creates a `CartLocaleCommsInfo` associated with the specified communicators.
`create_locale_comms`([locale_type, ...])	Factory function for creating a `LocaleComms` object.
`create_block_distribution`(shape[, ...])	Factory function for creating `mpi_array.distrbution.BlockPartition` distribution and associated `CartLocaleComms`.
`create_cloned_distribution`(shape[, ...])	Factory function for creating `mpi_array.distrbution.ClonedDistribution` distribution and associated `LocaleComms`.
`create_single_locale_distribution`(shape[, ...])	Factory function for creating `mpi_array.distrbution.SingleLocaleDistribution` distribution and associated `LocaleComms`.
`create_distribution`(shape[, distrib_type, ...])	Factory function for creating `mpi_array.distribution.Distribution` and associated `LocaleComms`.

`LT_PROCESS`	Single process locale type
`LT_NODE`	Node (NUMA) locale type
`DT_BLOCK`	Hyper-block partition distribution type
`DT_SLAB`	Hyper-slab partition distribution type
`DT_CLONED`	Entire array repeated on each locale.
`DT_SINGLE_LOCALE`	Entire array on single locale, no array elements on other locales.