src/kernel/topexcl.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  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 #ifndef _topexcl_h
  40 #define _topexcl_h
  41 #include "visibility.h"
  42 #include "topio.h"
  43
  44 typedef struct {
  45   int nr;               /* nr atoms (0 <= i < nr) (atoms->nr)           */
  46   int nrex;             /* with nrex lists of neighbours                */
  47                         /* respectively containing zeroth, first        */
  48                         /* second etc. neigbours (0 <= nre < nrex)      */
  49   int **nrexcl;         /* with (0 <= nrx < nrexcl[i][nre]) neigbours   */
  50                         /* per list stored in one 2d array of lists     */
  51   int ***a;             /* like this: a[i][nre][nrx]                    */
  52 } t_nextnb;
  53
  54 GMX_LIBGMXPREPROCESS_EXPORT
  55 extern void init_nnb(t_nextnb *nnb, int nr, int nrex);
  56 /* Initiate the arrays for nnb (see above) */
  57
  58 GMX_LIBGMXPREPROCESS_EXPORT
  59 extern void done_nnb(t_nextnb *nnb);
  60 /* Cleanup the nnb struct */
  61
  62 #ifdef DEBUG_NNB
  63 #define print_nnb(nnb, s) __print_nnb(nnb, s)
  64 extern void print_nnb(t_nextnb *nnb, char *s);
  65 /* Print the nnb struct */
  66 #else
  67 #define print_nnb(nnb, s)
  68 #endif
  69
  70 GMX_LIBGMXPREPROCESS_EXPORT
  71 extern void gen_nnb(t_nextnb *nnb,t_params plist[]);
  72 /* Generate a t_nextnb structure from bond information.
  73  * With the structure you can either generate exclusions
  74  * or generate angles and dihedrals. The structure must be
  75  * initiated using init_nnb.
  76  */
  77
  78 extern void nnb2excl (t_nextnb *nnb, t_blocka *excl);
  79 /* generate exclusions from nnb */
  80
  81 extern void generate_excl (int nrexcl, int nratoms,
  82                            t_params plist[],t_blocka *excl);
  83 /* Generate an exclusion block from bonds and constraints in
  84  * plist.
  85  */
  86
  87 #endif  /* _topexcl_h */