src/gromacs/mdlib/forcerec.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) 2013,2014,2015,2016, 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.
  10  *
  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.
  15  *
  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.
  20  *
  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.
  25  *
  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.
  33  *
  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.
  36  */
  37 #ifndef GMX_MDLIB_FORCEREC_H
  38 #define GMX_MDLIB_FORCEREC_H
  39
  40 #include "gromacs/mdlib/force_flags.h"
  41 #include "gromacs/mdlib/genborn.h"
  42 #include "gromacs/mdlib/tgroup.h"
  43 #include "gromacs/mdlib/vsite.h"
  44 #include "gromacs/mdtypes/forcerec.h"
  45 #include "gromacs/timing/wallcycle.h"
  46
  47 struct t_commrec;
  48 struct t_fcdata;
  49 struct t_filenm;
  50
  51 /*! \brief Create a new forcerec structure */
  52 t_forcerec *mk_forcerec(void);
  53
  54 /*! \brief Print the contents of the forcerec to a file
  55  *
  56  * \param[in] fplog The log file to print to
  57  * \param[in] fr    The forcerec structure
  58  */
  59 void pr_forcerec(FILE *fplog, t_forcerec *fr);
  60
  61 /*! \brief Set the number of charge groups and atoms.
  62  *
  63  * The force calculation needs information on which atoms it
  64  * should do work.
  65  * \param[inout] fr                  The forcerec
  66  * \param[in]    ncg_home            Number of charge groups on this processor
  67  * \param[in]    ncg_force           Number of charge groups to compute force on
  68  * \param[in]    natoms_force        Number of atoms to compute force on
  69  * \param[in]    natoms_force_constr Number of atoms involved in constraints
  70  * \param[in]    natoms_f_novirsum   Number of atoms for which
  71  *                                   force is to be compute but no virial
  72  */
  73 void
  74 forcerec_set_ranges(t_forcerec *fr,
  75                     int ncg_home, int ncg_force,
  76                     int natoms_force,
  77                     int natoms_force_constr, int natoms_f_novirsum);
  78
  79 /*! \brief Initiate table constants
  80  *
  81  * Initializes the tables in the interaction constant data structure.
  82  * \param[in] fp   File for debugging output
  83  * \param[in] ic   Structure holding the table constant
  84  * \param[in] rtab The additional distance to add to tables
  85  */
  86 void init_interaction_const_tables(FILE                   *fp,
  87                                    interaction_const_t    *ic,
  88                                    real                    rtab);
  89
  90 /*! \brief Initialize forcerec structure.
  91  *
  92  * The Force rec struct must be created with mk_forcerec.
  93  * \param[in]  fplog       File for printing
  94  * \param[out] fr          The forcerec
  95  * \param[in]  fcd         Force constant data
  96  * \param[in]  ir          Inputrec structure
  97  * \param[in]  mtop        Molecular topology
  98  * \param[in]  cr          Communication structures
  99  * \param[in]  box         Simulation box
 100  * \param[in]  tabfn       Table potential file for non-bonded interactions
 101  * \param[in]  tabpfn      Table potential file for pair interactions
 102  * \param[in]  tabbfnm     Table potential files for bonded interactions
 103  * \param[in]  nbpu_opt    Nonbonded Processing Unit (GPU/CPU etc.)
 104  * \param[in]  bNoSolvOpt  Do not use solvent optimization
 105  * \param[in]  print_force Print forces for atoms with force >= print_force
 106  */
 107 void init_forcerec(FILE                   *fplog,
 108                    t_forcerec             *fr,
 109                    t_fcdata               *fcd,
 110                    const t_inputrec       *ir,
 111                    const gmx_mtop_t       *mtop,
 112                    const t_commrec        *cr,
 113                    matrix                  box,
 114                    const char             *tabfn,
 115                    const char             *tabpfn,
 116                    const t_filenm         *tabbfnm,
 117                    const char             *nbpu_opt,
 118                    gmx_bool                bNoSolvOpt,
 119                    real                    print_force);
 120
 121 /*! \brief Divide exclusions over threads
 122  *
 123  * Set the exclusion load for the local exclusions and possibly threads
 124  * \param[out] fr  The force record
 125  * \param[in]  top The topology
 126  */
 127 void forcerec_set_excl_load(t_forcerec           *fr,
 128                             const gmx_localtop_t *top);
 129
 130 /*! \brief Update parameters dependent on box
 131  *
 132  * Updates parameters in the forcerec that are time dependent
 133  * \param[out] fr  The force record
 134  * \param[in]  box The simulation box
 135  */
 136 void update_forcerec(t_forcerec *fr, matrix box);
 137
 138 #endif