src/gromacs/math/coordinatetransformation.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,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 /*! \libinternal \file
  36  * \brief Declares coordinate transformation routines.
  37  *
  38  * \author Christian Blau <blau@kth.se>
  39  *
  40  * \inlibraryapi
  41  * \ingroup module_math
  42  */
  43 #ifndef GMX_MATH_COORDINATETRANSFORMATION_H
  44 #define GMX_MATH_COORDINATETRANSFORMATION_H
  45
  46 #include "gromacs/math/vectypes.h"
  47 #include "gromacs/utility/classhelpers.h"
  48
  49 namespace gmx
  50 {
  51
  52 template<typename>
  53 class ArrayRef;
  54 class ScaleCoordinates
  55 {
  56 public:
  57     //! Set up coordinate scaling with the scaling factor in each dimension
  58     explicit ScaleCoordinates(const RVec& scale);
  59     ~ScaleCoordinates();
  60
  61     //! Copy constructor
  62     ScaleCoordinates(const ScaleCoordinates& other);
  63     //! Copy assignment
  64     ScaleCoordinates& operator=(const ScaleCoordinates& other);
  65     //! Move constructor
  66     ScaleCoordinates(ScaleCoordinates&& other) noexcept;
  67     //! Move assignment
  68     ScaleCoordinates& operator=(ScaleCoordinates&& other) noexcept;
  69
  70     /*! \brief Perform a coordinate transformation on input coordinates.
  71      * \param[in] coordinates to be transformed
  72      */
  73     void operator()(ArrayRef<RVec> coordinates) const;
  74     /*! \brief Apply the inverse scale to coordinates, ignoring dimensions for which scale is zero.
  75      * \param[in] coordinates to be transformed
  76      */
  77     void inverseIgnoringZeroScale(ArrayRef<RVec> coordinates) const;
  78
  79 private:
  80     class Impl;
  81     PrivateImplPointer<Impl> impl_;
  82 };
  83
  84 /*! \libinternal \brief Transform coordinates in three dimensions by first
  85  * translating, then scaling them.
  86  */
  87 class TranslateAndScale
  88 {
  89 public:
  90     /*! \brief Construct a three-dimensional coordinate transformation.
  91      * Coordinates are first translated, then scaled.
  92      * \param[in] translation to be performed on the coordinates
  93      * \param[in] scale to be applied to the coordinates
  94      */
  95     TranslateAndScale(const RVec& scale, const RVec& translation);
  96
  97     ~TranslateAndScale();
  98
  99     //! Copy constructor
 100     TranslateAndScale(const TranslateAndScale& other);
 101     //! Copy assignment
 102     TranslateAndScale& operator=(const TranslateAndScale& other);
 103     //! Move constructor
 104     TranslateAndScale(TranslateAndScale&& other) noexcept;
 105     //! Move assignment
 106     TranslateAndScale& operator=(TranslateAndScale&& other) noexcept;
 107
 108     /*! \brief Perform a coordinate transformation on input coordinates.
 109      * \param[in] coordinates to be transformed
 110      */
 111     void operator()(ArrayRef<RVec> coordinates) const;
 112
 113     /*! \brief Returns the scaling operation, discarding the translation.
 114      */
 115     ScaleCoordinates scaleOperationOnly() const;
 116
 117 private:
 118     class Impl;
 119     PrivateImplPointer<Impl> impl_;
 120 };
 121 } // namespace gmx
 122 #endif // CoordinateTransformation