mpi_array.comms.create_block_distribution¶

mpi_array.comms.create_block_distribution(shape, locale_type=None, dims=None, halo=0, peer_comm=None, intra_locale_comm=None, inter_locale_comm=None, cart_comm=None)[source]¶

Factory function for creating mpi_array.distrbution.BlockPartition distribution and associated CartLocaleComms.

Parameters:	shape (sequence of `int`) – Shape of the globale array. locale_type (`str`) – One of `mpi_array.comms.DT_PROCESS` or `mpi_array.comms.DT_NODE`. Defines locales. dims (sequence of `int`) – Defines the partitioning of the globale array axes. peer_comm (`mpi4py.MPI.Comm`) – See `LocaleComms`. intra_locale_comm (`mpi4py.MPI.Comm`) – See `LocaleComms`. inter_locale_comm (`mpi4py.MPI.Comm`) – See `LocaleComms`. cart_comm (`mpi4py.MPI.Comm`) – See `CartLocaleComms`.
Return type:	`CommsAndDistribution`
Returns:	A `CommsAndDistribution` `collections.namedtuple`.