src/gromacs/coordinateio/outputadapters/setatoms.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,2020,2021, 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::SetAtoms.
  38  *
  39  * \author Paul Bauer <paul.bauer.q@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_coordinateio
  42  */
  43 #ifndef GMX_COORDINATEIO_SETATOMS_H
  44 #define GMX_COORDINATEIO_SETATOMS_H
  45
  46 #include <algorithm>
  47
  48 #include "gromacs/coordinateio/ioutputadapter.h"
  49 #include "gromacs/topology/atoms.h"
  50 #include "gromacs/utility/gmxassert.h"
  51
  52 namespace gmx
  53 {
  54
  55 /*!\brief
  56  * SetAtoms class controls availability of atoms data.
  57  *
  58  * This modules allows the user to specify if a coordinate frame
  59  * should contain the t_atoms data structure or not, and sets it in the
  60  * new coordinate frame from either the current topology or from
  61  * the data in the coordinate frame. The data is later used to identify
  62  * if certain output file types are legal or not.
  63  *
  64  * \inpublicapi
  65  * \ingroup module_coordinateio
  66  *
  67  */
  68 class SetAtoms : public IOutputAdapter
  69 {
  70 public:
  71     /*! \brief
  72      * Construct SetAtoms object with choice for boolean value
  73      * for availability of the t_atoms struct.
  74      *
  75      * Can be used to initialize SetAtoms from outside of trajectoryanalysis
  76      * framework.
  77      */
  78     explicit SetAtoms(ChangeAtomsType atomFlag, AtomsDataPtr inputAtoms) :
  79         atomFlag_(atomFlag), haveStructureFileAtoms_(false), atoms_(std::move(inputAtoms))
  80     {
  81         if (atoms_ != nullptr)
  82         {
  83             haveStructureFileAtoms_ = true;
  84         }
  85         if (atomFlag_ == ChangeAtomsType::Never)
  86         {
  87             moduleRequirements_ = CoordinateFileFlags::Base;
  88         }
  89         else
  90         {
  91             moduleRequirements_ = CoordinateFileFlags::RequireAtomInformation;
  92         }
  93     }
  94     /*! \brief
  95      *  Move constructor for SetAtoms.
  96      */
  97     SetAtoms(SetAtoms&& old) noexcept :
  98         atomFlag_(old.atomFlag_),
  99         haveStructureFileAtoms_(old.haveStructureFileAtoms_),
 100         atoms_(std::move(old.atoms_))
 101     {
 102     }
 103
 104     ~SetAtoms() override {}
 105
 106     /*! \brief
 107      * Change coordinate frame information for output.
 108      *
 109      * Changes the frame t_atoms struct according to user choice and
 110      * availability.
 111      *
 112      * \param[in] input Coordinate frame to be modified later.
 113      */
 114     void processFrame(int /*framenumber*/, t_trxframe* input) override;
 115
 116     void checkAbilityDependencies(unsigned long abilities) const override;
 117
 118 private:
 119     //! Local function to check that we have a proper t_atoms struct available.
 120     bool haveStructureFileAtoms() const { return haveStructureFileAtoms_; }
 121     /*! \brief
 122      *  Checking if t_trxframe has the atom information saved within.
 123      *
 124      *  \param[in] input t_trxframe before we start modifying it.
 125      */
 126     static bool haveFrameAtoms(const t_trxframe& input);
 127     //! Test if the atoms data is available for writing.
 128     bool haveAtoms(const t_trxframe& input) const
 129     {
 130         return haveStructureFileAtoms() || haveFrameAtoms(input);
 131     }
 132     //! Return pointer to t_atoms.
 133     t_atoms* atoms()
 134     {
 135         GMX_RELEASE_ASSERT(haveStructureFileAtoms(), "No atoms information available");
 136         return atoms_.get();
 137     }
 138     //! Flag provided for setting atoms in coordinate frame from user.
 139     ChangeAtomsType atomFlag_;
 140     //! Flag set if input atoms have been valid from the beginning.
 141     bool haveStructureFileAtoms_;
 142     /*! \brief
 143      *  Atoms information if available.
 144      *
 145      *  Note, the module takes ownership of the information and
 146      *  will clean it up on exit.
 147      */
 148     AtomsDataPtr atoms_;
 149     //! Requirements obtained from user input.
 150     CoordinateFileFlags moduleRequirements_;
 151 };
 152
 153 //! Smart pointer to manage the object.
 154 using SetAtomsPointer = std::unique_ptr<SetAtoms>;
 155
 156 } // namespace gmx
 157
 158 #endif