api/nblib/box.h

   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 /*! \inpublicapi \file
  36  * \brief
  37  * Implements nblib simulation box
  38  *
  39  * \author Victor Holanda <victor.holanda@cscs.ch>
  40  * \author Joe Jordan <ejjordan@kth.se>
  41  * \author Prashanth Kanduri <kanduri@cscs.ch>
  42  * \author Sebastian Keller <keller@cscs.ch>
  43  */
  44 #ifndef NBLIB_BOX_H
  45 #define NBLIB_BOX_H
  46
  47 #include "nblib/basicdefinitions.h"
  48
  49 namespace nblib
  50 {
  51
  52 /*! \brief Box specifies the size of periodic simulation systems
  53  *
  54  * \inpublicapi
  55  * \ingroup nblib
  56  *
  57  * Currently only cubic and rectangular boxes are supported.
  58  *
  59  */
  60 class Box final
  61 {
  62 public:
  63     using LegacyMatrix = matrix;
  64
  65     //! Construct a cubic box.
  66     explicit Box(real l);
  67
  68     //! Construct a rectangular box.
  69     Box(real x, real y, real z);
  70
  71     //! Return the full matrix that specifies the box. Used for gromacs setup code.
  72     [[nodiscard]] LegacyMatrix const& legacyMatrix() const { return legacyMatrix_; }
  73
  74 private:
  75     LegacyMatrix legacyMatrix_;
  76 };
  77
  78 } // namespace nblib
  79 #endif // NBLIB_BOX_H