include/macros.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 _macros_h
  40 #define _macros_h
  41
  42 #include "typedefs.h" /* for real definition only */
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 /*
  49  * With the macros below you don't
  50  * have to use an index if you don't wan't to. You can eg. use
  51  * angle.C0[23] instead if angle.c[0][23].
  52  * In a similar fashion, you can use angle.AI[3] instead of
  53  * angle.a[0][3]
  54  */
  55 #define AI  a[0]
  56 #define AJ  a[1]
  57 #define AK  a[2]
  58 #define AL  a[3]
  59 #define AM      a[4]
  60 #define C0  c[0]
  61 #define C1  c[1]
  62 #define C2  c[2]
  63 #define C3  c[3]
  64 #define C4  c[4]
  65 #define C5  c[5]
  66
  67 #ifndef min
  68 #define min(a, b) (((a) < (b)) ? (a) : (b) )
  69 #endif
  70 #ifndef max
  71 #define max(a, b) (((a) > (b)) ? (a) : (b) )
  72 #endif
  73 #ifndef even
  74 #define even(a) ( ( (a+1) / 2) == (a / 2) )
  75 #endif
  76
  77 /* This macro calculates the size of a array */
  78 #define asize(a) (sizeof(a)/sizeof((a)[0]))
  79
  80 extern const real ZERO;
  81 extern const real THIRD;
  82 extern const real HALF;
  83 extern const real ONE;
  84 extern const real TWO;
  85 extern const real THREE;
  86 extern const real SIX;
  87 extern const real TEN;
  88 extern const real TWELVE;
  89
  90 #ifdef __cplusplus
  91 }
  92 #endif
  93
  94
  95 #endif  /* _macros_h */