src/gromacs/coordinateio/outputadapters/setbox.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019, 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  * Declares gmx::SetBox.
  38  *
  39  * \author Paul Bauer <paul.bauer.q@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_coordinateio
  42  */
  43 #ifndef GMX_COORDINATEIO_SETBOX_H
  44 #define GMX_COORDINATEIO_SETBOX_H
  45
  46 #include <memory>
  47
  48 #include "gromacs/coordinateio/ioutputadapter.h"
  49 #include "gromacs/math/vec.h"
  50 #include "gromacs/trajectory/trajectoryframe.h"
  51
  52 namespace gmx
  53 {
  54
  55 /*!\brief
  56  * Allows changing box information when writing a coordinate file.
  57  *
  58  * \inpublicapi
  59  * \ingroup module_coordinateio
  60  */
  61 class SetBox : public IOutputAdapter
  62 {
  63 public:
  64     /*! \brief
  65      * Construct SetBox object with a new user defined box.
  66      */
  67     explicit SetBox(const matrix box) { copy_mat(box, box_); }
  68     /*! \brief
  69      *  Move constructor for SetBox.
  70      */
  71     SetBox(SetBox&& old) noexcept { copy_mat(old.box_, box_); }
  72
  73     ~SetBox() override { clear_mat(box_); }
  74
  75     /*! \brief
  76      * Change coordinate frame information for output.
  77      *
  78      * In this case, box information is added to the \p t_trxframe object
  79      * depending on the user input.
  80      *
  81      * \param[in] input Coordinate frame to be modified later.
  82      */
  83     void processFrame(int /*framenumner*/, t_trxframe* input) override
  84     {
  85         copy_mat(box_, input->box);
  86     }
  87
  88     void checkAbilityDependencies(unsigned long /* abilities */) const override {}
  89
  90 private:
  91     //! New box information from the user.
  92     matrix box_;
  93 };
  94
  95 //! Smart pointer to manage the object.
  96 using SetBoxPointer = std::unique_ptr<SetBox>;
  97
  98 } // namespace gmx
  99
 100 #endif