src/gromacs/mdlib/qm_gaussian.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019, 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 #ifndef GMX_MDLIB_QMGAUSSIAN_H
  36 #define GMX_MDLIB_QMGAUSSIAN_H
  37
  38 #include "gromacs/math/vectypes.h"
  39 #include "gromacs/mdlib/qmmm.h"
  40
  41 struct t_forcerec;
  42
  43 /*! \brief
  44  * Initialize gaussian datastructures.
  45  *
  46  * \param[in] qm QM forcerec.
  47  */
  48 void init_gaussian(t_QMrec* qm);
  49
  50 /*! \brief
  51  * Call gaussian to do qm calculation.
  52  *
  53  * \param[in] qmmm   QMMM part forcerec.
  54  * \param[in] qm     QM part of forcerec.
  55  * \param[in] mm     mm part of forcerec.
  56  * \param[in] f      force vector.
  57  * \param[in] fshift shift of force vector.
  58  */
  59 real call_gaussian(const t_QMMMrec* qmmm, t_QMrec* qm, t_MMrec* mm, rvec f[], rvec fshift[]);
  60
  61 /*! \brief
  62  * Call gaussian SH(?) to do qm calculation.
  63  *
  64  * \param[in] qmmm   QMMM part forcerec.
  65  * \param[in] qm     QM part of forcerec.
  66  * \param[in] mm     mm part of forcerec.
  67  * \param[in] f      force vector.
  68  * \param[in] fshift shift of force vector.
  69  */
  70 real call_gaussian_SH(const t_QMMMrec* qmmm, t_QMrec* qm, t_MMrec* mm, rvec f[], rvec fshift[]);
  71
  72 #endif