src/gromacs/legacyheaders/edsam.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, 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
  38 #ifndef _edsam_h
  39 #define _edsam_h
  40
  41 #include "typedefs.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 void do_edsam(t_inputrec *ir, gmx_int64_t step,
  48               t_commrec *cr, rvec xs[], rvec v[], matrix box, gmx_edsam_t ed);
  49 /* Essential dynamics constraints, called from constrain() */
  50
  51 gmx_edsam_t ed_open(int natoms, edsamstate_t *EDstate, int nfile, const t_filenm fnm[],
  52                     unsigned long Flags, const output_env_t oenv, t_commrec *cr);
  53 /* Sets the ED input/output filenames, opens output file */
  54
  55 void init_edsam(gmx_mtop_t *mtop, t_inputrec *ir, t_commrec *cr,
  56                 gmx_edsam_t ed, rvec x[], matrix box, edsamstate_t *edsamstate);
  57 /* Init routine for ED and flooding. Calls init_edi in a loop for every .edi-cycle
  58  * contained in the input file, creates a NULL terminated list of t_edpar structures */
  59
  60 void dd_make_local_ed_indices(gmx_domdec_t *dd, gmx_edsam_t ed);
  61 /* Make a selection of the home atoms for the ED groups.
  62  * Should be called at every domain decomposition. */
  63
  64 void do_flood(t_commrec *cr, t_inputrec *ir, rvec x[], rvec force[], gmx_edsam_t ed,
  65               matrix box, gmx_int64_t step, gmx_bool bNS);
  66 /* Flooding - called from do_force() */
  67
  68 #ifdef __cplusplus
  69 }
  70 #endif
  71
  72 #endif  /* _edsam_h */