src/gromacs/legacyheaders/bondf.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 _bondf_h
  37 #define _bondf_h
  38
  39
  40 #include <stdio.h>
  41 #include "typedefs.h"
  42 #include "nrnb.h"
  43 #include "pbc.h"
  44 #include "genborn.h"
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 int glatnr(int *global_atom_index, int i);
  51 /* Returns the global topology atom number belonging to local atom index i.
  52  * This function is intended for writing ascii output
  53  * and returns atom numbers starting at 1.
  54  * When global_atom_index=NULL returns i+1.
  55  */
  56
  57 void calc_bonds(FILE *fplog, const gmx_multisim_t *ms,
  58                 const t_idef *idef,
  59                 rvec x[], history_t *hist,
  60                 rvec f[], t_forcerec *fr,
  61                 const t_pbc *pbc, const t_graph *g,
  62                 gmx_enerdata_t *enerd, t_nrnb *nrnb, real *lambda,
  63                 const t_mdatoms *md,
  64                 t_fcdata *fcd, int *ddgatindex,
  65                 t_atomtypes *atype, gmx_genborn_t *born,
  66                 int force_flags,
  67                 gmx_bool bPrintSepPot, gmx_int64_t step);
  68 /*
  69  * The function calc_bonds() calculates all bonded force interactions.
  70  * The "bonds" are specified as follows:
  71  *   int nbonds
  72  *          the total number of bonded interactions.
  73  *   t_iatom *forceatoms
  74  *     specifies which atoms are involved in a bond of a certain
  75  *     type, see also struct t_idef.
  76  *   t_functype *functype
  77  *          defines for every bonded force type what type of function to
  78  *     use, see also struct t_idef.
  79  *   t_iparams *forceparams
  80  *          defines the parameters for every bond type, see also struct
  81  *     t_idef.
  82  *   real epot[NR_F]
  83  *     total potential energy split up over the function types.
  84  *   int *ddgatindex
  85  *     global atom number indices, should be NULL when not using DD.
  86  *   gmx_bool bPrintSepPot
  87  *     if TRUE print local potential and dVdlambda for each bonded type.
  88  *   int step
  89  *     used with bPrintSepPot
  90  *   return value:
  91  *          the total potential energy (sum over epot).
  92  */
  93
  94 void calc_bonds_lambda(FILE *fplog,
  95                        const t_idef *idef,
  96                        rvec x[],
  97                        t_forcerec *fr,
  98                        const t_pbc *pbc, const t_graph *g,
  99                        gmx_grppairener_t *grpp, real *epot, t_nrnb *nrnb,
 100                        real *lambda,
 101                        const t_mdatoms *md,
 102                        t_fcdata *fcd, int *global_atom_index);
 103 /* As calc_bonds, but only determines the potential energy
 104  * for the perturbed interactions.
 105  * The shift forces in fr are not affected.
 106  */
 107
 108 real posres(int nbonds,
 109             const t_iatom forceatoms[], const t_iparams forceparams[],
 110             const rvec x[], rvec f[], rvec vir_diag,
 111             t_pbc *pbc,
 112             real lambda, real *dvdlambda,
 113             int refcoord_scaling, int ePBC, rvec comA, rvec comB);
 114 /* Position restraints require a different pbc treatment from other bondeds */
 115
 116 real fbposres(int nbonds,
 117               const t_iatom forceatoms[], const t_iparams forceparams[],
 118               const rvec x[], rvec f[], rvec vir_diag,
 119               t_pbc *pbc, int refcoord_scaling, int ePBC, rvec com);
 120 /* Flat-bottom posres. Same PBC treatment as in normal position restraints */
 121
 122 real bond_angle(const rvec xi, const rvec xj, const rvec xk,
 123                 const t_pbc *pbc,
 124                 rvec r_ij, rvec r_kj, real *costh,
 125                 int *t1, int *t2);  /* out */
 126 /* Calculate bond-angle. No PBC is taken into account (use mol-shift) */
 127
 128 real dih_angle(const rvec xi, const rvec xj, const rvec xk, const rvec xl,
 129                const t_pbc *pbc,
 130                rvec r_ij, rvec r_kj, rvec r_kl, rvec m, rvec n, /* out */
 131                real *sign,
 132                int *t1, int *t2, int *t3);
 133 /* Calculate dihedral-angle. No PBC is taken into account (use mol-shift) */
 134
 135 void do_dih_fup(int i, int j, int k, int l, real ddphi,
 136                 rvec r_ij, rvec r_kj, rvec r_kl,
 137                 rvec m, rvec n, rvec f[], rvec fshift[],
 138                 const t_pbc *pbc, const t_graph *g,
 139                 const rvec *x, int t1, int t2, int t3);
 140 /* Do an update of the forces for dihedral potentials */
 141
 142 void make_dp_periodic(real *dp);
 143 /* make a dihedral fall in the range (-pi,pi) */
 144
 145 /*************************************************************************
 146  *
 147  *  Bonded force functions
 148  *
 149  *************************************************************************/
 150 t_ifunc bonds, g96bonds, morse_bonds, cubic_bonds, FENE_bonds, restraint_bonds;
 151 t_ifunc angles, g96angles, cross_bond_bond, cross_bond_angle, urey_bradley, quartic_angles, linear_angles;
 152 t_ifunc pdihs, idihs, rbdihs;
 153 t_ifunc tab_bonds, tab_angles, tab_dihs;
 154 t_ifunc polarize, anharm_polarize, water_pol, thole_pol, angres, angresz, dihres, unimplemented;
 155
 156
 157 /* Divided the bonded interactions over the threads, count=fr->nthreads
 158  * and set up the bonded thread-force buffer reduction.
 159  * This should be called each time the bonded setup changes;
 160  * i.e. at start-up without domain decomposition and at DD.
 161  */
 162 void setup_bonded_threading(t_forcerec *fr, t_idef *idef);
 163
 164 #ifdef __cplusplus
 165 }
 166 #endif
 167
 168 #endif  /* _bondf_h */