]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add documentation.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Wed, 21 Sep 2005 16:15:22 +0000 (16:15 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Wed, 21 Sep 2005 16:15:22 +0000 (16:15 +0000)
git-svn-id: https://svn.dealii.org/trunk@11491 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/utilities.h

index 25e4717a5a8e153ac52d12ac0f8e4f27ac9292a6..0f492d86f686e5d447f9b51661d62a60df9eb532 100644 (file)
@@ -140,8 +140,15 @@ namespace Utilities
     std::string get_time ();
 
                                     /**
-                                     * Return the number of MPI
-                                     * processes there exist.
+                                     * Return the number of MPI processes
+                                     * there exist. If this is a sequential
+                                     * job, it returns 1.
+                                     *
+                                     * This function will only work if you
+                                     * also configured the library to use
+                                     * PETSc. If your program uses MPI but
+                                     * not PETSc, then this function is
+                                     * likely not going to work.
                                      */
     unsigned int get_n_mpi_processes (const MPI_Comm &mpi_communicator);
 
@@ -154,6 +161,12 @@ namespace Utilities
                                      * than) the number of all
                                      * processes (given by
                                      * get_n_mpi_processes()).
+                                     *
+                                     * This function will only work if you
+                                     * also configured the library to use
+                                     * PETSc. If your program uses MPI but
+                                     * not PETSc, then this function is
+                                     * likely not going to work.
                                      */
     unsigned int get_this_mpi_process (const MPI_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.