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 by the GROMACS development team.
   7  * Copyright (c) 2018,2019,2020,2021, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 /*! \libinternal \file
  39  *
  40  * \brief
  41  * Declares functions to calculate both essential dynamics constraints
  42  * as well as flooding potentials and forces.
  43  *
  44  * \authors Bert de Groot <bgroot@gwdg.de>, Oliver Lange <oliver.lange@tum.de>,
  45  * Carsten Kutzner <ckutzne@gwdg.de>
  46  *
  47  * \inlibraryapi
  48  */
  49 #ifndef GMX_ESSENTIALDYNAMICS_EDSAM_H
  50 #define GMX_ESSENTIALDYNAMICS_EDSAM_H
  51
  52 #include <memory>
  53
  54 #include "gromacs/math/vectypes.h"
  55 #include "gromacs/utility/basedefinitions.h"
  56
  57 /*! \brief Abstract type for essential dynamics
  58  *
  59  * The main type is defined only in edsam.cpp
  60  */
  61 struct gmx_edsam;
  62 struct gmx_domdec_t;
  63 struct gmx_mtop_t;
  64 struct gmx_output_env_t;
  65 struct ObservablesHistory;
  66 struct t_commrec;
  67 struct t_filenm;
  68 struct t_inputrec;
  69 class t_state;
  70
  71 namespace gmx
  72 {
  73 enum class StartingBehavior;
  74 class Constraints;
  75 class EssentialDynamics
  76 {
  77 public:
  78     EssentialDynamics();
  79     ~EssentialDynamics();
  80
  81     /*! \brief Getter for working data
  82      *
  83      * This is needed while the module is still under
  84      * construction. */
  85     gmx_edsam* getLegacyED();
  86
  87 private:
  88     class Impl;
  89
  90     std::unique_ptr<Impl> impl_;
  91 };
  92 class MDLogger;
  93 } // namespace gmx
  94
  95 /*! \brief Applies essential dynamics constrains as defined in the .edi input file.
  96  *
  97  * \param ir                MD input parameter record.
  98  * \param step              Number of the time step.
  99  * \param cr                Data needed for MPI communication.
 100  * \param xs                The local positions on this processor.
 101  * \param v                 The local velocities.
 102  * \param box               The simulation box.
 103  * \param ed                The essential dynamics data.
 104  */
 105 void do_edsam(const t_inputrec* ir,
 106               int64_t           step,
 107               const t_commrec*  cr,
 108               rvec              xs[],
 109               rvec              v[],
 110               const matrix      box,
 111               gmx_edsam*        ed);
 112
 113
 114 /*! \brief Initializes the essential dynamics and flooding module.
 115  *
 116  * \param mdlog             Logger.
 117  * \param ediFileName       Essential dynamics input file.
 118  * \param edoFileName       Output file for essential dynamics data.
 119  * \param mtop              Molecular topology.
 120  * \param ir                MD input parameter record.
 121  * \param cr                Data needed for MPI communication.
 122  * \param constr            Data structure keeping the constraint information.
 123  * \param globalState       The global state, only used on the master rank.
 124  * \param oh                The observables history container.
 125  * \param oenv              The output environment information.
 126  * \param startingBehavior  Describes whether this is a restart appending to output files
 127  *
 128  * \returns                 A pointer to the ED data structure.
 129  */
 130 std::unique_ptr<gmx::EssentialDynamics> init_edsam(const gmx::MDLogger&    mdlog,
 131                                                    const char*             ediFileName,
 132                                                    const char*             edoFileName,
 133                                                    const gmx_mtop_t*       mtop,
 134                                                    const t_inputrec*       ir,
 135                                                    const t_commrec*        cr,
 136                                                    gmx::Constraints*       constr,
 137                                                    const t_state*          globalState,
 138                                                    ObservablesHistory*     oh,
 139                                                    const gmx_output_env_t* oenv,
 140                                                    gmx::StartingBehavior   startingBehavior);
 141
 142 /*! \brief Make a selection of the home atoms for the ED groups.
 143  *
 144  * Should be called at every domain decomposition.
 145  *
 146  * \param dd                Domain decomposition data.
 147  * \param ed                Essential dynamics and flooding data.
 148  */
 149 void dd_make_local_ed_indices(gmx_domdec_t* dd, gmx_edsam* ed);
 150
 151
 152 /*! \brief Evaluate the flooding potential(s) and forces as requested in the .edi input file.
 153  *
 154  * \param cr                Data needed for MPI communication.
 155  * \param ir                MD input parameter record.
 156  * \param x                 Positions on the local processor.
 157  * \param force             Forcefield forces to which the flooding forces are added.
 158  * \param ed                The essential dynamics data.
 159  * \param box               The simulation box.
 160  * \param step              Number of the time step.
 161  * \param bNS               Are we in a neighbor searching step?
 162  */
 163 void do_flood(const t_commrec*  cr,
 164               const t_inputrec* ir,
 165               const rvec        x[],
 166               rvec              force[],
 167               gmx_edsam*        ed,
 168               const matrix      box,
 169               int64_t           step,
 170               gmx_bool          bNS);
 171
 172 #endif