From: Wolfgang Bangerth Date: Wed, 21 Sep 2005 16:15:22 +0000 (+0000) Subject: Add documentation. X-Git-Tag: v8.0.0~13112 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dc36f14e9ec4d529d5aa1624cfb56a35dfaa5464;p=dealii.git Add documentation. git-svn-id: https://svn.dealii.org/trunk@11491 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/base/include/base/utilities.h b/deal.II/base/include/base/utilities.h index 25e4717a5a..0f492d86f6 100644 --- a/deal.II/base/include/base/utilities.h +++ b/deal.II/base/include/base/utilities.h @@ -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); }