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
|
.. _mpi_cart_coords:
MPI_Cart_coords
===============
.. include_body
:ref:`MPI_Cart_coords` |mdash| Determines process coords in Cartesian topology
given rank in group.
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_Cart_coords(MPI_Comm comm, int rank, int maxdims,
int coords[])
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_CART_COORDS(COMM, RANK, MAXDIMS, COORDS, IERROR)
INTEGER COMM, RANK, MAXDIMS, COORDS(*), IERROR
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
USE mpi_f08
MPI_Cart_coords(comm, rank, maxdims, coords, ierror)
TYPE(MPI_Comm), INTENT(IN) :: comm
INTEGER, INTENT(IN) :: rank, maxdims
INTEGER, INTENT(OUT) :: coords(maxdims)
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
INPUT PARAMETERS
----------------
* ``comm`` : Communicator with Cartesian structure (handle).
* ``rank`` : Rank of a process within group of comm (integer).
* ``maxdims`` : Length of vector coords in the calling program
(integer). Length of vector coords in the calling program (integer).
OUTPUT PARAMETERS
-----------------
* ``coords`` : Integer array (of size ndims,which was defined by
:ref:`MPI_Cart_create` call) containing the Cartesian coordinates of
specified process (integer).
* ``ierror`` : Fortran only: Error status (integer).
DESCRIPTION
-----------
:ref:`MPI_Cart_coords` provides a mapping of ``rank``\ s to Cartesian
coordinates.
ERRORS
------
.. include:: ./ERRORS.rst
|
