src/gromacs/analysisdata/modules/displacement.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014 by the GROMACS development team.
   5  * Copyright (c) 2015,2018,2019,2020,2021, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \file
  37  * \brief
  38  * Declares gmx::AnalysisDataDisplacementModule.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \inpublicapi
  42  * \ingroup module_analysisdata
  43  */
  44 #ifndef GMX_ANALYSISDATA_MODULES_DISPLACEMENT_H
  45 #define GMX_ANALYSISDATA_MODULES_DISPLACEMENT_H
  46
  47 #include "gromacs/analysisdata/abstractdata.h"
  48 #include "gromacs/analysisdata/datamodule.h"
  49 #include "gromacs/utility/real.h"
  50
  51 namespace gmx
  52 {
  53
  54 class AnalysisDataBinAverageModule;
  55
  56 /*! \brief
  57  * Data module for calculating displacements.
  58  *
  59  * Output data contains a frame for each frame in the input data except the
  60  * first one.  For each frame, there can be multiple points, each of which
  61  * describes displacement for a certain time difference ending that that frame.
  62  * The first column contains the time difference (backwards from the current
  63  * frame), and the remaining columns the sizes of the displacements.
  64  *
  65  * Current implementation is not very generic, but should be easy to extend.
  66  *
  67  * \inpublicapi
  68  * \ingroup module_analysisdata
  69  */
  70 class AnalysisDataDisplacementModule : public AbstractAnalysisData, public AnalysisDataModuleSerial
  71 {
  72 public:
  73     AnalysisDataDisplacementModule();
  74     ~AnalysisDataDisplacementModule() override;
  75
  76     /*! \brief
  77      * Sets the largest displacement time to be calculated.
  78      */
  79     void setMaxTime(real tmax);
  80     /*! \brief
  81      * Sets an histogram module that will receive a MSD histogram.
  82      *
  83      * If this function is not called, no histogram is calculated.
  84      */
  85     void setMSDHistogram(const std::shared_ptr<AnalysisDataBinAverageModule>& histm);
  86
  87     int flags() const override;
  88
  89     void dataStarted(AbstractAnalysisData* data) override;
  90     void frameStarted(const AnalysisDataFrameHeader& header) override;
  91     void pointsAdded(const AnalysisDataPointSetRef& points) override;
  92     void frameFinished(const AnalysisDataFrameHeader& header) override;
  93     void dataFinished() override;
  94
  95 private:
  96     AnalysisDataFrameRef tryGetDataFrameInternal(int index) const override;
  97     bool                 requestStorageInternal(int nframes) override;
  98
  99     class Impl;
 100
 101     std::unique_ptr<Impl> _impl;
 102 };
 103
 104 //! Smart pointer to manage an AnalysisDataDisplacementModule object.
 105 typedef std::shared_ptr<AnalysisDataDisplacementModule> AnalysisDataDisplacementModulePointer;
 106
 107 } // namespace gmx
 108
 109 #endif