include/qmmm.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-2008, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, 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 _QMMM_h
  40 #define _QMMM_h
  41 #include "visibility.h"
  42 #include "typedefs.h"
  43 #include "pbc.h"
  44 #include "network.h"
  45 #include "tgroup.h"
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 void atomic_number(int nr, char ***atomtype, int *nucnum);
  52
  53 t_QMMMrec *mk_QMMMrec(void);
  54 /* allocates memory for QMMMrec */
  55
  56 GMX_LIBMD_EXPORT
  57 void init_QMMMrec(t_commrec  *cr,
  58                   matrix      box,
  59                   gmx_mtop_t *mtop,
  60                   t_inputrec *ir,
  61                   t_forcerec *fr);
  62
  63 /* init_QMMMrec initializes the QMMM record. From
  64  * topology->atoms.atomname and topology->atoms.atomtype the atom
  65  * names and types are read; from inputrec->QMcharge
  66  * resp. inputrec->QMmult the nelecs and multiplicity are determined
  67  * and md->cQMMM gives numbers of the MM and QM atoms
  68  */
  69
  70 void update_QMMMrec(t_commrec      *cr,
  71                     t_forcerec     *fr,
  72                     rvec            x[],
  73                     t_mdatoms      *md,
  74                     matrix          box,
  75                     gmx_localtop_t *top);
  76
  77 /* update_QMMMrec fills the MM stuff in QMMMrec. The MM atoms are
  78  * taken froom the neighbourlists of the QM atoms. In a QMMM run this
  79  * routine should be called at every step, since it updates the MM
  80  * elements of the t_QMMMrec struct.
  81  */
  82
  83 real calculate_QMMM(t_commrec *cr,
  84                     rvec x[], rvec f[],
  85                     t_forcerec *fr,
  86                     t_mdatoms *md);
  87
  88 /* QMMM computes the QM forces. This routine makes either function
  89  * calls to gmx QM routines (derived from MOPAC7 (semi-emp.) and MPQC
  90  * (ab initio)) or generates input files for an external QM package
  91  * (listed in QMMMrec.QMpackage). The binary of the QM package is
  92  * called by system().
  93  */
  94
  95 #ifdef __cplusplus
  96 }
  97 #endif
  98
  99 #endif  /* _QMMM_h */