src/python/sip/trajectoryanalysis/analysismodule.sip

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014, 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 %PostInitialisationCode
  37     import_array();
  38 %End
  39
  40 struct t_trxframe {
  41
  42 %TypeHeaderCode
  43 #include <gromacs/fileio/trx.h>
  44 #include "numpy_conv.h"
  45 %End
  46
  47     int flags;
  48     int not_ok;
  49     bool bDouble;
  50     int natoms;
  51     double t0;
  52     double tf;
  53     double tpf;
  54     double tppf;
  55     bool bTitle;
  56     const char *title;
  57     bool bStep;
  58     int step;
  59     bool bTime;
  60     double time;
  61     bool bLambda;
  62     bool bFepState;
  63     double lambda;
  64     int fep_state;
  65     bool bAtoms;
  66     t_atoms *atoms;
  67     bool bPrec;
  68     double prec;
  69     bool bX;
  70     SIP_PYOBJECT x /NoSetter/ {
  71     %GetCode
  72         sipPy = array2dToNumpy(sipCpp->natoms, 3, sipCpp->x);
  73     %End
  74     };
  75     bool bV;
  76     SIP_PYOBJECT v /NoSetter/ {
  77     %GetCode
  78         sipPy = array2dToNumpy(sipCpp->natoms, 3, sipCpp->v);
  79     %End
  80     };
  81     bool bF;
  82     SIP_PYOBJECT f /NoSetter/ {
  83     %GetCode
  84         sipPy = array2dToNumpy(sipCpp->natoms, 3, sipCpp->f);
  85     %End
  86     };
  87     bool bBox;
  88     SIP_PYOBJECT box /NoSetter/ {
  89     %GetCode
  90         sipPy = array2dToNumpy(3, 3, sipCpp->box);
  91     %End
  92     };
  93     bool bPBC;
  94     int ePBC;
  95     // TODO
  96     /*t_gmxvmdplugin* *vmdplugin; */
  97 };
  98
  99 struct t_pbc {
 100
 101 %TypeHeaderCode
 102 #include <gromacs/pbcutil/pbc.h>
 103 #include "numpy_conv.h"
 104 %End
 105     int ePBC;
 106     int ndim_ePBC;
 107     int ePBCDX;
 108     int dim;
 109     SIP_PYOBJECT box /NoSetter/ {
 110     %GetCode
 111         sipPy = array2dToNumpy(3, 3, sipCpp->box);
 112     %End
 113     };
 114     SIP_PYOBJECT fbox_diag /NoSetter/ {
 115     %GetCode
 116         sipPy = array1dToNumpy(3, sipCpp->fbox_diag);
 117     %End
 118     };
 119     SIP_PYOBJECT hbox_diag /NoSetter/ {
 120     %GetCode
 121         sipPy = array1dToNumpy(3, sipCpp->hbox_diag);
 122     %End
 123     };
 124     SIP_PYOBJECT mhbox_diag /NoSetter/ {
 125     %GetCode
 126         sipPy = array1dToNumpy(3, sipCpp->mhbox_diag);
 127     %End
 128     };
 129     double max_cutoff2;
 130     bool bLimitDistance;
 131     double limit_distance2;
 132     int  ntric_vec;
 133     /*ivec tric_shift[MAX_NTRICVEC];*/
 134     /*rvec tric_vec[MAX_NTRICVEC];*/
 135 };
 136
 137 class TrajectoryAnalysisModuleData /NoDefaultCtors/ {
 138
 139 %TypeHeaderCode
 140 #include <gromacs/trajectoryanalysis/analysismodule.h>
 141 using namespace gmx;
 142 %End
 143
 144 public:
 145     virtual void finish() = 0;
 146 };
 147
 148 %ModuleHeaderCode
 149 #include "gromacs/utility/exceptions.h"
 150 %End
 151
 152 %VirtualErrorHandler vehandler
 153     SIP_RELEASE_GIL(sipGILState);
 154
 155     GMX_THROW(gmx::InternalError("Python virtual overload raised an exception, see traceback"));
 156 %End
 157
 158 %Include vector.sip
 159
 160 class TrajectoryAnalysisModule /VirtualErrorHandler=vehandler/ {
 161
 162 %TypeHeaderCode
 163 #include <gromacs/trajectoryanalysis/analysismodule.h>
 164 using namespace gmx;
 165 %End
 166 public:
 167     virtual void initOptions(IOptionsContainer *options, TrajectoryAnalysisSettings *settings) = 0;
 168     virtual void optionsFinished(TrajectoryAnalysisSettings *settings);
 169     virtual void initAnalysis(const TrajectoryAnalysisSettings &settings, const TopologyInformation &top) = 0;
 170     virtual void initAfterFirstFrame(const TrajectoryAnalysisSettings &settings, const t_trxframe &fr);
 171 //    virtual TrajectoryAnalysisModuleDataPointer       startFrames (const AnalysisDataParallelOptions &opt, const SelectionCollection &selections);
 172     virtual void analyzeFrame(int frnr, const t_trxframe &fr, t_pbc *pbc, TrajectoryAnalysisModuleData *pdata) = 0;
 173     virtual void finishFrames(TrajectoryAnalysisModuleData *pdata);
 174     virtual void finishAnalysis(int nframes) = 0;
 175     virtual void writeOutput() = 0;
 176     virtual const std::vector<TrajectoryAnalysisModule*> getBatch();
 177     virtual const std::vector<char*> getArgv(int);
 178     const char* name() const;
 179     const char* description() const;
 180     int datasetCount() const;
 181 //    const std::vector<std::string> datasetNames() const;
 182     AbstractAnalysisData& datasetFromIndex(int index) const;
 183     AbstractAnalysisData& datasetFromName(const char *name) const;
 184 protected:
 185     TrajectoryAnalysisModule(const char *name, const char *description);
 186 private:
 187     TrajectoryAnalysisModule(const TrajectoryAnalysisModule &other);
 188 };
 189
 190 %Exception gmx::InconsistentInputError(SIP_Exception) {
 191
 192 %TypeHeaderCode
 193 #include <gromacs/utility/exceptions.h>
 194 using namespace std;
 195 %End
 196
 197 %RaiseCode
 198     const char *detail = sipExceptionRef.what();
 199
 200     SIP_BLOCK_THREADS
 201     PyErr_SetString(sipException_gmx_InconsistentInputError, detail);
 202     SIP_UNBLOCK_THREADS
 203 %End
 204 };