src/kernel/openmm_wrapper.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2010, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 #ifndef _OPENMM_WRAPPER_H_
  40 #define _OPENMM_WRAPPER_H_
  41
  42 #ifdef __cplusplus
  43 extern "C"
  44 {
  45 #endif
  46
  47 #ifdef GMX_OPENMM
  48 void* openmm_init(FILE *fplog, const char *platformOptStr,
  49                     t_inputrec *ir,
  50                     gmx_mtop_t *top_global, gmx_localtop_t *top,
  51                     t_mdatoms *mdatoms, t_forcerec *fr, t_state *state);
  52
  53 void openmm_take_one_step(void* data);
  54
  55 void openmm_take_steps(void* data, int nsteps);
  56
  57 void openmm_copy_state(void *data,
  58                         t_state *state, double *time,
  59                         rvec f[], gmx_enerdata_t *enerd,
  60                         gmx_bool includePos, gmx_bool includeVel, gmx_bool includeForce, gmx_bool includeEnergy);
  61
  62 void openmm_cleanup(FILE *fplog, void* data);
  63 #else
  64 /* dummy versions of the wrapper functions to enable compilation of
  65    do_md_openmm even when OpenMM is not used */
  66 void* openmm_init(FILE *fplog, const char *platformOptStr,
  67                     t_inputrec *ir,
  68                     gmx_mtop_t *top_global, gmx_localtop_t *top,
  69                     t_mdatoms *mdatoms, t_forcerec *fr, t_state *state){return NULL;}
  70
  71 void openmm_take_one_step(void* data){}
  72
  73 void openmm_take_steps(void* data, int nsteps){}
  74
  75 void openmm_copy_state(void *data,
  76                         t_state *state, double *time,
  77                         rvec f[], gmx_enerdata_t *enerd,
  78                         gmx_bool includePos, gmx_bool includeVel, gmx_bool includeForce, gmx_bool includeEnergy){}
  79
  80 void openmm_cleanup(FILE *fplog, void* data){}
  81
  82 #endif /*GMX_OPENMM*/
  83
  84
  85 #ifdef __cplusplus
  86 } // extern "C"
  87 #endif
  88
  89 #endif /* _OPENMM_WRAPPER_H_ */
  90