src/gromacs/mdrun/shellfc.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-2008, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2016,2017,2018,2019, 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_SHELLFC_H
  38 #define GMX_MDLIB_SHELLFC_H
  39
  40 #include <cstdio>
  41
  42 #include "gromacs/math/arrayrefwithpadding.h"
  43 #include "gromacs/mdlib/vsite.h"
  44 #include "gromacs/timing/wallcycle.h"
  45 #include "gromacs/topology/atoms.h"
  46
  47 class DDBalanceRegionHandler;
  48 struct gmx_enerdata_t;
  49 struct gmx_enfrot;
  50 struct gmx_multisim_t;
  51 struct gmx_shellfc_t;
  52 struct gmx_mtop_t;
  53 class history_t;
  54 struct pull_t;
  55 struct t_forcerec;
  56 struct t_fcdata;
  57 struct t_graph;
  58 struct t_inputrec;
  59 class t_state;
  60
  61 namespace gmx
  62 {
  63 class Constraints;
  64 class ImdSession;
  65 class MdrunScheduleWorkload;
  66 } // namespace gmx
  67
  68 /* Initialization function, also predicts the initial shell postions.
  69  */
  70 gmx_shellfc_t* init_shell_flexcon(FILE*             fplog,
  71                                   const gmx_mtop_t* mtop,
  72                                   int               nflexcon,
  73                                   int               nstcalcenergy,
  74                                   bool              usingDomainDecomposition);
  75
  76 /* Optimize shell positions */
  77 void relax_shell_flexcon(FILE*                               log,
  78                          const t_commrec*                    cr,
  79                          const gmx_multisim_t*               ms,
  80                          gmx_bool                            bVerbose,
  81                          gmx_enfrot*                         enforcedRotation,
  82                          int64_t                             mdstep,
  83                          const t_inputrec*                   inputrec,
  84                          gmx::ImdSession*                    imdSession,
  85                          pull_t*                             pull_work,
  86                          gmx_bool                            bDoNS,
  87                          int                                 force_flags,
  88                          const gmx_localtop_t*               top,
  89                          gmx::Constraints*                   constr,
  90                          gmx_enerdata_t*                     enerd,
  91                          t_fcdata*                           fcd,
  92                          int                                 natoms,
  93                          gmx::ArrayRefWithPadding<gmx::RVec> x,
  94                          gmx::ArrayRefWithPadding<gmx::RVec> v,
  95                          const matrix                        box,
  96                          gmx::ArrayRef<real>                 lambda,
  97                          history_t*                          hist,
  98                          gmx::ArrayRefWithPadding<gmx::RVec> f,
  99                          tensor                              force_vir,
 100                          const t_mdatoms*                    md,
 101                          t_nrnb*                             nrnb,
 102                          gmx_wallcycle_t                     wcycle,
 103                          t_graph*                            graph,
 104                          gmx_shellfc_t*                      shfc,
 105                          t_forcerec*                         fr,
 106                          gmx::MdrunScheduleWorkload*         runScheduleWork,
 107                          double                              t,
 108                          rvec                                mu_tot,
 109                          const gmx_vsite_t*                  vsite,
 110                          const DDBalanceRegionHandler&       ddBalanceRegionHandler);
 111
 112 /* Print some final output */
 113 void done_shellfc(FILE* fplog, gmx_shellfc_t* shellfc, int64_t numSteps);
 114
 115 /*! \brief Count the different particle types in a system
 116  *
 117  * Routine prints a warning to stderr in case an unknown particle type
 118  * is encountered.
 119  * \param[in]  fplog Print what we have found if not NULL
 120  * \param[in]  mtop  Molecular topology.
 121  * \returns Array holding the number of particles of a type
 122  */
 123 std::array<int, eptNR> countPtypes(FILE* fplog, const gmx_mtop_t* mtop);
 124
 125 #endif