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, 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_fcdata;
  59 struct t_oriresdata;
  60 class t_state;
  61
  62 namespace gmx
  63 {
  64 template<typename>
  65 class ArrayRef;
  66 } // namespace gmx
  67
  68 /*! \brief
  69  * Decides whether orientation restraints can work, and initializes
  70  * all the orientation restraint stuff in *od (and assumes *od is
  71  * already allocated.
  72  * If orientation restraint are used, globalState is read and modified
  73  * on the master rank (which is the only rank, since orientation
  74  * restraints can not run in parallel).
  75  */
  76 void init_orires(FILE*                 fplog,
  77                  const gmx_mtop_t*     mtop,
  78                  const t_inputrec*     ir,
  79                  const t_commrec*      cr,
  80                  const gmx_multisim_t* ms,
  81                  t_state*              globalState,
  82                  t_oriresdata*         od);
  83
  84 /*! \brief
  85  * Calculates the time averaged D matrices, the S matrix for each experiment.
  86  *
  87  * Returns the weighted RMS deviation of the orientation restraints.
  88  */
  89 real calc_orires_dev(const gmx_multisim_t*          ms,
  90                      int                            nfa,
  91                      const t_iatom                  fa[],
  92                      const t_iparams                ip[],
  93                      const t_mdatoms*               md,
  94                      gmx::ArrayRef<const gmx::RVec> xWholeMolecules,
  95                      const rvec                     x[],
  96                      const t_pbc*                   pbc,
  97                      t_fcdata*                      fcd,
  98                      history_t*                     hist);
  99
 100 /*! \brief
 101  * Diagonalizes the order tensor(s) of the orienation restraints.
 102  *
 103  * For each experiment eig containts first 3 eigenvalues and then
 104  * the 3 eigenvectors. The eigenvalues are ordered on magnitude.
 105  */
 106 void diagonalize_orires_tensors(t_oriresdata* od);
 107
 108 //! Prints order parameter, eigenvalues and eigenvectors to the log file.
 109 void print_orires_log(FILE* log, t_oriresdata* od);
 110
 111 //! Calculates the orientation restraint forces.
 112 real orires(int              nfa,
 113             const t_iatom    forceatoms[],
 114             const t_iparams  ip[],
 115             const rvec       x[],
 116             rvec4            f[],
 117             rvec             fshift[],
 118             const t_pbc*     pbc,
 119             real             lambda,
 120             real*            dvdlambda,
 121             const t_mdatoms* md,
 122             t_fcdata*        fcd,
 123             int*             global_atom_index);
 124
 125 //! Copies the new time averages that have been calculated in calc_orires_dev.
 126 void update_orires_history(const t_fcdata* fcd, history_t* hist);
 127
 128 #endif