src/gromacs/mdtypes/edsamhistory.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,2019, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35
  36 /*
  37  * This file contains data types containing essential dynamics and
  38  * flooding data to be stored in the checkpoint file.
  39  */
  40
  41 #ifndef GMX_MDLIB_EDSAMHISTORY_H
  42 #define GMX_MDLIB_EDSAMHISTORY_H
  43
  44 #include "gromacs/math/vectypes.h"
  45 #include "gromacs/utility/basedefinitions.h"
  46
  47 /* Helper structure to be able to make essential dynamics / flooding group(s) whole
  48  *
  49  * If one uses essential dynamics or flooding on a group of atoms from
  50  * more than one molecule, we cannot make this group whole with
  51  * do_pbc_first_mtop(). We assume that the ED group has the correct PBC
  52  * representation at the beginning of the simulation and keep track
  53  * of the shifts to always get it into that representation.
  54  * For proper restarts from a checkpoint we store the positions of the
  55  * reference group at the time of checkpoint writing.
  56  */
  57 typedef struct edsamhistory_t
  58 {
  59     gmx_bool bFromCpt; // Did we start from a checkpoint file?
  60     int      nED;      // No. of ED/Flooding data sets, if <1 no ED
  61     int*     nref;     // No. of atoms in i'th reference structure
  62     int*     nav;      // Same for average structure
  63     rvec**   old_sref; // Positions of the reference atoms at the last time step (with correct PBC representation)
  64     rvec**   old_sref_p; // Pointer to these positions
  65     rvec**   old_sav;    // Same for the average positions
  66     rvec**   old_sav_p;  // Pointer to these positions
  67 } edsamhistory_t;
  68
  69 #endif