src/gromacs/legacyheaders/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  * Copyright (c) 2013, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37
  38 #ifndef _QMMM_h
  39 #define _QMMM_h
  40
  41 #include "typedefs.h"
  42 #include "pbc.h"
  43 #include "network.h"
  44 #include "tgroup.h"
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 void atomic_number(int nr, char ***atomtype, int *nucnum);
  51
  52 t_QMMMrec *mk_QMMMrec(void);
  53 /* allocates memory for QMMMrec */
  54
  55 void init_QMMMrec(t_commrec  *cr,
  56                   gmx_mtop_t *mtop,
  57                   t_inputrec *ir,
  58                   t_forcerec *fr);
  59
  60 /* init_QMMMrec initializes the QMMM record. From
  61  * topology->atoms.atomname and topology->atoms.atomtype the atom
  62  * names and types are read; from inputrec->QMcharge
  63  * resp. inputrec->QMmult the nelecs and multiplicity are determined
  64  * and md->cQMMM gives numbers of the MM and QM atoms
  65  */
  66
  67 void update_QMMMrec(t_commrec      *cr,
  68                     t_forcerec     *fr,
  69                     rvec            x[],
  70                     t_mdatoms      *md,
  71                     matrix          box,
  72                     gmx_localtop_t *top);
  73
  74 /* update_QMMMrec fills the MM stuff in QMMMrec. The MM atoms are
  75  * taken froom the neighbourlists of the QM atoms. In a QMMM run this
  76  * routine should be called at every step, since it updates the MM
  77  * elements of the t_QMMMrec struct.
  78  */
  79
  80 real calculate_QMMM(t_commrec *cr,
  81                     rvec x[], rvec f[],
  82                     t_forcerec *fr);
  83
  84 /* QMMM computes the QM forces. This routine makes either function
  85  * calls to gmx QM routines (derived from MOPAC7 (semi-emp.) and MPQC
  86  * (ab initio)) or generates input files for an external QM package
  87  * (listed in QMMMrec.QMpackage). The binary of the QM package is
  88  * called by system().
  89  */
  90
  91 #ifdef __cplusplus
  92 }
  93 #endif
  94
  95 #endif  /* _QMMM_h */