include/network.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  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-2004, 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 _network_h
  37 #define _network_h
  38
  39
  40 /*
  41  * This module defines the interface of the actual communication routines.
  42  */
  43
  44 #include <stdio.h>
  45
  46 #include "types/simple.h"
  47 #include "types/commrec.h"
  48 #include "typedefs.h"
  49 #include "main.h"
  50 #include "gmx_fatal.h"
  51
  52 #ifdef __cplusplus
  53 extern "C" {
  54 #endif
  55
  56 int gmx_setup(int *argc,char **argv,int *nnodes);
  57 /* Initializes the parallel communication, return the ID of the node */
  58
  59 int gmx_node_num(void);
  60 /* return the number of nodes in the ring */
  61
  62 int gmx_node_rank(void);
  63 /* return the rank of the node */
  64
  65 void gmx_setup_nodecomm(FILE *fplog,t_commrec *cr);
  66 /* Sets up fast global communication for clusters with multi-core nodes */
  67
  68 gmx_bool gmx_mpi_initialized(void);
  69 /* return TRUE when MPI_Init has been called.
  70  * return FALSE when MPI_Init has not been called OR
  71  * when GROMACS was compiled without MPI support.
  72  */
  73
  74 void gmx_barrier(const t_commrec *cr);
  75 /* Wait till all processes in cr->mpi_comm_mygroup have reached the barrier */
  76
  77 void gmx_bcast(int nbytes,void *b,const t_commrec *cr);
  78 /* Broadcast nbytes bytes from the master to cr->mpi_comm_mygroup */
  79
  80 void gmx_bcast_sim(int nbytes,void *b,const t_commrec *cr);
  81 /* Broadcast nbytes bytes from the sim master to cr->mpi_comm_mysim */
  82
  83 void gmx_sumi(int nr,int r[],const t_commrec *cr);
  84 /* Calculate the global sum of an array of ints */
  85
  86 void gmx_sumli(int nr,gmx_large_int_t r[],const t_commrec *cr);
  87 /* Calculate the global sum of an array of large ints */
  88
  89 void gmx_sumf(int nr,float r[],const t_commrec *cr);
  90 /* Calculate the global sum of an array of floats */
  91
  92 void gmx_sumd(int nr,double r[],const t_commrec *cr);
  93 /* Calculate the global sum of an array of doubles */
  94
  95 void gmx_sumf_comm(int nr,float r[],MPI_Comm mpi_comm);
  96 /* Calculate the global sum of an array of floats */
  97
  98 void gmx_sumd_comm(int nr,double r[],MPI_Comm mpi_comm);
  99 /* Calculate the global sum of an array of doubles */
 100
 101 void gmx_sumi_sim(int nr,int r[],const gmx_multisim_t *ms);
 102 /* Calculate the sum over the simulations of an array of ints */
 103
 104 void gmx_sumli_sim(int nr,gmx_large_int_t r[],const gmx_multisim_t *ms);
 105 /* Calculate the sum over the simulations of an array of large ints */
 106
 107 void gmx_sumf_sim(int nr,float r[],const gmx_multisim_t *ms);
 108 /* Calculate the sum over the simulations of an array of floats */
 109
 110 void gmx_sumd_sim(int nr,double r[],const gmx_multisim_t *ms);
 111 /* Calculate the sum over the simulations of an array of doubles */
 112
 113 void gmx_abort(int nodeid,int nnodes,int errorno);
 114 /* Abort the parallel run */
 115
 116 void gmx_finalize(void);
 117
 118 /* Finish the parallel run in an ordered manner */
 119
 120 #ifdef GMX_DOUBLE
 121 #define gmx_sum_comm  gmx_sumd_comm
 122 #define gmx_sum       gmx_sumd
 123 #define gmx_sum_sim   gmx_sumd_sim
 124 #else
 125 #define gmx_sum_comm  gmx_sumf_comm
 126 #define gmx_sum       gmx_sumf
 127 #define gmx_sum_sim   gmx_sumf_sim
 128 #endif
 129
 130 #ifdef DEBUG_GMX
 131 #define debug_gmx() do { FILE *fp=debug ? debug : stderr;\
 132 if (bDebugMode()) fprintf(fp,"NODEID=%d, %s  %d\n",gmx_mpi_initialized() ? gmx_node_rank() : -1,__FILE__,__LINE__); fflush(fp); } while (0)
 133 #else
 134 #define debug_gmx()
 135 #endif
 136
 137 #ifdef __cplusplus
 138 }
 139 #endif
 140
 141
 142 #endif  /* _network_h */