api/nblib/pbc.hpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020, 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 /*! \internal \file
  36  * \brief
  37  * Implements a RAII encapsulation for PbcAiuc
  38  * note this is a header implementation to make inlining easier if needed
  39  *
  40  * \author Victor Holanda <victor.holanda@cscs.ch>
  41  * \author Joe Jordan <ejjordan@kth.se>
  42  * \author Prashanth Kanduri <kanduri@cscs.ch>
  43  * \author Sebastian Keller <keller@cscs.ch>
  44  * \author Artem Zhmurov <zhmurov@gmail.com>
  45  */
  46 #ifndef NBLIB_PBC_HPP
  47 #define NBLIB_PBC_HPP
  48
  49 #include "nblib/box.h"
  50 #include "gromacs/math/vec.h"
  51 #include "gromacs/pbcutil/pbc_aiuc.h"
  52
  53 namespace nblib
  54 {
  55
  56 /*! \brief life-time manager for PbcAiuc
  57  *
  58  */
  59 class PbcHolder
  60 {
  61 public:
  62     //! \brief ctor
  63     explicit PbcHolder(const Box& box)
  64     {
  65         setPbcAiuc(3, box.legacyMatrix(), &m_pbc);
  66     }
  67
  68     //! \brief calculate pbc-aware r1-r2
  69     inline void dxAiuc(const rvec& r1, const rvec& r2, rvec dr) const
  70     {
  71         ::pbcDxAiuc(m_pbc, r1, r2, dr);
  72     }
  73
  74 private:
  75    PbcAiuc m_pbc;
  76 };
  77
  78 /*! \brief dummy class used to turn off Pbc in listed forces
  79  *
  80  */
  81 class NoPbc
  82 {
  83 public:
  84
  85     //! \brief calculate r1-r2, ignore pbc
  86     inline void dxAiuc(const rvec& r1, const rvec& r2, rvec dr) const
  87     {
  88         rvec_sub(r1, r2, dr);
  89     }
  90 };
  91
  92 } // namespace nblib
  93 #endif // NBLIB_PBC_HPP