include/vsite.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 _vsite_h
  37 #define _vsite_h
  38
  39 #include <stdio.h>
  40 #include "typedefs.h"
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 typedef struct {
  47         int *      left_import_construct;
  48         int        left_import_nconstruct;
  49         int *      left_export_construct;
  50         int        left_export_nconstruct;
  51         int *      right_import_construct;
  52         int        right_import_nconstruct;
  53         int *      right_export_construct;
  54         int        right_export_nconstruct;
  55         rvec *     send_buf;
  56         rvec *     recv_buf;
  57 } t_comm_vsites;
  58
  59 typedef struct {
  60   int  n_intercg_vsite;       /* The number of inter charge group vsites */
  61   int  nvsite_pbc_molt;       /* The array size of vsite_pbc_molt        */
  62   int  ***vsite_pbc_molt;     /* The pbc atoms for intercg vsites        */
  63   int  **vsite_pbc_loc;       /* The local pbc atoms                     */
  64   int  *vsite_pbc_loc_nalloc;
  65   gmx_bool bPDvsitecomm;          /* Do we need vsite communication with PD? */
  66   t_comm_vsites *vsitecomm;   /* The PD vsite communication struct       */
  67 } gmx_vsite_t;
  68
  69 void construct_vsites(FILE *log,gmx_vsite_t *vsite,
  70                              rvec x[],t_nrnb *nrnb,
  71                              real dt,rvec v[],
  72                              t_iparams ip[],t_ilist ilist[],
  73                              int ePBC,gmx_bool bMolPBC,t_graph *graph,
  74                              t_commrec *cr,matrix box);
  75 /* Create positions of vsite atoms based on surrounding atoms
  76  * for the local system.
  77  * If v is passed, the velocities of the vsites will be calculated
  78  * as the new positions minus the old positions divided by dt,
  79  * thus v should only be passed when the coordinates have been
  80  * updated with a full time step.
  81  * Note that velocitis of vsites are completely irrelevant
  82  * for the integration, they are only useful for analysis.
  83  */
  84
  85 void construct_vsites_mtop(FILE *log,gmx_vsite_t *vsite,
  86                            gmx_mtop_t *mtop,rvec x[]);
  87 /* Create positions of vsite atoms based on surrounding atoms
  88  * for the whole system.
  89  * This function assumes that all molecules are whole.
  90  */
  91
  92 void spread_vsite_f(FILE *log,gmx_vsite_t *vsite,
  93                     rvec x[],rvec f[],rvec *fshift,
  94                     gmx_bool VirCorr,matrix vir,
  95                     t_nrnb *nrnb,t_idef *idef,
  96                     int ePBC,gmx_bool bMolPBC,t_graph *g,matrix box,
  97                     t_commrec *cr);
  98 /* Spread the force operating on the vsite atoms on the surrounding atoms.
  99  * If fshift!=NULL also update the shift forces.
 100  * If VirCorr=TRUE add the virial correction for non-linear vsite constructs
 101  * to vir. This correction is required when the virial is not calculated
 102  * afterwards from the particle position and forces, but in a different way,
 103  * as for instance for the PME mesh contribution.
 104  */
 105
 106 gmx_vsite_t *init_vsite(gmx_mtop_t *mtop,t_commrec *cr);
 107 /* Initialize the virtual site struct,
 108  * returns NULL when there are no virtual sites.
 109  */
 110
 111 void set_vsite_top(gmx_vsite_t *vsite,gmx_localtop_t *top,t_mdatoms *md,
 112                           t_commrec *cr);
 113 /* Set some vsite data for runs without domain decomposition.
 114  * Should be called once after init_vsite, before calling other routines.
 115  */
 116
 117 #ifdef __cplusplus
 118 }
 119 #endif
 120
 121 #endif
 122