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, 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 "typedefs.h"
  40 #include "types/commrec.h"
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 enum {
  47     dddirForward, dddirBackward
  48 };
  49
  50 /* Move integers in the comm. region one cell along the domain decomposition
  51  * in the dimension indexed by ddimind
  52  * forward (direction=dddirFoward) or backward (direction=dddirBackward).
  53  */
  54 void
  55 dd_sendrecv_int(const gmx_domdec_t *dd,
  56                 int ddimind, int direction,
  57                 int *buf_s, int n_s,
  58                 int *buf_r, int n_r);
  59
  60 /* Move reals in the comm. region one cell along the domain decomposition
  61  * in the dimension indexed by ddimind
  62  * forward (direction=dddirFoward) or backward (direction=dddirBackward).
  63  */
  64 void
  65 dd_sendrecv_real(const gmx_domdec_t *dd,
  66                  int ddimind, int direction,
  67                  real *buf_s, int n_s,
  68                  real *buf_r, int n_r);
  69
  70 /* Move revc's in the comm. region one cell along the domain decomposition
  71  * in dimension indexed by ddimind
  72  * forward (direction=dddirFoward) or backward (direction=dddirBackward).
  73  */
  74 void
  75 dd_sendrecv_rvec(const gmx_domdec_t *dd,
  76                  int ddimind, int direction,
  77                  rvec *buf_s, int n_s,
  78                  rvec *buf_r, int n_r);
  79
  80
  81 /* Move revc's in the comm. region one cell along the domain decomposition
  82  * in dimension indexed by ddimind
  83  * simultaneously in the forward and backward directions.
  84  */
  85 void
  86 dd_sendrecv2_rvec(const gmx_domdec_t *dd,
  87                   int ddimind,
  88                   rvec *buf_s_fw, int n_s_fw,
  89                   rvec *buf_r_fw, int n_r_fw,
  90                   rvec *buf_s_bw, int n_s_bw,
  91                   rvec *buf_r_bw, int n_r_bw);
  92
  93
  94 /* The functions below perform the same operations as the MPI functions
  95  * with the same name appendices, but over the domain decomposition
  96  * nodes only.
  97  * The DD master node is the master for these operations.
  98  */
  99
 100 void
 101 dd_bcast(gmx_domdec_t *dd, int nbytes, void *data);
 102
 103 /* Copies src to dest on the master node and then broadcasts */
 104 void
 105 dd_bcastc(gmx_domdec_t *dd, int nbytes, void *src, void *dest);
 106
 107 void
 108 dd_scatter(gmx_domdec_t *dd, int nbytes, void *src, void *dest);
 109
 110 void
 111 dd_gather(gmx_domdec_t *dd, int nbytes, void *src, void *dest);
 112
 113 /* If rcount==0, rbuf is allowed to be NULL */
 114 void
 115 dd_scatterv(gmx_domdec_t *dd,
 116             int *scounts, int *disps, void *sbuf,
 117             int rcount, void *rbuf);
 118
 119 /* If scount==0, sbuf is allowed to be NULL */
 120 void
 121 dd_gatherv(gmx_domdec_t *dd,
 122            int scount, void *sbuf,
 123            int *rcounts, int *disps, void *rbuf);
 124
 125 #ifdef __cplusplus
 126 }
 127 #endif
 128
 129 #endif  /* _domdec_network_h */