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,2015,2018,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 /*! \file
  36  * \brief
  37  * Declares gmx::AnalysisDataDisplacementModule.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_analysisdata
  42  */
  43 #ifndef GMX_ANALYSISDATA_MODULES_DISPLACEMENT_H
  44 #define GMX_ANALYSISDATA_MODULES_DISPLACEMENT_H
  45
  46 #include "gromacs/analysisdata/abstractdata.h"
  47 #include "gromacs/analysisdata/datamodule.h"
  48 #include "gromacs/utility/real.h"
  49
  50 namespace gmx
  51 {
  52
  53 class AnalysisDataBinAverageModule;
  54
  55 /*! \brief
  56  * Data module for calculating displacements.
  57  *
  58  * Output data contains a frame for each frame in the input data except the
  59  * first one.  For each frame, there can be multiple points, each of which
  60  * describes displacement for a certain time difference ending that that frame.
  61  * The first column contains the time difference (backwards from the current
  62  * frame), and the remaining columns the sizes of the displacements.
  63  *
  64  * Current implementation is not very generic, but should be easy to extend.
  65  *
  66  * \inpublicapi
  67  * \ingroup module_analysisdata
  68  */
  69 class AnalysisDataDisplacementModule : public AbstractAnalysisData, public AnalysisDataModuleSerial
  70 {
  71 public:
  72     AnalysisDataDisplacementModule();
  73     ~AnalysisDataDisplacementModule() override;
  74
  75     /*! \brief
  76      * Sets the largest displacement time to be calculated.
  77      */
  78     void setMaxTime(real tmax);
  79     /*! \brief
  80      * Sets an histogram module that will receive a MSD histogram.
  81      *
  82      * If this function is not called, no histogram is calculated.
  83      */
  84     void setMSDHistogram(const std::shared_ptr<AnalysisDataBinAverageModule>& histm);
  85
  86     int flags() const override;
  87
  88     void dataStarted(AbstractAnalysisData* data) override;
  89     void frameStarted(const AnalysisDataFrameHeader& header) override;
  90     void pointsAdded(const AnalysisDataPointSetRef& points) override;
  91     void frameFinished(const AnalysisDataFrameHeader& header) override;
  92     void dataFinished() override;
  93
  94 private:
  95     AnalysisDataFrameRef tryGetDataFrameInternal(int index) const override;
  96     bool                 requestStorageInternal(int nframes) override;
  97
  98     class Impl;
  99
 100     PrivateImplPointer<Impl> _impl;
 101 };
 102
 103 //! Smart pointer to manage an AnalysisDataDisplacementModule object.
 104 typedef std::shared_ptr<AnalysisDataDisplacementModule> AnalysisDataDisplacementModulePointer;
 105
 106 } // namespace gmx
 107
 108 #endif