src/gromacs/legacyheaders/domdec_network.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2008,2009,2010,2012,2014, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35
  36 #ifndef _domdec_network_h
  37 #define _domdec_network_h
  38
  39 #include "gromacs/legacyheaders/typedefs.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 enum {
  46     dddirForward, dddirBackward
  47 };
  48
  49 /* Move integers in the comm. region one cell along the domain decomposition
  50  * in the dimension indexed by ddimind
  51  * forward (direction=dddirFoward) or backward (direction=dddirBackward).
  52  */
  53 void
  54 dd_sendrecv_int(const gmx_domdec_t *dd,
  55                 int ddimind, int direction,
  56                 int *buf_s, int n_s,
  57                 int *buf_r, int n_r);
  58
  59 /* Move reals in the comm. region one cell along the domain decomposition
  60  * in the dimension indexed by ddimind
  61  * forward (direction=dddirFoward) or backward (direction=dddirBackward).
  62  */
  63 void
  64 dd_sendrecv_real(const gmx_domdec_t *dd,
  65                  int ddimind, int direction,
  66                  real *buf_s, int n_s,
  67                  real *buf_r, int n_r);
  68
  69 /* Move revc's in the comm. region one cell along the domain decomposition
  70  * in dimension indexed by ddimind
  71  * forward (direction=dddirFoward) or backward (direction=dddirBackward).
  72  */
  73 void
  74 dd_sendrecv_rvec(const gmx_domdec_t *dd,
  75                  int ddimind, int direction,
  76                  rvec *buf_s, int n_s,
  77                  rvec *buf_r, int n_r);
  78
  79
  80 /* Move revc's in the comm. region one cell along the domain decomposition
  81  * in dimension indexed by ddimind
  82  * simultaneously in the forward and backward directions.
  83  */
  84 void
  85 dd_sendrecv2_rvec(const gmx_domdec_t *dd,
  86                   int ddimind,
  87                   rvec *buf_s_fw, int n_s_fw,
  88                   rvec *buf_r_fw, int n_r_fw,
  89                   rvec *buf_s_bw, int n_s_bw,
  90                   rvec *buf_r_bw, int n_r_bw);
  91
  92
  93 /* The functions below perform the same operations as the MPI functions
  94  * with the same name appendices, but over the domain decomposition
  95  * nodes only.
  96  * The DD master node is the master for these operations.
  97  */
  98
  99 void
 100 dd_bcast(gmx_domdec_t *dd, int nbytes, void *data);
 101
 102 /* Copies src to dest on the master node and then broadcasts */
 103 void
 104 dd_bcastc(gmx_domdec_t *dd, int nbytes, void *src, void *dest);
 105
 106 void
 107 dd_scatter(gmx_domdec_t *dd, int nbytes, void *src, void *dest);
 108
 109 void
 110 dd_gather(gmx_domdec_t *dd, int nbytes, void *src, void *dest);
 111
 112 /* If rcount==0, rbuf is allowed to be NULL */
 113 void
 114 dd_scatterv(gmx_domdec_t *dd,
 115             int *scounts, int *disps, void *sbuf,
 116             int rcount, void *rbuf);
 117
 118 /* If scount==0, sbuf is allowed to be NULL */
 119 void
 120 dd_gatherv(gmx_domdec_t *dd,
 121            int scount, void *sbuf,
 122            int *rcounts, int *disps, void *rbuf);
 123
 124 #ifdef __cplusplus
 125 }
 126 #endif
 127
 128 #endif  /* _domdec_network_h */