src/gromacs/mdlib/membed.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2014,2015,2017,2018 by the GROMACS development team.
   5  * Copyright (c) 2019,2020,2021, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36
  37 #ifndef GMX_MDLIB_MEMBED_H
  38 #define GMX_MDLIB_MEMBED_H
  39
  40 #include <cstdio>
  41
  42 #include "gromacs/math/vectypes.h"
  43 #include "gromacs/utility/real.h"
  44
  45 struct gmx_membed_t;
  46 struct gmx_mtop_t;
  47 struct t_commrec;
  48 struct t_filenm;
  49 struct t_inputrec;
  50 class t_state;
  51
  52 /* initialisation of membed code */
  53 gmx_membed_t* init_membed(FILE*          fplog,
  54                           int            nfile,
  55                           const t_filenm fnm[],
  56                           gmx_mtop_t*    mtop,
  57                           t_inputrec*    inputrec,
  58                           t_state*       state,
  59                           t_commrec*     cr,
  60                           real*          cpt);
  61
  62 /* rescaling the coordinates voor de membed code */
  63 void rescale_membed(int step_rel, gmx_membed_t* membed, rvec* x);
  64
  65 void free_membed(gmx_membed_t* membed);
  66
  67 #endif