src/gromacs/essentialdynamics/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,2014,2015,2016,2017,2018, 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 /*! \libinternal \file
  38  *
  39  * \brief
  40  * Declares functions to calculate both essential dynamics constraints
  41  * as well as flooding potentials and forces.
  42  *
  43  * \authors Bert de Groot <bgroot@gwdg.de>, Oliver Lange <oliver.lange@tum.de>,
  44  * Carsten Kutzner <ckutzne@gwdg.de>
  45  *
  46  * \inlibraryapi
  47  */
  48 #ifndef GMX_ESSENTIALDYNAMICS_EDSAM_H
  49 #define GMX_ESSENTIALDYNAMICS_EDSAM_H
  50
  51 #include "gromacs/math/vectypes.h"
  52 #include "gromacs/utility/basedefinitions.h"
  53
  54
  55 /*! \brief Abstract type for essential dynamics
  56  *
  57  * The main type is defined only in edsam.cpp
  58  */
  59 typedef struct gmx_edsam *gmx_edsam_t;
  60
  61 struct gmx_domdec_t;
  62 struct gmx_mtop_t;
  63 struct gmx_output_env_t;
  64 struct ObservablesHistory;
  65 struct t_commrec;
  66 struct t_filenm;
  67 struct t_inputrec;
  68 class t_state;
  69
  70 namespace gmx
  71 {
  72 class Constraints;
  73 }
  74
  75 /*! \brief Applies essential dynamics constrains as defined in the .edi input file.
  76  *
  77  * \param ir                MD input parameter record.
  78  * \param step              Number of the time step.
  79  * \param cr                Data needed for MPI communication.
  80  * \param xs                The local positions on this processor.
  81  * \param v                 The local velocities.
  82  * \param box               The simulation box.
  83  * \param ed                The essential dynamics data.
  84  */
  85 void do_edsam(const t_inputrec *ir, gmx_int64_t step,
  86               const t_commrec *cr, rvec xs[], rvec v[], matrix box, gmx_edsam *ed);
  87
  88
  89 /*! \brief Initializes the essential dynamics and flooding module.
  90  *
  91  * \param ediFileName       Essential dynamics input file.
  92  * \param edoFileName       Output file for essential dynamics data.
  93  * \param mtop              Molecular topology.
  94  * \param ir                MD input parameter record.
  95  * \param cr                Data needed for MPI communication.
  96  * \param constr            Data structure keeping the constraint information.
  97  * \param globalState       The global state, only used on the master rank.
  98  * \param oh                The observables history container.
  99  * \param oenv              The output environment information.
 100  * \param bAppend           Append to existing output files?
 101  *
 102  * \returns                 A pointer to the ED data structure.
 103  */
 104 gmx_edsam_t init_edsam(
 105         const char             *ediFileName,
 106         const char             *edoFileName,
 107         const gmx_mtop_t       *mtop,
 108         const t_inputrec       *ir,
 109         const t_commrec        *cr,
 110         gmx::Constraints       *constr,
 111         const t_state          *globalState,
 112         ObservablesHistory     *oh,
 113         const gmx_output_env_t *oenv,
 114         gmx_bool                bAppend);
 115
 116 /*! \brief Make a selection of the home atoms for the ED groups.
 117  *
 118  * Should be called at every domain decomposition.
 119  *
 120  * \param dd                Domain decomposition data.
 121  * \param ed                Essential dynamics and flooding data.
 122  */
 123 void dd_make_local_ed_indices(gmx_domdec_t *dd, gmx_edsam_t ed);
 124
 125
 126 /*! \brief Evaluate the flooding potential(s) and forces as requested in the .edi input file.
 127  *
 128  * \param cr                Data needed for MPI communication.
 129  * \param ir                MD input parameter record.
 130  * \param x                 Positions on the local processor.
 131  * \param force             Forcefield forces to which the flooding forces are added.
 132  * \param ed                The essential dynamics data.
 133  * \param box               The simulation box.
 134  * \param step              Number of the time step.
 135  * \param bNS               Are we in a neighbor searching step?
 136  */
 137 void do_flood(const t_commrec  *cr,
 138               const t_inputrec *ir,
 139               const rvec        x[],
 140               rvec              force[],
 141               const gmx_edsam  *ed,
 142               matrix            box,
 143               gmx_int64_t       step,
 144               gmx_bool          bNS);
 145
 146 /*! \brief Clean up
 147  *
 148  * \param ed                The essential dynamics data
 149  */
 150 void done_ed(gmx_edsam_t *ed);
 151
 152 #endif