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
|
.. _mpi_cartdim_get:
MPI_Cartdim_get
===============
.. include_body
:ref:`MPI_Cartdim_get` |mdash| Retrieves Cartesian topology information associated
with a communicator.
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: C
#include <mpi.h>
int MPI_Cartdim_get(MPI_Comm comm, int *ndims)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_CARTDIM_GET(COMM, NDIMS, IERROR)
INTEGER COMM, NDIMS, IERROR
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
USE mpi_f08
MPI_Cartdim_get(comm, ndims, ierror)
TYPE(MPI_Comm), INTENT(IN) :: comm
INTEGER, INTENT(OUT) :: ndims
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
INPUT PARAMETER
---------------
* ``comm`` : Communicator with Cartesian structure (handle).
OUTPUT PARAMETERS
-----------------
* ``ndims`` : Number of dimensions of the Cartesian structure (integer).
* ``ierror`` : Fortran only: Error status (integer).
DESCRIPTION
-----------
:ref:`MPI_Cartdim_get` returns the number of dimensions of the Cartesian
structure.
ERRORS
------
.. include:: ./ERRORS.rst
.. seealso::
* :ref:`MPI_Cart_get`
|
