include/types/block.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 #ifndef _block_h
  39 #define _block_h
  40
  41
  42 #include "idef.h"
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 /* the block structure points into an array (usually of atom_ids).
  49    It is a list of starting indices for objects of consecutive ids, such
  50    as molecules.
  51    For example, if this block denotes molecules, then the first molecule
  52    ranges from index[0] to index[1]-1 in the atom list.
  53
  54    This makes the mapping from atoms to molecules O(Nmolecules) instead
  55    of O(Natoms) in size.  */
  56 typedef struct {
  57   int nr;                       /* The number of blocks                 */
  58   atom_id *index;               /* Array of indices (dim: nr+1)         */
  59   int nalloc_index;             /* The allocation size for index        */
  60 } t_block;
  61
  62 typedef struct {
  63   int nr;                       /* The number of blocks                 */
  64   atom_id *index;               /* Array of indices in a (dim: nr+1)    */
  65   int nra;                      /* The number of atoms                  */
  66   atom_id *a;                   /* Array of atom numbers in each group  */
  67                                 /* (dim: nra)                           */
  68                                 /* Block i (0<=i<nr) runs from          */
  69                                 /* index[i] to index[i+1]-1. There will */
  70                                 /* allways be an extra entry in index   */
  71                                 /* to terminate the table               */
  72   int nalloc_index;             /* The allocation size for index        */
  73   int nalloc_a;                 /* The allocation size for a            */
  74 } t_blocka;
  75
  76
  77 #ifdef __cplusplus
  78 }
  79 #endif
  80
  81 #endif