src/gromacs/utility/real.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, 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 /*! \file
  38  * \brief
  39  * Declares `real` and related constants.
  40  *
  41  * \inpublicapi
  42  * \ingroup module_utility
  43  */
  44 #ifndef GMX_UTILITY_REAL_H
  45 #define GMX_UTILITY_REAL_H
  46
  47 /*! \brief Double precision accuracy */
  48 #define GMX_DOUBLE_EPS   2.2204460492503131e-16
  49
  50 /*! \brief Maximum double precision value - reduced 1 unit in last digit for MSVC */
  51 #define GMX_DOUBLE_MAX   1.7976931348623157e+308
  52
  53 /*! \brief Minimum double precision value */
  54 #define GMX_DOUBLE_MIN   2.2250738585072014e-308
  55
  56 /*! \brief Single precision accuracy */
  57 #define GMX_FLOAT_EPS    1.19209290e-07F
  58
  59 /*! \brief Maximum single precision value - reduced 1 unit in last digit for MSVC */
  60 #define GMX_FLOAT_MAX    3.40282346E+38F
  61
  62 /*! \brief Minimum single precision value */
  63 #define GMX_FLOAT_MIN    1.175494351E-38F
  64
  65
  66 /*! \typedef real
  67  * \brief Precision-dependent \Gromacs floating-point type.
  68  */
  69 /*! \def HAVE_REAL
  70  * \brief Used to check whether `real` is already defined.
  71  */
  72 /*! \def GMX_MPI_REAL
  73  * \brief MPI data type for `real`.
  74  */
  75 /*! \def GMX_REAL_EPS
  76  * \brief Accuracy for `real`.
  77  */
  78 /*! \def GMX_REAL_MIN
  79  * \brief Smallest non-zero value for `real`.
  80  */
  81 /*! \def GMX_REAL_MAX
  82  * \brief Largest finite value for `real`.
  83  */
  84 /*! \def gmx_real_fullprecision_pfmt
  85  * \brief Format string for full `real` precision.
  86  */
  87 #ifdef GMX_DOUBLE
  88
  89 #ifndef HAVE_REAL
  90 typedef double      real;
  91 #define HAVE_REAL
  92 #endif
  93
  94 #define GMX_MPI_REAL    MPI_DOUBLE
  95 #define GMX_REAL_EPS    GMX_DOUBLE_EPS
  96 #define GMX_REAL_MIN    GMX_DOUBLE_MIN
  97 #define GMX_REAL_MAX    GMX_DOUBLE_MAX
  98 #define gmx_real_fullprecision_pfmt "%21.14e"
  99
 100 #else /* GMX_DOUBLE */
 101
 102 #ifndef HAVE_REAL
 103 typedef float           real;
 104 #define HAVE_REAL
 105 #endif
 106
 107 #define GMX_MPI_REAL    MPI_FLOAT
 108 #define GMX_REAL_EPS    GMX_FLOAT_EPS
 109 #define GMX_REAL_MIN    GMX_FLOAT_MIN
 110 #define GMX_REAL_MAX    GMX_FLOAT_MAX
 111 #define gmx_real_fullprecision_pfmt "%14.7e"
 112
 113 #endif /* GMX_DOUBLE */
 114
 115 #endif