include/orires.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gromacs Runs On Most of All Computer Systems
  34  */
  35
  36 #ifndef _orires_h
  37 #define _orires_h
  38 #include "visibility.h"
  39 #include "sysstuff.h"
  40 #include "typedefs.h"
  41
  42 #ifdef __cplusplus
  43     extern "C" {
  44 #endif
  45
  46 GMX_LIBGMX_EXPORT
  47 void init_orires(FILE *fplog,const gmx_mtop_t *mtop,
  48                         rvec x[],
  49                         const t_inputrec *ir,
  50                         const gmx_multisim_t *ms,t_oriresdata *od,
  51                         t_state *state);
  52 /* Initializes all the orientation restraint stuff in *od */
  53
  54 real calc_orires_dev(const gmx_multisim_t *ms,
  55                             int nfa,const t_iatom fa[],const t_iparams ip[],
  56                             const t_mdatoms *md,const rvec x[],
  57                             const t_pbc *pbc,t_fcdata *fcd,history_t *hist);
  58 /*
  59  * Calculates the time averaged D matrices, the S matrix for each experiment.
  60  * Returns the weighted RMS deviation of the orientation restraints.
  61  */
  62
  63 GMX_LIBGMX_EXPORT
  64 void diagonalize_orires_tensors(t_oriresdata *od);
  65 /*
  66  * Diagonalizes the order tensor(s) of the orienation restraints.
  67  * For each experiment eig containts first 3 eigenvalues and then
  68  * the 3 eigenvectors. The eigenvalues are ordered on magnitude.
  69  */
  70
  71 GMX_LIBGMX_EXPORT
  72 void print_orires_log(FILE *log,t_oriresdata *od);
  73 /* Print order parameter, eigenvalues and eigenvectors to the log file */
  74
  75 t_ifunc orires;
  76 /* Does only the orientation restraint force calculation */
  77
  78 GMX_LIBGMX_EXPORT
  79 void update_orires_history(t_fcdata *fcd,history_t *hist);
  80 /* Copy the new time averages that have been calculated in calc_orires_dev */
  81
  82 #ifdef __cplusplus
  83 }
  84 #endif
  85
  86 #endif  /* _orires_h */