src/gromacs/awh/correlationhistory.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,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 /*! \internal \file
  37  *
  38  * \brief
  39  * Contains datatypes and function declarations needed by AWH to
  40  * have its force correlation data checkpointed.
  41  *
  42  * \author Viveca Lindahl
  43  * \author Berk Hess <hess@kth.se>
  44  * \ingroup module_awh
  45  */
  46
  47 #ifndef GMX_AWH_CORRELATIONHISTORY_H
  48 #define GMX_AWH_CORRELATIONHISTORY_H
  49
  50 struct t_commrec;
  51
  52 namespace gmx
  53 {
  54 class CorrelationGrid;
  55 struct CorrelationGridHistory;
  56
  57 /*! \brief
  58  * Allocate a correlation grid history with the same structure as the given correlation grid.
  59  *
  60  * This function would be called at the start of a new simulation.
  61  * Note that only sizes and memory are initialized here.
  62  * History data is set by \ref updateCorrelationGridHistory.
  63  *
  64  * \param[in,out] corrGrid      Correlation grid state to initialize with.
  65  * \returns the correlation grid history struct.
  66  */
  67 CorrelationGridHistory initCorrelationGridHistoryFromState(const CorrelationGrid& corrGrid);
  68
  69 /*! \brief
  70  * Restores the correlation grid state from the correlation grid history.
  71  *
  72  * \param[in] corrGridHist  Correlation grid history to read.
  73  * \param[in,out] corrGrid  Correlation grid state to set.
  74  */
  75 void restoreCorrelationGridStateFromHistory(const CorrelationGridHistory& corrGridHist,
  76                                             CorrelationGrid*              corrGrid);
  77
  78 /*! \brief
  79  * Update the correlation grid history for checkpointing.
  80  *
  81  * \param[in,out] corrGridHist  Correlation grid history to set.
  82  * \param[in]     corrGrid      Correlation grid state to read.
  83  */
  84 void updateCorrelationGridHistory(CorrelationGridHistory* corrGridHist, const CorrelationGrid& corrGrid);
  85
  86 } // namespace gmx
  87
  88 #endif /* GMX_AWH_CORRELATIONHISTORY_H */