mpi4py.MPI.Topocomm — MPI for Python 3.1.4 documentation

# mpi4py.MPI.Topocomm

class mpi4py.MPI.Topocomm(comm=None)

  Bases: `Intracomm`

  Topology intracommunicator

  Parameters:

    comm (Optional[Topocomm]) –

  Return type:

    Topocomm

  static __new__(cls, comm=None)
    Parameters:

      comm (Optional[Topocomm]) –

    Return type:

      Topocomm

  Methods Summary

  `Ineighbor_allgather`(sendbuf, recvbuf) | Nonblocking Neighbor Gather to All
  `Ineighbor_allgatherv`(sendbuf, recvbuf) | Nonblocking Neighbor Gather to All Vector
  `Ineighbor_alltoall`(sendbuf, recvbuf) | Nonblocking Neighbor All-to-All
  `Ineighbor_alltoallv`(sendbuf, recvbuf) | Nonblocking Neighbor All-to-All Vector
  `Ineighbor_alltoallw`(sendbuf, recvbuf) | Nonblocking Neighbor All-to-All Generalized
  `Neighbor_allgather`(sendbuf, recvbuf) | Neighbor Gather to All
  `Neighbor_allgatherv`(sendbuf, recvbuf) | Neighbor Gather to All Vector
  `Neighbor_alltoall`(sendbuf, recvbuf) | Neighbor All-to-All
  `Neighbor_alltoallv`(sendbuf, recvbuf) | Neighbor All-to-All Vector
  `Neighbor_alltoallw`(sendbuf, recvbuf) | Neighbor All-to-All Generalized
  `neighbor_allgather`(sendobj) | Neighbor Gather to All
  `neighbor_alltoall`(sendobj) | Neighbor All to All Scatter/Gather

  Attributes Summary

  `degrees` | number of incoming and outgoing neighbors
  `indegree` | number of incoming neighbors
  `inedges` | incoming neighbors
  `inoutedges` | incoming and outgoing neighbors
  `outdegree` | number of outgoing neighbors
  `outedges` | outgoing neighbors

  Methods Documentation

  Ineighbor_allgather(sendbuf, recvbuf)

    Nonblocking Neighbor Gather to All

    Parameters:

      - sendbuf (BufSpec) –

      - recvbuf (BufSpecB) –

    Return type:

      Request

  Ineighbor_allgatherv(sendbuf, recvbuf)

    Nonblocking Neighbor Gather to All Vector

    Parameters:

      - sendbuf (BufSpec) –

      - recvbuf (BufSpecV) –

    Return type:

      Request

  Ineighbor_alltoall(sendbuf, recvbuf)

    Nonblocking Neighbor All-to-All

    Parameters:

      - sendbuf (BufSpecB) –

      - recvbuf (BufSpecB) –

    Return type:

      Request

  Ineighbor_alltoallv(sendbuf, recvbuf)

    Nonblocking Neighbor All-to-All Vector

    Parameters:

      - sendbuf (BufSpecV) –

      - recvbuf (BufSpecV) –

    Return type:

      Request

  Ineighbor_alltoallw(sendbuf, recvbuf)

    Nonblocking Neighbor All-to-All Generalized

    Parameters:

      - sendbuf (BufSpecW) –

      - recvbuf (BufSpecW) –

    Return type:

      Request

  Neighbor_allgather(sendbuf, recvbuf)

    Neighbor Gather to All

    Parameters:

      - sendbuf (BufSpec) –

      - recvbuf (BufSpecB) –

    Return type:

      None

  Neighbor_allgatherv(sendbuf, recvbuf)

    Neighbor Gather to All Vector

    Parameters:

      - sendbuf (BufSpec) –

      - recvbuf (BufSpecV) –

    Return type:

      None

  Neighbor_alltoall(sendbuf, recvbuf)

    Neighbor All-to-All

    Parameters:

      - sendbuf (BufSpecB) –

      - recvbuf (BufSpecB) –

    Return type:

      None

  Neighbor_alltoallv(sendbuf, recvbuf)

    Neighbor All-to-All Vector

    Parameters:

      - sendbuf (BufSpecV) –

      - recvbuf (BufSpecV) –

    Return type:

      None

  Neighbor_alltoallw(sendbuf, recvbuf)

    Neighbor All-to-All Generalized

    Parameters:

      - sendbuf (BufSpecW) –

      - recvbuf (BufSpecW) –

    Return type:

      None

  neighbor_allgather(sendobj)

    Neighbor Gather to All

    Parameters:

      sendobj (Any) –

    Return type:

      List[Any]

  neighbor_alltoall(sendobj)

    Neighbor All to All Scatter/Gather

    Parameters:

      sendobj (List[Any]) –

    Return type:

      List[Any]

  Attributes Documentation

  degrees

    number of incoming and outgoing neighbors

  indegree

    number of incoming neighbors

  inedges

    incoming neighbors

  inoutedges

    incoming and outgoing neighbors

  outdegree

    number of outgoing neighbors

  outedges

    outgoing neighbors