src/gromacs/coordinateio/tests/setbothtime.cpp

   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 /*!\internal
  36  * \file
  37  * \brief
  38  * Tests for combination of gmx::SetTimeStep and gmx::SetStartTime
  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/setstarttime.h"
  50 #include "gromacs/coordinateio/outputadapters/settimestep.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 SetBothTimeTest : public gmx::test::CommandLineTestBase
  65 {
  66 public:
  67     SetBothTimeTest() { clear_trxframe(frame(), true); }
  68     /*! \brief
  69      * Get access to the method for changing frame time step 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     /*! \brief
  82      * Get access to the method for changing frame start time information.
  83      *
  84      * \param[in] startTime User supplied start time to test.
  85      */
  86     SetStartTime* setStartTime(real startTime)
  87     {
  88         if (!setStartTime_)
  89         {
  90             setStartTime_ = std::make_unique<SetStartTime>(startTime);
  91         }
  92         return setStartTime_.get();
  93     }
  94
  95     //! Get access to trajectoryframe to mess with.
  96     t_trxframe* frame() { return &frame_; }
  97
  98 private:
  99     //! Object to use for tests
 100     SetTimeStepPointer setTimeStep_;
 101     //! Object to use for tests
 102     SetStartTimePointer setStartTime_;
 103     //! Storage of trajectoryframe.
 104     t_trxframe frame_;
 105 };
 106
 107 TEST_F(SetBothTimeTest, StartTimeZeroWorks)
 108 {
 109     frame()->time = 23;
 110     // Set start time.
 111     SetTimeStep* timestep = setTimeStep(7);
 112     // Set initial time to zero.
 113     SetStartTime* starttime = setStartTime(0);
 114     // processing always goes through start time before time step.
 115     EXPECT_NO_THROW(starttime->processFrame(0, frame()));
 116     EXPECT_NO_THROW(timestep->processFrame(0, frame()));
 117     EXPECT_EQ(frame()->time, 0);
 118     // No matter what the next time in the frame is, ignore it.
 119     frame()->time = 42;
 120     EXPECT_NO_THROW(starttime->processFrame(1, frame()));
 121     EXPECT_NO_THROW(timestep->processFrame(1, frame()));
 122
 123     EXPECT_EQ(frame()->time, 7);
 124     // And so on for more frames.
 125     frame()->time = 0;
 126     EXPECT_NO_THROW(starttime->processFrame(2, frame()));
 127     EXPECT_NO_THROW(timestep->processFrame(2, frame()));
 128     EXPECT_EQ(frame()->time, 14);
 129 }
 130
 131 TEST_F(SetBothTimeTest, SetStartTimeNonZeroWorks)
 132 {
 133     frame()->time = 23;
 134     // Set start time.
 135     SetTimeStep* timestep = setTimeStep(7);
 136     // Set initial time to zero.
 137     SetStartTime* starttime = setStartTime(23);
 138     // processing always goes through start time before time step.
 139     EXPECT_NO_THROW(starttime->processFrame(0, frame()));
 140     EXPECT_NO_THROW(timestep->processFrame(0, frame()));
 141     EXPECT_EQ(frame()->time, 23);
 142     // No matter what the next time in the frame is, ignore it.
 143     frame()->time = 42;
 144     EXPECT_NO_THROW(starttime->processFrame(1, frame()));
 145     EXPECT_NO_THROW(timestep->processFrame(1, frame()));
 146
 147     EXPECT_EQ(frame()->time, 30);
 148     // And so on for more frames.
 149     frame()->time = 0;
 150     EXPECT_NO_THROW(starttime->processFrame(2, frame()));
 151     EXPECT_NO_THROW(timestep->processFrame(2, frame()));
 152     EXPECT_EQ(frame()->time, 37);
 153 }
 154
 155 } // namespace test
 156
 157 } // namespace gmx