include/gmx_fatal_collective.h

   1 /* -*- mode: c; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; c-file-style: "stroustrup"; -*-
   2  *
   3  *
   4  *                This source code is part of
   5  *
   6  *                 G   R   O   M   A   C   S
   7  *
   8  *          GROningen MAchine for Chemical Simulations
   9  *
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2012, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gromacs Runs On Most of All Computer Systems
  34  */
  35
  36 #ifndef _fatal_collective_h
  37 #define _fatal_collective_h
  38
  39 #include "types/simple.h"
  40 #include "types/commrec.h"
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46
  47 void
  48 gmx_fatal_collective(int f_errno,const char *file,int line,
  49                      const t_commrec *cr,gmx_domdec_t *dd,
  50                      const char *fmt,...);
  51 /* As gmx_fatal declared in gmx_fatal.h,
  52  * but only the master process prints the error message.
  53  * This should only be called one of the following two situations:
  54  * 1) On all nodes in cr->mpi_comm_mysim, with cr!=NULL,dd==NULL.
  55  * 2) On all nodes in dd->mpi_comm_all,   with cr==NULL,dd!=NULL.
  56  * This will call MPI_Finalize instead of MPI_Abort when possible,
  57  * This is useful for handling errors in code that is executed identically
  58  * for all processes.
  59  */
  60
  61
  62 #ifdef __cplusplus
  63            }
  64 #endif
  65
  66 #endif  /* _fatal_collective_h */