mpi_array.comms.create_distribution

mpi_array.comms.create_distribution(shape, distrib_type=None, locale_type='node', **kwargs)

Factory function for creating mpi_array.distribution.Distribution and associated LocaleComms.

Parameters:

• shape (sequence of int) – Shape of the globale array.
• distrib_type (str) – One of mpi_array.comms.DT_BLOCK or mpi_array.comms.DT_SLAB or mpi_array.comms.DT_CLONED or mpi_array.comms.DT_SINGLE_LOCALE. Defines how the globale array is dstributed over locales. If None defaults to mpi_array.comms.DT_BLOCK if numpy.product(shape) > 0 otherwise mpi_array.comms.DT_CLONED.
• locale_type (str) – One of mpi_array.comms.DT_PROCESS or mpi_array.comms.DT_NODE. Defines locales.
• dims (sequence of int) – Only relevant when distrib_type == DT_BLOCK. Defines the partitioning of the globale array axes.
• axis (int) – Only relevant when distrib_type == DT_SLAB. Indicates the single axis of the globale array partitioned into slabs.
• 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) – Only relevant when distrib_type == DT_BLOCK or distrib_type == DT_SLAB. See CartLocaleComms.

Return type:

CommsAndDistribution

Returns:

A CommsAndDistribution collections.namedtuple.

See also:

create_block_distribution() create_cloned_distribution() create_single_locale_distribution()