src/gromacs/fileio/xtcio.cpp

   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,2016,2018 by the GROMACS development team.
   7  * Copyright (c) 2019,2020, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source 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 #include "gmxpre.h"
  39
  40 #include "xtcio.h"
  41
  42 #include <cstring>
  43
  44 #include "gromacs/fileio/gmxfio.h"
  45 #include "gromacs/fileio/gmxfio_xdr.h"
  46 #include "gromacs/fileio/xdrf.h"
  47 #include "gromacs/math/vec.h"
  48 #include "gromacs/utility/fatalerror.h"
  49 #include "gromacs/utility/futil.h"
  50 #include "gromacs/utility/smalloc.h"
  51
  52 #define XTC_MAGIC 1995
  53
  54
  55 static int xdr_r2f(XDR* xdrs, real* r, gmx_bool gmx_unused bRead)
  56 {
  57 #if GMX_DOUBLE
  58     float f;
  59     int   ret;
  60
  61     if (!bRead)
  62     {
  63         f = *r;
  64     }
  65     ret = xdr_float(xdrs, &f);
  66     if (bRead)
  67     {
  68         *r = f;
  69     }
  70
  71     return ret;
  72 #else
  73     return xdr_float(xdrs, static_cast<float*>(r));
  74 #endif
  75 }
  76
  77
  78 t_fileio* open_xtc(const char* fn, const char* mode)
  79 {
  80     return gmx_fio_open(fn, mode);
  81 }
  82
  83 void close_xtc(t_fileio* fio)
  84 {
  85     gmx_fio_close(fio);
  86 }
  87
  88 static void check_xtc_magic(int magic)
  89 {
  90     if (magic != XTC_MAGIC)
  91     {
  92         gmx_fatal(FARGS, "Magic Number Error in XTC file (read %d, should be %d)", magic, XTC_MAGIC);
  93     }
  94 }
  95
  96 static int xtc_check(const char* str, gmx_bool bResult, const char* file, int line)
  97 {
  98     if (!bResult)
  99     {
 100         if (debug)
 101         {
 102             fprintf(debug,
 103                     "\nXTC error: read/write of %s failed, "
 104                     "source file %s, line %d\n",
 105                     str,
 106                     file,
 107                     line);
 108         }
 109         return 0;
 110     }
 111     return 1;
 112 }
 113
 114 #define XTC_CHECK(s, b) xtc_check(s, b, __FILE__, __LINE__)
 115
 116 static int xtc_header(XDR* xd, int* magic, int* natoms, int64_t* step, real* time, gmx_bool bRead, gmx_bool* bOK)
 117 {
 118     int result;
 119
 120     if (xdr_int(xd, magic) == 0)
 121     {
 122         return 0;
 123     }
 124     result = XTC_CHECK("natoms", xdr_int(xd, natoms)); /* number of atoms */
 125     if (result)
 126     {
 127         /* Note that XTC wasn't defined to be extensible, so we can't
 128          * fix the fact that we used xdr_int for the step number,
 129          * which is defined to be signed and 32 bit. */
 130         int intStep = *step;
 131         result      = XTC_CHECK("step", xdr_int(xd, &intStep)); /* frame number    */
 132         *step       = intStep;
 133     }
 134     if (result)
 135     {
 136         result = XTC_CHECK("time", xdr_r2f(xd, time, bRead)); /* time */
 137     }
 138     *bOK = (result != 0);
 139
 140     return result;
 141 }
 142
 143 static int xtc_coord(XDR* xd, int* natoms, rvec* box, rvec* x, real* prec, gmx_bool bRead)
 144 {
 145     int i, j, result;
 146 #if GMX_DOUBLE
 147     float* ftmp;
 148     float  fprec;
 149 #endif
 150
 151     /* box */
 152     result = 1;
 153     for (i = 0; ((i < DIM) && result); i++)
 154     {
 155         for (j = 0; ((j < DIM) && result); j++)
 156         {
 157             result = XTC_CHECK("box", xdr_r2f(xd, &(box[i][j]), bRead));
 158         }
 159     }
 160
 161     if (!result)
 162     {
 163         return result;
 164     }
 165
 166 #if GMX_DOUBLE
 167     /* allocate temp. single-precision array */
 168     snew(ftmp, (*natoms) * DIM);
 169
 170     /* Copy data to temp. array if writing */
 171     if (!bRead)
 172     {
 173         for (i = 0; (i < *natoms); i++)
 174         {
 175             ftmp[DIM * i + XX] = x[i][XX];
 176             ftmp[DIM * i + YY] = x[i][YY];
 177             ftmp[DIM * i + ZZ] = x[i][ZZ];
 178         }
 179         fprec = *prec;
 180     }
 181     result = XTC_CHECK("x", xdr3dfcoord(xd, ftmp, natoms, &fprec));
 182
 183     /* Copy from temp. array if reading */
 184     if (bRead)
 185     {
 186         for (i = 0; (i < *natoms); i++)
 187         {
 188             x[i][XX] = ftmp[DIM * i + XX];
 189             x[i][YY] = ftmp[DIM * i + YY];
 190             x[i][ZZ] = ftmp[DIM * i + ZZ];
 191         }
 192         *prec = fprec;
 193     }
 194     sfree(ftmp);
 195 #else
 196     result = XTC_CHECK("x", xdr3dfcoord(xd, x[0], natoms, prec));
 197 #endif
 198
 199     return result;
 200 }
 201
 202
 203 int write_xtc(t_fileio* fio, int natoms, int64_t step, real time, const rvec* box, const rvec* x, real prec)
 204 {
 205     int      magic_number = XTC_MAGIC;
 206     XDR*     xd;
 207     gmx_bool bDum;
 208     int      bOK;
 209
 210     if (!fio)
 211     {
 212         /* This means the fio object is not being used, e.g. because
 213            we are actually writing TNG output. We still have to return
 214            a pseudo-success value, to keep some callers happy. */
 215         return 1;
 216     }
 217
 218     xd = gmx_fio_getxdr(fio);
 219     /* write magic number and xtc identidier */
 220     if (xtc_header(xd, &magic_number, &natoms, &step, &time, FALSE, &bDum) == 0)
 221     {
 222         return 0;
 223     }
 224
 225     /* write data */
 226     bOK = xtc_coord(xd, &natoms, const_cast<rvec*>(box), const_cast<rvec*>(x), &prec, FALSE); /* bOK will be 1 if writing went well */
 227
 228     if (bOK)
 229     {
 230         if (gmx_fio_flush(fio) != 0)
 231         {
 232             bOK = 0;
 233         }
 234     }
 235     return bOK; /* 0 if bad, 1 if writing went well */
 236 }
 237
 238 int read_first_xtc(t_fileio* fio, int* natoms, int64_t* step, real* time, matrix box, rvec** x, real* prec, gmx_bool* bOK)
 239 {
 240     int  magic;
 241     XDR* xd;
 242
 243     *bOK = TRUE;
 244     xd   = gmx_fio_getxdr(fio);
 245
 246     /* read header and malloc x */
 247     if (!xtc_header(xd, &magic, natoms, step, time, TRUE, bOK))
 248     {
 249         return 0;
 250     }
 251
 252     /* Check magic number */
 253     check_xtc_magic(magic);
 254
 255     snew(*x, *natoms);
 256
 257     *bOK = (xtc_coord(xd, natoms, box, *x, prec, TRUE) != 0);
 258
 259     return static_cast<int>(*bOK);
 260 }
 261
 262 int read_next_xtc(t_fileio* fio, int natoms, int64_t* step, real* time, matrix box, rvec* x, real* prec, gmx_bool* bOK)
 263 {
 264     int  magic;
 265     int  n;
 266     XDR* xd;
 267
 268     *bOK = TRUE;
 269     xd   = gmx_fio_getxdr(fio);
 270
 271     /* read header */
 272     if (!xtc_header(xd, &magic, &n, step, time, TRUE, bOK))
 273     {
 274         return 0;
 275     }
 276
 277     /* Check magic number */
 278     check_xtc_magic(magic);
 279
 280     if (n > natoms)
 281     {
 282         gmx_fatal(FARGS, "Frame contains more atoms (%d) than expected (%d)", n, natoms);
 283     }
 284
 285     *bOK = (xtc_coord(xd, &natoms, box, x, prec, TRUE) != 0);
 286
 287     return static_cast<int>(*bOK);
 288 }