src/gromacs/mdtypes/observableshistory.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,2018, 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 /*! \libinternal \file
  37  *
  38  * \brief
  39  * This file contains the definition of a container for history data
  40  * for simulation observables.
  41  *
  42  * The container is used for storing the simulation state data that needs
  43  * to be written to / read from checkpoint file. This struct should only
  44  * contain pure observable data. Microstate data should be in t_state.
  45  * The state of the mdrun machinery is also stored elsewhere.
  46  *
  47  * \author Berk Hess
  48  *
  49  * \inlibraryapi
  50  * \ingroup module_mdtypes
  51  */
  52
  53 #ifndef GMX_MDLIB_OBSERVABLESHISTORY_H
  54 #define GMX_MDLIB_OBSERVABLESHISTORY_H
  55
  56 #include <memory>
  57
  58 class energyhistory_t;
  59 class PullHistory;
  60 struct edsamhistory_t;
  61 struct swaphistory_t;
  62
  63 /*! \libinternal \brief Observables history, for writing/reading to/from checkpoint file
  64  */
  65 struct ObservablesHistory
  66 {
  67     //! History for energy observables, used for output only
  68     std::unique_ptr<energyhistory_t> energyHistory;
  69
  70     //! History for pulling observables, used for output only
  71     std::unique_ptr<PullHistory> pullHistory;
  72
  73     //! Essential dynamics and flooding history
  74     std::unique_ptr<edsamhistory_t> edsamHistory;
  75
  76     //! Ion/water position swapping history
  77     std::unique_ptr<swaphistory_t> swapHistory;
  78
  79     ObservablesHistory();
  80
  81     ~ObservablesHistory();
  82 };
  83
  84 #endif