mpi_array.comms.create_locale_comms¶

mpi_array.comms.create_locale_comms(locale_type=None, peer_comm=None, intra_locale_comm=None, inter_locale_comm=None)[source]¶

Factory function for creating a LocaleComms object.

Parameters:	locale_type (`str`) – One of `mpi_array.comms.DT_PROCESS` or `mpi_array.comms.DT_NODE`. peer_comm (`mpi4py.MPI.Comm`) – See `LocaleComms`. intra_locale_comm (`mpi4py.MPI.Comm`) – See `LocaleComms`. inter_locale_comm (`mpi4py.MPI.Comm`) – See `LocaleComms`.
Return type:	`LocaleComms`
Returns:	A `LocaleComms` object.