include/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  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * 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
  39 #ifndef _orires_h
  40 #define _orires_h
  41 #include "visibility.h"
  42 #include "sysstuff.h"
  43 #include "typedefs.h"
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 GMX_LIBGMX_EXPORT
  50 void init_orires(FILE *fplog, const gmx_mtop_t *mtop,
  51                  rvec x[],
  52                  const t_inputrec *ir,
  53                  const gmx_multisim_t *ms, t_oriresdata *od,
  54                  t_state *state);
  55 /* Initializes all the orientation restraint stuff in *od */
  56
  57 real calc_orires_dev(const gmx_multisim_t *ms,
  58                      int nfa, const t_iatom fa[], const t_iparams ip[],
  59                      const t_mdatoms *md, const rvec x[],
  60                      const t_pbc *pbc, t_fcdata *fcd, history_t *hist);
  61 /*
  62  * Calculates the time averaged D matrices, the S matrix for each experiment.
  63  * Returns the weighted RMS deviation of the orientation restraints.
  64  */
  65
  66 GMX_LIBGMX_EXPORT
  67 void diagonalize_orires_tensors(t_oriresdata *od);
  68 /*
  69  * Diagonalizes the order tensor(s) of the orienation restraints.
  70  * For each experiment eig containts first 3 eigenvalues and then
  71  * the 3 eigenvectors. The eigenvalues are ordered on magnitude.
  72  */
  73
  74 GMX_LIBGMX_EXPORT
  75 void print_orires_log(FILE *log, t_oriresdata *od);
  76 /* Print order parameter, eigenvalues and eigenvectors to the log file */
  77
  78 t_ifunc orires;
  79 /* Does only the orientation restraint force calculation */
  80
  81 GMX_LIBGMX_EXPORT
  82 void update_orires_history(t_fcdata *fcd, history_t *hist);
  83 /* Copy the new time averages that have been calculated in calc_orires_dev */
  84
  85 #ifdef __cplusplus
  86 }
  87 #endif
  88
  89 #endif  /* _orires_h */