src/sip/trajectoryanalysis/analysismodule.sip

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2015, 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 struct t_trxframe {
  37
  38 %TypeHeaderCode
  39 #include <gromacs/trajectory/trajectoryframe.h>
  40 #include "numpy_conv.h"
  41 %End
  42
  43     int         not_ok;
  44     bool        bDouble;
  45     int         natoms;
  46     bool        bTitle;
  47     const char *title;
  48     bool        bStep;
  49     int         step;
  50     bool        bTime;
  51     double      time;
  52     bool        bLambda;
  53     bool        bFepState;
  54     double      lambda;
  55     int         fep_state;
  56     bool        bAtoms;
  57     t_atoms    *atoms;
  58     bool        bPrec;
  59     double      prec;
  60     bool        bX;
  61
  62     SIP_PYOBJECT x /NoSetter/ {
  63     %GetCode
  64         sipPy = array2dToNumpy(sipCpp->natoms, 3, sipCpp->x);
  65     %End
  66     };
  67     bool bV;
  68     SIP_PYOBJECT v /NoSetter/ {
  69     %GetCode
  70         sipPy = array2dToNumpy(sipCpp->natoms, 3, sipCpp->v);
  71     %End
  72     };
  73     bool bF;
  74     SIP_PYOBJECT f /NoSetter/ {
  75     %GetCode
  76         sipPy = array2dToNumpy(sipCpp->natoms, 3, sipCpp->f);
  77     %End
  78     };
  79     bool bBox;
  80     SIP_PYOBJECT box /NoSetter/ {
  81     %GetCode
  82         sipPy = array2dToNumpy(3, 3, sipCpp->box);
  83     %End
  84     };
  85     bool bPBC;
  86     int ePBC;
  87     bool bIndex;
  88     SIP_PYOBJECT index /NoSetter/ {
  89     %GetCode
  90         sipPy = array1dToNumpy(sipCpp->natoms, sipCpp->index);
  91     %End
  92     };
  93 };
  94
  95 struct t_pbc {
  96
  97 %TypeHeaderCode
  98 #include <gromacs/pbcutil/pbc.h>
  99 #include "numpy_conv.h"
 100 %End
 101     int ePBC;
 102     int ndim_ePBC;
 103     int ePBCDX;
 104     int dim;
 105     SIP_PYOBJECT box /NoSetter/ {
 106     %GetCode
 107         sipPy = array2dToNumpy(3, 3, sipCpp->box);
 108     %End
 109     };
 110     SIP_PYOBJECT fbox_diag /NoSetter/ {
 111     %GetCode
 112         sipPy = array1dToNumpy(3, sipCpp->fbox_diag);
 113     %End
 114     };
 115     SIP_PYOBJECT hbox_diag /NoSetter/ {
 116     %GetCode
 117         sipPy = array1dToNumpy(3, sipCpp->hbox_diag);
 118     %End
 119     };
 120     SIP_PYOBJECT mhbox_diag /NoSetter/ {
 121     %GetCode
 122         sipPy = array1dToNumpy(3, sipCpp->mhbox_diag);
 123     %End
 124     };
 125     double max_cutoff2;
 126     int  ntric_vec;
 127     /*ivec tric_shift[MAX_NTRICVEC];*/
 128     /*rvec tric_vec[MAX_NTRICVEC];*/
 129 };
 130
 131 class AnalysisDataParallelOptions /NoDefaultCtors/ {
 132 %TypeHeaderCode
 133 #include <gromacs/analysisdata/paralleloptions.h>
 134 %End
 135 public:
 136     AnalysisDataParallelOptions();
 137 };
 138
 139 class TrajectoryAnalysisModuleDataPointer;
 140 class TrajectoryAnalysisModuleData /NoDefaultCtors/ {
 141 %TypeHeaderCode
 142 #include <gromacs/trajectoryanalysis/analysismodule.h>
 143 using namespace gmx;
 144 %End
 145
 146 public:
 147     virtual void finish() = 0;
 148 };
 149
 150 class TrajectoryAnalysisModulePointer;
 151 class TrajectoryAnalysisModule /VirtualErrorHandler=vehandler/ {
 152 %TypeHeaderCode
 153 #include <gromacs/trajectoryanalysis/analysismodule.h>
 154 using namespace gmx;
 155 %End
 156 public:
 157     virtual void initOptions(IOptionsContainer *options, TrajectoryAnalysisSettings *settings) = 0;
 158     virtual void optionsFinished(TrajectoryAnalysisSettings *settings);
 159     virtual void initAnalysis(const TrajectoryAnalysisSettings &settings, const TopologyInformation &top) = 0;
 160     virtual void initAfterFirstFrame(const TrajectoryAnalysisSettings &settings, const t_trxframe &fr);
 161     // Discarding the virtual for now
 162     std::unique_ptr<TrajectoryAnalysisModuleData> startFrames (const AnalysisDataParallelOptions &opt, const SelectionCollection &selections);
 163     virtual void analyzeFrame(int frnr, const t_trxframe &fr /NoCopy/, t_pbc *pbc, TrajectoryAnalysisModuleData *pdata ) = 0;
 164     virtual void finishFrames(TrajectoryAnalysisModuleData *pdata);
 165     virtual void finishAnalysis(int nframes) = 0;
 166     virtual void writeOutput() = 0;
 167     int datasetCount() const;
 168     void finishFrameSerial(int frameIndex);
 169     AbstractAnalysisData& datasetFromIndex(int index) const;
 170     AbstractAnalysisData& datasetFromName(const char *name) const;
 171 protected:
 172     TrajectoryAnalysisModule();
 173 private:
 174     TrajectoryAnalysisModule(const TrajectoryAnalysisModule &other);
 175 };