src/gromacs/legacyheaders/network.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37
  38 #ifndef _network_h
  39 #define _network_h
  40
  41
  42 /*
  43  * This module defines the interface of the actual communication routines.
  44  */
  45
  46 #include <stdio.h>
  47
  48 #include "types/simple.h"
  49 #include "typedefs.h"
  50 #include "../utility/fatalerror.h"
  51
  52 #ifdef __cplusplus
  53 extern "C" {
  54 #endif
  55
  56 t_commrec *init_commrec(void);
  57 /* Allocate, initialize and return the commrec. */
  58
  59 t_commrec *reinitialize_commrec_for_this_thread(const t_commrec *cro);
  60 /* Initialize communication records for thread-parallel simulations.
  61    Must be called on all threads before any communication takes place by
  62    the individual threads. Copies the original commrec to
  63    thread-local versions (a small memory leak results because we don't
  64    deallocate the old shared version).  */
  65
  66 void gmx_fill_commrec_from_mpi(t_commrec *cr);
  67 /* Continues t_commrec construction */
  68
  69 void gmx_setup_nodecomm(FILE *fplog, t_commrec *cr);
  70 /* Sets up fast global communication for clusters with multi-core nodes */
  71
  72 void gmx_init_intranode_counters(t_commrec *cr);
  73 /* Initializes intra-physical-node MPI process/thread counts and ID. */
  74
  75 void gmx_barrier(const t_commrec *cr);
  76 /* Wait till all processes in cr->mpi_comm_mygroup have reached the barrier */
  77
  78 void gmx_bcast(int nbytes, void *b, const t_commrec *cr);
  79 /* Broadcast nbytes bytes from the master to cr->mpi_comm_mygroup */
  80
  81 void gmx_bcast_sim(int nbytes, void *b, const t_commrec *cr);
  82 /* Broadcast nbytes bytes from the sim master to cr->mpi_comm_mysim */
  83
  84 void gmx_sumi(int nr, int r[], const t_commrec *cr);
  85 /* Calculate the global sum of an array of ints */
  86
  87 void gmx_sumli(int nr, gmx_int64_t r[], const t_commrec *cr);
  88 /* Calculate the global sum of an array of large ints */
  89
  90 void gmx_sumf(int nr, float r[], const t_commrec *cr);
  91 /* Calculate the global sum of an array of floats */
  92
  93 void gmx_sumd(int nr, double r[], const t_commrec *cr);
  94 /* Calculate the global sum of an array of doubles */
  95
  96 void gmx_sumi_sim(int nr, int r[], const gmx_multisim_t *ms);
  97 /* Calculate the sum over the simulations of an array of ints */
  98
  99 void gmx_sumli_sim(int nr, gmx_int64_t r[], const gmx_multisim_t *ms);
 100 /* Calculate the sum over the simulations of an array of large ints */
 101
 102 void gmx_sumf_sim(int nr, float r[], const gmx_multisim_t *ms);
 103 /* Calculate the sum over the simulations of an array of floats */
 104
 105 void gmx_sumd_sim(int nr, double r[], const gmx_multisim_t *ms);
 106 /* Calculate the sum over the simulations of an array of doubles */
 107
 108 #ifdef GMX_DOUBLE
 109 #define gmx_sum       gmx_sumd
 110 #define gmx_sum_sim   gmx_sumd_sim
 111 #else
 112 #define gmx_sum       gmx_sumf
 113 #define gmx_sum_sim   gmx_sumf_sim
 114 #endif
 115
 116 /* This doesn't currently work if enabled (needs some header cleanup). */
 117 #ifdef DEBUG_GMX
 118 #define debug_gmx() do { FILE *fp = debug ? debug : stderr; \
 119                          if (bDebugMode()) { fprintf(fp, "NODEID=%d, %s  %d\n", gmx_mpi_initialized() ? gmx_node_rank() : -1, __FILE__, __LINE__); } fflush(fp); } while (0)
 120 #else
 121 #define debug_gmx()
 122 #endif
 123
 124 #ifdef __cplusplus
 125 }
 126 #endif
 127
 128
 129 #endif  /* _network_h */