src/gromacs/coordinateio/tests/settimestep.cpp

   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 /*!\internal
  36  * \file
  37  * \brief
  38  * Tests for gmx::SetTimeStep
  39  *
  40  * \author Paul Bauer <paul.bauer.q@gmail.com>
  41  * \ingroup module_coordinateio
  42  */
  43
  44
  45 #include "gmxpre.h"
  46
  47 #include <memory>
  48
  49 #include "gromacs/coordinateio/outputadapters/settimestep.h"
  50 #include "gromacs/fileio/trxio.h"
  51 #include "gromacs/trajectory/trajectoryframe.h"
  52
  53 #include "gromacs/coordinateio/tests/coordinate_test.h"
  54
  55 namespace gmx
  56 {
  57
  58 namespace test
  59 {
  60
  61 /*!\brief
  62  * Test fixture to prepare a setatoms object to pass data through.
  63  */
  64 class SetTimeStepTest : public gmx::test::CommandLineTestBase
  65 {
  66 public:
  67     SetTimeStepTest() { clear_trxframe(frame(), true); }
  68     /*! \brief
  69      * Get access to the method for changing frame time information.
  70      *
  71      * \param[in] timeStep User supplied time step to test.
  72      */
  73     SetTimeStep* setTimeStep(real timeStep)
  74     {
  75         if (!setTimeStep_)
  76         {
  77             setTimeStep_ = std::make_unique<SetTimeStep>(timeStep);
  78         }
  79         return setTimeStep_.get();
  80     }
  81     //! Get access to trajectoryframe to mess with.
  82     t_trxframe* frame() { return &frame_; }
  83
  84 private:
  85     //! Object to use for tests
  86     SetTimeStepPointer setTimeStep_;
  87     //! Storage of trajectoryframe.
  88     t_trxframe frame_;
  89 };
  90
  91 TEST_F(SetTimeStepTest, SetTimeStepWorks)
  92 {
  93     frame()->time = 23;
  94     // Set start time to nonsense to make sure it is ignored.
  95     SetTimeStep* method = setTimeStep(7);
  96     EXPECT_NO_THROW(method->processFrame(0, frame()));
  97     EXPECT_EQ(frame()->time, 23);
  98     // No matter what the next time in the frame is, ignore it.
  99     frame()->time = 42;
 100     EXPECT_NO_THROW(method->processFrame(1, frame()));
 101     EXPECT_EQ(frame()->time, 30);
 102     // And so on for more frames.
 103     frame()->time = 0;
 104     EXPECT_NO_THROW(method->processFrame(2, frame()));
 105     EXPECT_EQ(frame()->time, 37);
 106 }
 107
 108 } // namespace test
 109
 110 } // namespace gmx