Add gmx_getpid()

[alexxy/gromacs.git] / src / gromacs / utility.h

diff --git a/src/gromacs/utility.h b/src/gromacs/utility.h
index b91f3b9c4e0d17f72a1b75baced6b4e3920a2934..c0bdd6a91cdda968c6449ae462f2023ccdb23ac4 100644 (file)
--- a/src/gromacs/utility.h
+++ b/src/gromacs/utility.h
@@ -1,10 +1,10 @@
 /*
  * This file is part of the GROMACS molecular simulation package.
  *
- * Copyright (c) 2010,2011,2012,2013, by the GROMACS development team, led by
- * David van der Spoel, Berk Hess, Erik Lindahl, and including many
- * others, as listed in the AUTHORS file in the top-level source
- * directory and at http://www.gromacs.org.
+ * Copyright (c) 2010,2011,2012,2013,2014, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
  *
  * GROMACS is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public License
@@ -108,14 +108,11 @@
  * The header flags.h implements a gmx::FlagsTemplate template for better type
  * safety when using bit flag fields.
  *
- * The header uniqueptr.h declares gmx::gmx_unique_ptr, which is intended for
- * declaring smart pointer types with unique ownership.
- *
  *
  * <H3>Other Functionality</H3>
  *
  * The header init.h declares gmx::init() and gmx::finalize() for initializing
- * and deinitializing the Gromacs library.
+ * and deinitializing the \Gromacs library.
  *
  * The header arrayref.h implements a gmx::ConstArrayRef class for exposing a
  * C array or part of a std::vector (basically, any continuous stretch of
@@ -125,8 +122,10 @@
  *
  * \if libapi
  *
- * The header gmxmpi.h abstract away the mechanism of including either MPI or
+ * The header gmxmpi.h abstracts away the mechanism of including either MPI or
  * thread-MPI headers depending on compilation options.
+ * Similarly, gmxomp.h removes the need to use conditional compilation for code
+ * that needs to include omp.h for OpenMP functions.
  *
  * The header gmxregex.h declares gmx::Regex and regexMatch() for basic regular
  * expression matching using an interface similar to C++11.
@@ -134,11 +133,21 @@
  * The header messagestringcollector.h declares a gmx::MessageStringCollector
  * class for composing messages with context information.
  *
- * The header programinfo.h declares a gmx::ProgramInfo class that is used to
+ * The header sysinfo.h declares gmx_getpid() for getting the current process
+ * id.
+ *
+ * The header programcontext.h declares a gmx::ProgramContextInterface that is
+ * used to
  * initialize and access information about the running program, such as the
  * name and path of the executable.  This information is used, e.g., by the
  * error handling code in formatting standard error messages.
  *
+ * The header qsort_threadsafe.h provides a guaranteed threadsafe
+ * implementation for qsort().
+ *
+ * The header uniqueptr.h declares gmx::gmx_unique_ptr, which is intended for
+ * declaring smart pointer types with unique ownership.
+ *
  * \endif
  *
  * \author Teemu Murtola <teemu.murtola@gmail.com>
@@ -154,9 +163,10 @@
 #ifndef GMX_UTILITY_H
 #define GMX_UTILITY_H
 
-#include "utility/errorcodes.h"
-#include "utility/exceptions.h"
-#include "utility/gmxassert.h"
-#include "utility/init.h"
+#include "gromacs/utility/errorcodes.h"
+#include "gromacs/utility/exceptions.h"
+#include "gromacs/utility/gmxassert.h"
+#include "gromacs/utility/init.h"
+#include "gromacs/utility/programcontext.h"
 
 #endif