src/gromacs/mdlib/boxdeformation.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,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 interface to box deformation code.
  37  *
  38  * \author Mark Abraham <mark.j.abraham@gmail.com>
  39  * \ingroup module_mdlib
  40  * \inlibraryapi
  41  */
  42
  43 #ifndef GMX_MDRUN_BOXDEFORMATION_H
  44 #define GMX_MDRUN_BOXDEFORMATION_H
  45
  46 #include <memory>
  47
  48 #include "gromacs/math/vectypes.h"
  49 #include "gromacs/utility/arrayref.h"
  50 #include "gromacs/utility/basedefinitions.h"
  51 #include "gromacs/utility/classhelpers.h"
  52 #include "gromacs/utility/gmxmpi.h"
  53
  54 struct t_inputrec;
  55 enum class DDRole;
  56 enum class NumRanks;
  57
  58 namespace gmx
  59 {
  60
  61 class BoxDeformation
  62 {
  63 public:
  64     //! Trivial constructor.
  65     BoxDeformation(double timeStep, int64_t initialStep, const tensor& deformationTensor, const matrix& referenceBox);
  66
  67     //! Deform \c x and \c box at this \c step;
  68     void apply(ArrayRef<RVec> x, matrix box, int64_t step);
  69
  70 private:
  71     //! The integrator time step.
  72     double timeStep_;
  73     //! The initial step number (from the .tpr, which permits checkpointing to work correctly).
  74     int64_t initialStep_;
  75     //! Non-zero elements provide a scaling factor for deformation in that box dimension.
  76     tensor deformationTensor_;
  77     //! The initial box, ie from the .tpr file.
  78     matrix referenceBox_;
  79
  80     GMX_DISALLOW_COPY_AND_ASSIGN(BoxDeformation);
  81 };
  82
  83 /*! \brief Factory function for box deformation module.
  84  *
  85  * If the \c inputrec specifies the use of box deformation during the
  86  * update phase, communicates the \c initialBox from SIMMASTER to
  87  * other ranks, and constructs and returns an object to manage that
  88  * update.
  89  *
  90  * \throws NotImplementedError if the \c inputrec specifies an
  91  * unsupported combination.
  92  */
  93 std::unique_ptr<BoxDeformation> prepareBoxDeformation(const matrix&     initialBox,
  94                                                       DDRole            ddRole,
  95                                                       NumRanks          numRanks,
  96                                                       MPI_Comm          communicator,
  97                                                       const t_inputrec& inputrec);
  98
  99 } // namespace gmx
 100
 101 #endif