]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Address what 'sequential' means in the context of communicators.
authorWolfgang Bangerth <bangerth@colostate.edu>
Sat, 20 Jan 2018 01:04:32 +0000 (18:04 -0700)
committerWolfgang Bangerth <bangerth@colostate.edu>
Sat, 20 Jan 2018 01:04:32 +0000 (18:04 -0700)
include/deal.II/base/mpi.h
include/deal.II/base/utilities.h

index 2790c9e8b086116d0677e4a56375872d58ab87a3..2902516e8fd8d77cb3a35b6c999d97ac188477b6 100644 (file)
@@ -75,7 +75,10 @@ namespace Utilities
     /**
      * Return the number of MPI processes there exist in the given
      * @ref GlossMPICommunicator "communicator"
-     * object. If this is a sequential job, it returns 1.
+     * object. If this is a sequential job (i.e., the program
+     * is not using MPI at all, or is using MPI but has been started with
+     * only one MPI process), then the communicator necessarily involves
+     * only one process and the function returns 1.
      */
     unsigned int n_mpi_processes (const MPI_Comm &mpi_communicator);
 
index e1b091e798a5f2a825812d91a345c2b40420fa97..06abd5cd43dfb9c9393b8a9cd5150ae8a51e0aa1 100644 (file)
@@ -596,7 +596,10 @@ namespace Utilities
 
     /**
      * Return the number of MPI processes there exist in the given
-     * communicator object. If this is a sequential job, it returns 1.
+     * communicator object. If this is a sequential job (i.e., the program
+     * is not using MPI at all, or is using MPI but has been started with
+     * only one MPI process), then the communicator necessarily involves
+     * only one process and the function returns 1.
      */
     unsigned int get_n_mpi_processes (const Epetra_Comm &mpi_communicator);
 

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.