src/gromacs/listed_forces/orires.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-2004, The GROMACS development team.
   6  * Copyright (c) 2010,2014,2015,2017,2018 by the GROMACS development team.
   7  * Copyright (c) 2019,2020,2021, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source 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 /*! \libinternal \file
  39  * \brief
  40  * Declares functions for handling orientation restraints.
  41  *
  42  * \inlibraryapi
  43  * \ingroup module_listed_forces
  44  */
  45 #ifndef GMX_LISTED_FORCES_ORIRES_H
  46 #define GMX_LISTED_FORCES_ORIRES_H
  47
  48 #include <cstdio>
  49
  50 #include "gromacs/topology/ifunc.h"
  51
  52 struct gmx_mtop_t;
  53 struct gmx_multisim_t;
  54 class history_t;
  55 struct t_inputrec;
  56 struct t_pbc;
  57 struct t_commrec;
  58 struct t_oriresdata;
  59 struct t_disresdata;
  60 struct t_fcdata;
  61 class t_state;
  62 struct t_mdatoms;
  63
  64 namespace gmx
  65 {
  66 template<typename>
  67 class ArrayRef;
  68 } // namespace gmx
  69
  70 /*! \brief
  71  * Decides whether orientation restraints can work, and initializes
  72  * all the orientation restraint stuff in *od (and assumes *od is
  73  * already allocated.
  74  * If orientation restraint are used, globalState is read and modified
  75  * on the master rank (which is the only rank, since orientation
  76  * restraints can not run in parallel).
  77  */
  78 void init_orires(FILE*                 fplog,
  79                  const gmx_mtop_t&     mtop,
  80                  const t_inputrec*     ir,
  81                  const t_commrec*      cr,
  82                  const gmx_multisim_t* ms,
  83                  t_state*              globalState,
  84                  t_oriresdata*         od);
  85
  86 /*! \brief
  87  * Calculates the time averaged D matrices, the S matrix for each experiment.
  88  *
  89  * Returns the weighted RMS deviation of the orientation restraints.
  90  */
  91 real calc_orires_dev(const gmx_multisim_t*          ms,
  92                      int                            nfa,
  93                      const t_iatom                  fa[],
  94                      const t_iparams                ip[],
  95                      const t_mdatoms*               md,
  96                      gmx::ArrayRef<const gmx::RVec> xWholeMolecules,
  97                      const rvec                     x[],
  98                      const t_pbc*                   pbc,
  99                      t_oriresdata*                  oriresdata,
 100                      const history_t*               hist);
 101
 102 /*! \brief
 103  * Diagonalizes the order tensor(s) of the orienation restraints.
 104  *
 105  * For each experiment eig containts first 3 eigenvalues and then
 106  * the 3 eigenvectors. The eigenvalues are ordered on magnitude.
 107  */
 108 void diagonalize_orires_tensors(t_oriresdata* od);
 109
 110 //! Prints order parameter, eigenvalues and eigenvectors to the log file.
 111 void print_orires_log(FILE* log, t_oriresdata* od);
 112
 113 //! Calculates the orientation restraint forces.
 114 real orires(int                       nfa,
 115             const t_iatom             forceatoms[],
 116             const t_iparams           ip[],
 117             const rvec                x[],
 118             rvec4                     f[],
 119             rvec                      fshift[],
 120             const t_pbc*              pbc,
 121             real                      lambda,
 122             real*                     dvdlambda,
 123             gmx::ArrayRef<const real> charge,
 124             t_fcdata*                 fcd,
 125             t_disresdata*             disresdata,
 126             t_oriresdata*             oriresdata,
 127             int*                      global_atom_index);
 128
 129 //! Copies the new time averages that have been calculated in calc_orires_dev.
 130 void update_orires_history(const t_oriresdata& oriresdata, history_t* hist);
 131
 132 #endif