1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
.. _mpi_cart_rank:
MPI_Cart_rank
=============
.. include_body
:ref:`MPI_Cart_rank` |mdash| Determines process rank in communicator given Cartesian
location.
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: C
#include <mpi.h>
int MPI_Cart_rank(MPI_Comm comm, int coords[], int *rank)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: Fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_CART_RANK(COMM, COORDS, RANK, IERROR)
INTEGER COMM, COORDS(*), RANK, IERROR
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: Fortran
USE mpi_f08
MPI_Cart_rank(comm, coords, rank, ierror)
TYPE(MPI_Comm), INTENT(IN) :: comm
INTEGER, INTENT(IN) :: coords(*)
INTEGER, INTENT(OUT) :: rank
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
INPUT PARAMETERS
----------------
* ``comm`` : Communicator with Cartesian structure (handle).
* ``coords`` : Integer array (of size ndims, which was defined by
:ref:`MPI_Cart_create` call) specifying the Cartesian coordinates of a
process.
OUTPUT PARAMETER
----------------
* ``rank`` : Rank of specified process (integer).
* ``ierror`` : Fortran only: Error status (integer).
DESCRIPTION
-----------
For a process group with Cartesian structure, the function :ref:`MPI_Cart_rank`
translates the logical process coordinates to process ranks as they are
used by the point-to-point routines. For dimension i with periods(i) =
true, if the coordinate, coords(i), is out of range, that is, coords(i)
< 0 or coords(i) >= dims(i), it is shifted back to the interval 0 =<
coords(i) < dims(i) automatically. Out-of-range coordinates are
erroneous for nonperiodic dimensions.
ERRORS
------
.. include:: ./ERRORS.rst
.. seealso::
* :ref:`MPI_Cart_create`
|
