src/gromacs/mdlib/ns.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,2015,2018,2019, 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 #ifndef GMX_MDLIB_NS_H
  38 #define GMX_MDLIB_NS_H
  39
  40 #include <stdio.h>
  41
  42 #include "gromacs/math/vectypes.h"
  43 #include "gromacs/utility/basedefinitions.h"
  44
  45 struct SimulationGroups;
  46 struct gmx_localtop_t;
  47 struct gmx_mtop_t;
  48 struct gmx_ns_t;
  49 struct t_commrec;
  50 struct t_forcerec;
  51 struct t_mdatoms;
  52 struct t_nblist;
  53 struct t_nrnb;
  54
  55 /****************************************************
  56  *
  57  *    U T I L I T I E S May be found in ns.c
  58  *
  59  ****************************************************/
  60
  61 void init_neighbor_list(FILE *log, t_forcerec *fr, int homenr);
  62 /*
  63  * nn is the number of energy terms in the energy matrix
  64  * (ngener*(ngener-1))/2
  65  * start is the first atom on this processor
  66  * homenr is the number of atoms on this processor
  67  */
  68
  69 int calc_naaj(int icg, int cgtot);
  70 /* Calculate the number of charge groups to interact with for icg */
  71
  72 /****************************************************
  73  *
  74  *    N E I G H B O R  S E A R C H I N G
  75  *
  76  *    Calls either ns5_core (when grid selected in .mdp file)
  77  *    or ns_simple_core (when simple selected in .mdp file)
  78  *
  79  *    Return total number of pairs searched
  80  *
  81  ****************************************************/
  82 void init_ns(FILE *fplog, const t_commrec *cr,
  83              gmx_ns_t *ns, t_forcerec *fr,
  84              const gmx_mtop_t *mtop);
  85
  86 //! Destructor.
  87 void done_ns(gmx_ns_t *ns, int numEnergyGroups);
  88
  89 int search_neighbours(FILE                      *log,
  90                       t_forcerec                *fr,
  91                       matrix                     box,
  92                       gmx_localtop_t            *top,
  93                       const SimulationGroups    *groups,
  94                       const t_commrec           *cr,
  95                       t_nrnb                    *nrnb,
  96                       const t_mdatoms           *md,
  97                       gmx_bool                   bFillGrid);
  98
  99
 100 /* Debugging routines from wnblist.c */
 101 void dump_nblist(FILE *out, const t_commrec *cr, t_forcerec *fr, int nDNL);
 102
 103 int read_nblist(FILE *in, FILE *out, int **mat, int natoms, gmx_bool bSymm);
 104 /* Returns total number of neighbors. If bSymm the matrix is symmetrized. */
 105
 106 void reallocate_nblist(t_nblist *nl);
 107 /* List reallocation, only exported for Verlet scheme use with FEP */
 108
 109 #endif