src/gromacs/pbcutil/com.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,2020,2021, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \file
  36  * \brief
  37  * Helper methods to place particle COM in boxes.
  38  *
  39  * \author Paul Bauer <paul.bauer.q@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_pbcutil
  42  */
  43 #ifndef GMX_PBCUTIL_COM_H
  44 #define GMX_PBCUTIL_COM_H
  45
  46 #include <algorithm>
  47 #include <memory>
  48
  49 #include "gromacs/math/vec.h"
  50 #include "gromacs/utility/arrayref.h"
  51
  52 #include "pbcenums.h"
  53
  54 struct gmx_mtop_t;
  55 enum class PbcType : int;
  56 namespace gmx
  57 {
  58
  59 //! How COM shifting should be applied.
  60 enum class COMShiftType : int
  61 {
  62     Residue,
  63     Molecule,
  64     Count
  65 };
  66
  67 /*! \brief
  68  * Shift all coordinates.
  69  *
  70  * Shift coordinates by a previously calculated value.
  71  *
  72  * Can be used to e.g. place particles in a box.
  73  *
  74  * \param[in] shift Translation that should be applied.
  75  * \param[in] x Coordinates to translate.
  76  */
  77 void shiftAtoms(const RVec& shift, ArrayRef<RVec> x);
  78
  79 /*! \brief
  80  * Moves collection of atoms along the center of mass into a box.
  81  *
  82  * This ensures that the centre of mass (COM) of a molecule is placed
  83  * within a predefined coordinate space (usually a simulation box).
  84  *
  85  * \param[in]      pbcType      What kind of PBC are we handling today.
  86  * \param[in]      unitCellType Kind of unitcell used for the box.
  87  * \param[in]      centerType   How atoms should be centered.
  88  * \param[in]      box          The currently available box to place things into.
  89  * \param[in, out] x            View in coordinates to shift.
  90  * \param[in]      mtop         Topology with residue and molecule information.
  91  * \param[in]      comShiftType Whether residues or molecules are shifted.
  92  */
  93 void placeCoordinatesWithCOMInBox(const PbcType&    pbcType,
  94                                   UnitCellType      unitCellType,
  95                                   CenteringType     centerType,
  96                                   const matrix      box,
  97                                   ArrayRef<RVec>    x,
  98                                   const gmx_mtop_t& mtop,
  99                                   COMShiftType      comShiftType);
 100
 101 } // namespace gmx
 102
 103 #endif