src/gromacs/coordinateio/tests/setbothtime.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 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/fileio/trxio.h"
  52 #include "gromacs/trajectory/trajectoryframe.h"
  53
  54 #include "gromacs/coordinateio/tests/coordinate_test.h"
  55
  56 namespace gmx
  57 {
  58
  59 namespace test
  60 {
  61
  62 /*!\brief
  63  * Test fixture to prepare a setatoms object to pass data through.
  64  */
  65 class SetBothTimeTest : public gmx::test::CommandLineTestBase
  66 {
  67 public:
  68     SetBothTimeTest() { clear_trxframe(frame(), true); }
  69     /*! \brief
  70      * Get access to the method for changing frame time step information.
  71      *
  72      * \param[in] timeStep User supplied time step to test.
  73      */
  74     SetTimeStep* setTimeStep(real timeStep)
  75     {
  76         if (!setTimeStep_)
  77         {
  78             setTimeStep_ = std::make_unique<SetTimeStep>(timeStep);
  79         }
  80         return setTimeStep_.get();
  81     }
  82     /*! \brief
  83      * Get access to the method for changing frame start time information.
  84      *
  85      * \param[in] startTime User supplied start time to test.
  86      */
  87     SetStartTime* setStartTime(real startTime)
  88     {
  89         if (!setStartTime_)
  90         {
  91             setStartTime_ = std::make_unique<SetStartTime>(startTime);
  92         }
  93         return setStartTime_.get();
  94     }
  95
  96     //! Get access to trajectoryframe to mess with.
  97     t_trxframe* frame() { return &frame_; }
  98
  99 private:
 100     //! Object to use for tests
 101     SetTimeStepPointer setTimeStep_;
 102     //! Object to use for tests
 103     SetStartTimePointer setStartTime_;
 104     //! Storage of trajectoryframe.
 105     t_trxframe frame_;
 106 };
 107
 108 TEST_F(SetBothTimeTest, StartTimeZeroWorks)
 109 {
 110     frame()->time = 23;
 111     // Set start time.
 112     SetTimeStep* timestep = setTimeStep(7);
 113     // Set initial time to zero.
 114     SetStartTime* starttime = setStartTime(0);
 115     // processing always goes through start time before time step.
 116     EXPECT_NO_THROW(starttime->processFrame(0, frame()));
 117     EXPECT_NO_THROW(timestep->processFrame(0, frame()));
 118     EXPECT_EQ(frame()->time, 0);
 119     // No matter what the next time in the frame is, ignore it.
 120     frame()->time = 42;
 121     EXPECT_NO_THROW(starttime->processFrame(1, frame()));
 122     EXPECT_NO_THROW(timestep->processFrame(1, frame()));
 123
 124     EXPECT_EQ(frame()->time, 7);
 125     // And so on for more frames.
 126     frame()->time = 0;
 127     EXPECT_NO_THROW(starttime->processFrame(2, frame()));
 128     EXPECT_NO_THROW(timestep->processFrame(2, frame()));
 129     EXPECT_EQ(frame()->time, 14);
 130 }
 131
 132 TEST_F(SetBothTimeTest, SetStartTimeNonZeroWorks)
 133 {
 134     frame()->time = 23;
 135     // Set start time.
 136     SetTimeStep* timestep = setTimeStep(7);
 137     // Set initial time to zero.
 138     SetStartTime* starttime = setStartTime(23);
 139     // processing always goes through start time before time step.
 140     EXPECT_NO_THROW(starttime->processFrame(0, frame()));
 141     EXPECT_NO_THROW(timestep->processFrame(0, frame()));
 142     EXPECT_EQ(frame()->time, 23);
 143     // No matter what the next time in the frame is, ignore it.
 144     frame()->time = 42;
 145     EXPECT_NO_THROW(starttime->processFrame(1, frame()));
 146     EXPECT_NO_THROW(timestep->processFrame(1, frame()));
 147
 148     EXPECT_EQ(frame()->time, 30);
 149     // And so on for more frames.
 150     frame()->time = 0;
 151     EXPECT_NO_THROW(starttime->processFrame(2, frame()));
 152     EXPECT_NO_THROW(timestep->processFrame(2, frame()));
 153     EXPECT_EQ(frame()->time, 37);
 154 }
 155
 156 } // namespace test
 157
 158 } // namespace gmx