src/gromacs/mdlib/constr.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  * \brief Declares interface to constraint code.
  39  *
  40  * \author Berk Hess <hess@kth.se>
  41  * \author Mark Abraham <mark.j.abraham@gmail.com>
  42  * \ingroup module_mdlib
  43  * \inlibraryapi
  44  */
  45
  46 #ifndef GMX_MDLIB_CONSTR_H
  47 #define GMX_MDLIB_CONSTR_H
  48
  49 #include <cstdio>
  50
  51 #include "gromacs/math/vectypes.h"
  52 #include "gromacs/topology/idef.h"
  53 #include "gromacs/utility/arrayref.h"
  54 #include "gromacs/utility/basedefinitions.h"
  55 #include "gromacs/utility/classhelpers.h"
  56 #include "gromacs/utility/gmxassert.h"
  57 #include "gromacs/utility/real.h"
  58
  59 struct gmx_edsam;
  60 struct gmx_localtop_t;
  61 struct gmx_mtop_t;
  62 struct gmx_multisim_t;
  63 struct gmx_wallcycle;
  64 struct t_blocka;
  65 struct t_commrec;
  66 struct t_ilist;
  67 struct t_inputrec;
  68 struct t_mdatoms;
  69 struct t_nrnb;
  70 struct t_pbc;
  71 class t_state;
  72
  73 namespace gmx
  74 {
  75
  76 //! Describes supported flavours of constrained updates.
  77 enum class ConstraintVariable : int
  78 {
  79     Positions,         /* Constrain positions (mass weighted)             */
  80     Velocities,        /* Constrain velocities (mass weighted)            */
  81     Derivative,        /* Constrain a derivative (mass weighted),         *
  82                         * for instance velocity or acceleration,          *
  83                         * constraint virial can not be calculated.        */
  84     Deriv_FlexCon,     /* As Derivative, but only output flex. con.       */
  85     Force,             /* Constrain forces (non mass-weighted)            */
  86     // TODO What does this do? Improve the comment.
  87     ForceDispl         /* Like Force, but free particles will have mass
  88                         * 1 and frozen particles mass 0                   */
  89 };
  90
  91 /*! \libinternal
  92  * \brief Handles constraints */
  93 class Constraints
  94 {
  95     private:
  96         /*! \brief Constructor
  97          *
  98          * Private to enforce use of makeConstraints() factory
  99          * function. */
 100         Constraints(const gmx_mtop_t     &mtop,
 101                     const t_inputrec     &ir,
 102                     FILE                 *log,
 103                     const t_mdatoms      &md,
 104                     const t_commrec      *cr,
 105                     const gmx_multisim_t &ms,
 106                     t_nrnb               *nrnb,
 107                     gmx_wallcycle        *wcycle,
 108                     bool                  pbcHandlingRequired,
 109                     int                   numConstraints,
 110                     int                   numSettles);
 111     public:
 112         /*! \brief This member type helps implement a factory
 113          * function, because its objects can access the private
 114          * constructor. */
 115         struct CreationHelper;
 116
 117         ~Constraints();
 118
 119         /*! \brief Returns the total number of flexible constraints in the system. */
 120         int numFlexibleConstraints() const;
 121
 122         /*! \brief Set up all the local constraints for the domain.
 123          *
 124          * \todo Make this a callback that is called automatically
 125          * once a new domain has been made. */
 126         void setConstraints(const gmx_localtop_t &top,
 127                             const t_mdatoms      &md);
 128
 129         /*! \brief Applies constraints to coordinates.
 130          *
 131          * When econq=ConstraintVariable::Positions constrains
 132          * coordinates xprime using th directions in x, min_proj is
 133          * not used.
 134          *
 135          * When econq=ConstraintVariable::Derivative, calculates the
 136          * components xprime in the constraint directions and
 137          * subtracts these components from min_proj.  So when
 138          * min_proj=xprime, the constraint components are projected
 139          * out.
 140          *
 141          * When econq=ConstraintVariable::Deriv_FlexCon, the same is
 142          * done as with ConstraintVariable::Derivative, but only the
 143          * components of the flexible constraints are stored.
 144          *
 145          * delta_step is used for determining the constraint reference lengths
 146          * when lenA != lenB or will the pull code with a pulling rate.
 147          * step + delta_step is the step at which the final configuration
 148          * is meant to be; for update delta_step = 1.
 149          *
 150          * step_scaling can be used to update coordinates based on the time
 151          * step multiplied by this factor. Thus, normally 1.0 is passed. The
 152          * SD1 integrator uses 0.5 in one of its calls, to correct positions
 153          * for half a step of changed velocities.
 154          *
 155          * If v!=NULL also constrain v by adding the constraint corrections / dt.
 156          *
 157          * If vir!=NULL calculate the constraint virial.
 158          *
 159          * Return whether the application of constraints succeeded without error.
 160          */
 161         bool apply(bool                  bLog,
 162                    bool                  bEner,
 163                    int64_t               step,
 164                    int                   delta_step,
 165                    real                  step_scaling,
 166                    rvec                 *x,
 167                    rvec                 *xprime,
 168                    rvec                 *min_proj,
 169                    matrix                box,
 170                    real                  lambda,
 171                    real                 *dvdlambda,
 172                    rvec                 *v,
 173                    tensor               *vir,
 174                    ConstraintVariable    econq);
 175         //! Links the essentialdynamics and constraint code.
 176         void saveEdsamPointer(gmx_edsam *ed);
 177         //! Getter for use by domain decomposition.
 178         const ArrayRef<const t_blocka> atom2constraints_moltype() const;
 179         //! Getter for use by domain decomposition.
 180         int *const* atom2settle_moltype() const;
 181
 182         /*! \brief Return the data for reduction for determining
 183          * constraint RMS relative deviations, or an empty ArrayRef
 184          * when not supported for any active constraints. */
 185         ArrayRef<real> rmsdData() const;
 186         /*! \brief Return the RMSD of the constraints when available. */
 187         real rmsd() const;
 188
 189     private:
 190         //! Implementation type.
 191         class Impl;
 192         //! Implementation object.
 193         PrivateImplPointer<Impl> impl_;
 194 };
 195
 196 /*! \brief Generate a fatal error because of too many LINCS/SETTLE warnings. */
 197 [[ noreturn ]] void too_many_constraint_warnings(int eConstrAlg, int warncount);
 198
 199 /*! \brief Returns whether constraint with parameter \p iparamsIndex is a flexible constraint */
 200 static inline bool isConstraintFlexible(const t_iparams *iparams,
 201                                         int              iparamsIndex)
 202 {
 203     GMX_ASSERT(iparams != nullptr, "Need a valid iparams array");
 204
 205     return (iparams[iparamsIndex].constr.dA == 0 &&
 206             iparams[iparamsIndex].constr.dB == 0);
 207 };
 208
 209 /* The at2con t_blocka struct returned by the routines below
 210  * contains a list of constraints per atom.
 211  * The F_CONSTRNC constraints in this structure number consecutively
 212  * after the F_CONSTR constraints.
 213  */
 214
 215 /*! \brief Tells make_at2con how to treat flexible constraints */
 216 enum class FlexibleConstraintTreatment
 217 {
 218     Include, //!< Include all flexible constraints
 219     Exclude  //!< Exclude all flexible constraints
 220 };
 221
 222 /*! \brief Returns the flexible constraint treatment depending on whether the integrator is dynamic */
 223 FlexibleConstraintTreatment
 224 flexibleConstraintTreatment(bool haveDynamicsIntegrator);
 225
 226 /*! \brief Returns a block struct to go from atoms to constraints
 227  *
 228  * The block struct will contain constraint indices with lower indices
 229  * directly matching the order in F_CONSTR and higher indices matching
 230  * the order in F_CONSTRNC offset by the number of constraints in F_CONSTR.
 231  *
 232  * \param[in]  numAtoms  The number of atoms to construct the list for
 233  * \param[in]  ilist     Interaction list, size F_NRE
 234  * \param[in]  iparams   Interaction parameters, can be null when flexibleConstraintTreatment=Include
 235  * \param[in]  flexibleConstraintTreatment  The flexible constraint treatment, see enum above
 236  * \returns a block struct with all constraints for each atom
 237  */
 238 t_blocka make_at2con(int                          numAtoms,
 239                      const t_ilist               *ilist,
 240                      const t_iparams             *iparams,
 241                      FlexibleConstraintTreatment  flexibleConstraintTreatment);
 242
 243 /*! \brief Returns an array of atom to constraints lists for the moltypes */
 244 const t_blocka *atom2constraints_moltype(const Constraints *constr);
 245
 246 //! Return the number of flexible constraints in the \c ilist and \c iparams.
 247 int countFlexibleConstraints(const t_ilist   *ilist,
 248                              const t_iparams *iparams);
 249
 250 /*! \brief Macro for getting the constraint iatoms for a constraint number con
 251  * which comes from a list where F_CONSTR and F_CONSTRNC constraints
 252  * are concatenated. */
 253 #define constr_iatomptr(nconstr, iatom_constr, iatom_constrnc, con) ((con) < (nconstr) ? (iatom_constr)+(con)*3 : (iatom_constrnc)+((con)-(nconstr))*3)
 254
 255 /*! \brief Returns whether there are inter charge group constraints */
 256 bool inter_charge_group_constraints(const gmx_mtop_t &mtop);
 257
 258 /*! \brief Returns whether there are inter charge group settles */
 259 bool inter_charge_group_settles(const gmx_mtop_t &mtop);
 260
 261 }  // namespace gmx
 262
 263 #endif