2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team.
6 * Copyright (c) 2013,2014, by the GROMACS development team, led by
7 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
8 * and including many others, as listed in the AUTHORS file in the
9 * top-level source directory and at http://www.gromacs.org.
11 * GROMACS is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public License
13 * as published by the Free Software Foundation; either version 2.1
14 * of the License, or (at your option) any later version.
16 * GROMACS is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with GROMACS; if not, see
23 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
24 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 * If you want to redistribute modifications to GROMACS, please
27 * consider that scientific software is very special. Version
28 * control is crucial - bugs must be traceable. We will be happy to
29 * consider code for inclusion in the official distribution, but
30 * derived work must not be called official GROMACS. Details are found
31 * in the README & COPYING files - if they are missing, get the
32 * official version at http://www.gromacs.org.
34 * To help us fund GROMACS development, we humbly ask that you cite
35 * the research papers on the package. Check out http://www.gromacs.org.
42 #include "gromacs/legacyheaders/genborn.h"
43 #include "gromacs/legacyheaders/network.h"
44 #include "gromacs/legacyheaders/tgroup.h"
45 #include "gromacs/legacyheaders/typedefs.h"
46 #include "gromacs/legacyheaders/vsite.h"
47 #include "gromacs/legacyheaders/types/force_flags.h"
48 #include "gromacs/timing/wallcycle.h"
57 void calc_vir(int nxf, rvec x[], rvec f[], tensor vir,
58 gmx_bool bScrewPBC, matrix box);
59 /* Calculate virial for nxf atoms, and add it to vir */
61 void f_calc_vir(int i0, int i1, rvec x[], rvec f[], tensor vir,
62 struct t_graph *g, rvec shift_vec[]);
63 /* Calculate virial taking periodicity into account */
65 real RF_excl_correction(const t_forcerec *fr, struct t_graph *g,
66 const t_mdatoms *mdatoms, const t_blocka *excl,
67 rvec x[], rvec f[], rvec *fshift, const struct t_pbc *pbc,
68 real lambda, real *dvdlambda);
69 /* Calculate the reaction-field energy correction for this node:
70 * epsfac q_i q_j (k_rf r_ij^2 - c_rf)
71 * and force correction for all excluded pairs, including self pairs.
74 void calc_rffac(FILE *fplog, int eel, real eps_r, real eps_rf,
77 real *kappa, real *krf, real *crf);
78 /* Determine the reaction-field constants */
80 void init_generalized_rf(FILE *fplog,
81 const gmx_mtop_t *mtop, const t_inputrec *ir,
83 /* Initialize the generalized reaction field parameters */
87 void make_wall_tables(FILE *fplog, const output_env_t oenv,
88 const t_inputrec *ir, const char *tabfn,
89 const gmx_groups_t *groups,
92 real do_walls(t_inputrec *ir, t_forcerec *fr, matrix box, t_mdatoms *md,
93 rvec x[], rvec f[], real lambda, real Vlj[], t_nrnb *nrnb);
95 t_forcerec *mk_forcerec(void);
97 #define GMX_MAKETABLES_FORCEUSER (1<<0)
98 #define GMX_MAKETABLES_14ONLY (1<<1)
100 t_forcetable make_tables(FILE *fp, const output_env_t oenv,
101 const t_forcerec *fr, gmx_bool bVerbose,
102 const char *fn, real rtab, int flags);
103 /* Return tables for inner loops. When bVerbose the tables are printed
107 bondedtable_t make_bonded_table(FILE *fplog, char *fn, int angle);
108 /* Return a table for bonded interactions,
109 * angle should be: bonds 0, angles 1, dihedrals 2
112 /* Return a table for GB calculations */
113 t_forcetable make_gb_table(const output_env_t oenv,
114 const t_forcerec *fr);
116 /* Read a table for AdResS Thermo Force calculations */
117 extern t_forcetable make_atf_table(FILE *out, const output_env_t oenv,
118 const t_forcerec *fr,
122 void pr_forcerec(FILE *fplog, t_forcerec *fr);
125 forcerec_set_ranges(t_forcerec *fr,
126 int ncg_home, int ncg_force,
128 int natoms_force_constr, int natoms_f_novirsum);
129 /* Set the number of cg's and atoms for the force calculation */
131 gmx_bool can_use_allvsall(const t_inputrec *ir,
132 gmx_bool bPrintNote, t_commrec *cr, FILE *fp);
133 /* Returns if we can use all-vs-all loops.
134 * If bPrintNote==TRUE, prints a note, if necessary, to stderr
135 * and fp (if !=NULL) on the master node.
139 gmx_bool nbnxn_acceleration_supported(FILE *fplog,
141 const t_inputrec *ir,
143 /* Return if GPU/CPU-SIMD acceleration is supported with the given inputrec
144 * with bGPU TRUE/FALSE.
145 * If the return value is FALSE and fplog/cr != NULL, prints a fallback
146 * message to fplog/stderr.
149 gmx_bool uses_simple_tables(int cutoff_scheme,
150 struct nonbonded_verlet_t *nbv,
152 /* Returns whether simple tables (i.e. not for use with GPUs) are used
153 * with the type of kernel indicated.
156 void init_interaction_const_tables(FILE *fp,
157 interaction_const_t *ic,
158 gmx_bool bSimpleTable,
160 /* Initializes the tables in the interaction constant data structure.
161 * Setting verlet_kernel_type to -1 always initializes tables for
162 * use with group kernels.
165 void init_forcerec(FILE *fplog,
166 const output_env_t oenv,
169 const t_inputrec *ir,
170 const gmx_mtop_t *mtop,
177 const char *nbpu_opt,
180 /* The Force rec struct must be created with mk_forcerec
181 * The gmx_booleans have the following meaning:
182 * bSetQ: Copy the charges [ only necessary when they change ]
183 * bMolEpot: Use the free energy stuff per molecule
184 * print_force >= 0: print forces for atoms with force >= print_force
187 void forcerec_set_excl_load(t_forcerec *fr,
188 const gmx_localtop_t *top);
189 /* Set the exclusion load for the local exclusions and possibly threads */
191 void init_enerdata(int ngener, int n_lambda, gmx_enerdata_t *enerd);
192 /* Intializes the energy storage struct */
194 void destroy_enerdata(gmx_enerdata_t *enerd);
195 /* Free all memory associated with enerd */
197 void reset_foreign_enerdata(gmx_enerdata_t *enerd);
198 /* Resets only the foreign energy data */
200 void reset_enerdata(t_forcerec *fr, gmx_bool bNS,
201 gmx_enerdata_t *enerd,
203 /* Resets the energy data, if bNS=TRUE also zeros the long-range part */
205 void sum_epot(gmx_grppairener_t *grpp, real *epot);
206 /* Locally sum the non-bonded potential energy terms */
208 void sum_dhdl(gmx_enerdata_t *enerd, real *lambda, t_lambda *fepvals);
209 /* Sum the free energy contributions */
211 void update_forcerec(t_forcerec *fr, matrix box);
212 /* Updates parameters in the forcerec that are time dependent */
214 /* Compute the average C6 and C12 params for LJ corrections */
215 void set_avcsixtwelve(FILE *fplog, t_forcerec *fr,
216 const gmx_mtop_t *mtop);
218 extern void do_force(FILE *log, t_commrec *cr,
219 t_inputrec *inputrec,
220 gmx_int64_t step, t_nrnb *nrnb, gmx_wallcycle_t wcycle,
222 gmx_groups_t *groups,
223 matrix box, rvec x[], history_t *hist,
227 gmx_enerdata_t *enerd, t_fcdata *fcd,
228 real *lambda, struct t_graph *graph,
230 gmx_vsite_t *vsite, rvec mu_tot,
231 double t, FILE *field, gmx_edsam_t ed,
235 /* Communicate coordinates (if parallel).
236 * Do neighbor searching (if necessary).
238 * Communicate forces (if parallel).
239 * Spread forces for vsites (if present).
241 * f is always required.
247 gmx_groups_t *groups,
253 gmx_bool bDoLongRangeNS);
254 /* Call the neighborsearcher */
256 extern void do_force_lowlevel(t_forcerec *fr,
261 gmx_wallcycle_t wcycle,
267 gmx_enerdata_t *enerd,
275 struct t_graph *graph,
280 /* Call all the force routines */
282 void free_gpu_resources(const t_forcerec *fr,
283 const t_commrec *cr);
289 #endif /* _force_h */