2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2008, The GROMACS development team.
6 * Copyright (c) 2013,2014,2015, 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.
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.
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.
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.
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.
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.
37 #ifndef GMX_MDLIB_QMMM_H
38 #define GMX_MDLIB_QMMM_H
40 #include "gromacs/math/vectypes.h"
41 #include "gromacs/mdlib/tgroup.h"
43 struct gmx_localtop_t
;
52 int nrQMatoms
; /* total nr of QM atoms */
53 rvec
*xQM
; /* shifted to center of box */
54 int *indexQM
; /* atom i = atom indexQM[i] in mdrun */
55 int *atomicnumberQM
; /* atomic numbers of QM atoms */
56 real
*QMcharges
; /* atomic charges of QM atoms(ONIOM) */
58 int QMcharge
; /* charge of the QM system */
59 int multiplicity
; /* multipicity (no of unpaired eln) */
60 int QMmethod
; /* see enums.h for all methods */
61 int QMbasis
; /* see enums.h for all bases */
62 int nelectrons
; /* total number of elecs in QM region*/
63 gmx_bool bTS
; /* Optimize a TS, only steep, no md */
64 gmx_bool bOPT
; /* Optimize QM subsys, only steep, no md */
65 gmx_bool
*frontatoms
; /* qm atoms on the QM side of a QM-MM bond */
66 /* Gaussian specific stuff */
67 int nQMcpus
; /* no. of CPUs used for the QM calc. */
68 int QMmem
; /* memory for the gaussian calc. */
69 int accuracy
; /* convergence criterium (E(-x)) */
70 gmx_bool cpmcscf
; /* using cpmcscf(l1003)*/
74 char *orca_basename
; /* basename for I/O with orca */
75 char *orca_dir
; /* directory for ORCA */
78 /* Surface hopping stuff */
79 gmx_bool bSH
; /* surface hopping (diabatic only) */
80 real SAon
; /* at which energy gap the SA starts */
81 real SAoff
; /* at which energy gap the SA stops */
82 int SAsteps
; /* stepwise switchinng on the SA */
83 int SAstep
; /* current state of SA */
95 int nrMMatoms
; /* nr of MM atoms, updated every step*/
96 rvec
*xMM
; /* shifted to center of box */
97 int *indexMM
; /* atom i = atom indexMM[I] in mdrun */
98 real
*MMcharges
; /* MM point charges in std QMMM calc.*/
100 int *MMatomtype
; /* only important for semi-emp. */
102 /* gaussian specific stuff */
108 typedef struct t_QMMMrec
{
109 int QMMMscheme
; /* ONIOM (multi-layer) or normal */
110 int nrQMlayers
; /* number of QM layers (total layers +1 (MM)) */
111 t_QMrec
**qm
; /* atoms and run params for each QM group */
112 t_MMrec
*mm
; /* there can only be one MM subsystem ! */
115 void atomic_number(int nr
, char ***atomtype
, int *nucnum
);
117 t_QMMMrec
*mk_QMMMrec(void);
118 /* allocates memory for QMMMrec */
120 void init_QMMMrec(t_commrec
*cr
,
125 /* init_QMMMrec initializes the QMMM record. From
126 * topology->atoms.atomname and topology->atoms.atomtype the atom
127 * names and types are read; from inputrec->QMcharge
128 * resp. inputrec->QMmult the nelecs and multiplicity are determined
129 * and md->cQMMM gives numbers of the MM and QM atoms
132 void update_QMMMrec(t_commrec
*cr
,
137 gmx_localtop_t
*top
);
139 /* update_QMMMrec fills the MM stuff in QMMMrec. The MM atoms are
140 * taken froom the neighbourlists of the QM atoms. In a QMMM run this
141 * routine should be called at every step, since it updates the MM
142 * elements of the t_QMMMrec struct.
145 real
calculate_QMMM(t_commrec
*cr
,
149 /* QMMM computes the QM forces. This routine makes either function
150 * calls to gmx QM routines (derived from MOPAC7 (semi-emp.) and MPQC
151 * (ab initio)) or generates input files for an external QM package
152 * (listed in QMMMrec.QMpackage). The binary of the QM package is
153 * called by system().