src/gromacs/analysisdata/tests/lifetime.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014,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 \file
  36  * \brief
  37  * Tests for functionality of analysis data lifetime module.
  38  *
  39  * These tests check that gmx::AnalysisDataLifetimeModule computes lifetimes
  40  * correctly with simple input data.
  41  * Checking is done using gmx::test::AnalysisDataTestFixture and reference
  42  * data.  Also the input data is written to the reference data to catch
  43  * out-of-date reference.
  44  *
  45  * \author Teemu Murtola <teemu.murtola@gmail.com>
  46  * \ingroup module_analysisdata
  47  */
  48 #include "gmxpre.h"
  49
  50 #include "gromacs/analysisdata/modules/lifetime.h"
  51
  52 #include <gtest/gtest.h>
  53
  54 #include "gromacs/analysisdata/analysisdata.h"
  55
  56 #include "gromacs/analysisdata/tests/datatest.h"
  57 #include "testutils/testasserts.h"
  58
  59 using gmx::test::AnalysisDataTestInput;
  60
  61 namespace
  62 {
  63
  64 // Simple input data for gmx::AnalysisDataLifetimeModule tests.
  65 class SimpleInputData
  66 {
  67 public:
  68     static const AnalysisDataTestInput& get()
  69     {
  70 #ifndef STATIC_ANON_NAMESPACE_BUG
  71         static SimpleInputData singleton;
  72         return singleton.data_;
  73 #else
  74         static SimpleInputData singleton_lifetime;
  75         return singleton_lifetime.data_;
  76 #endif
  77     }
  78
  79     SimpleInputData() : data_(1, false)
  80     {
  81         data_.setColumnCount(0, 3);
  82         data_.addFrameWithValues(1.0, 1.0, 1.0, 1.0);
  83         data_.addFrameWithValues(2.0, 1.0, 0.0, 1.0);
  84         data_.addFrameWithValues(3.0, 0.0, 1.0, 1.0);
  85     }
  86
  87 private:
  88     AnalysisDataTestInput data_;
  89 };
  90
  91 // Input data with multiple data sets for gmx::AnalysisDataLifetimeModule tests.
  92 class MultiDataSetInputData
  93 {
  94 public:
  95     static const AnalysisDataTestInput& get()
  96     {
  97 #ifndef STATIC_ANON_NAMESPACE_BUG
  98         static MultiDataSetInputData singleton;
  99         return singleton.data_;
 100 #else
 101         static MultiDataSetInputData singleton_lifetime;
 102         return singleton_lifetime.data_;
 103 #endif
 104     }
 105
 106     MultiDataSetInputData() : data_(2, false)
 107     {
 108         using gmx::test::AnalysisDataTestInputFrame;
 109         data_.setColumnCount(0, 2);
 110         data_.setColumnCount(1, 2);
 111         AnalysisDataTestInputFrame& frame1 = data_.addFrame(1.0);
 112         frame1.addPointSetWithValues(0, 0, 1.0, 1.0);
 113         frame1.addPointSetWithValues(1, 0, 0.0, 0.0);
 114         AnalysisDataTestInputFrame& frame2 = data_.addFrame(2.0);
 115         frame2.addPointSetWithValues(0, 0, 1.0, 0.0);
 116         frame2.addPointSetWithValues(1, 0, 1.0, 0.0);
 117         AnalysisDataTestInputFrame& frame3 = data_.addFrame(3.0);
 118         frame3.addPointSetWithValues(0, 0, 1.0, 0.0);
 119         frame3.addPointSetWithValues(1, 0, 1.0, 1.0);
 120     }
 121
 122 private:
 123     AnalysisDataTestInput data_;
 124 };
 125
 126
 127 /********************************************************************
 128  * Tests for gmx::AnalysisDataLifetimeModule.
 129  */
 130
 131 //! Test fixture for gmx::AnalysisDataLifetimeModule.
 132 typedef gmx::test::AnalysisDataTestFixture LifetimeModuleTest;
 133
 134 TEST_F(LifetimeModuleTest, BasicTest)
 135 {
 136     const AnalysisDataTestInput& input = SimpleInputData::get();
 137     gmx::AnalysisData            data;
 138     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 139
 140     gmx::AnalysisDataLifetimeModulePointer module(new gmx::AnalysisDataLifetimeModule);
 141     module->setCumulative(false);
 142     data.addModule(module);
 143
 144     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 145     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 146     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Lifetime", module.get()));
 147     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 148 }
 149
 150 TEST_F(LifetimeModuleTest, CumulativeTest)
 151 {
 152     const AnalysisDataTestInput& input = SimpleInputData::get();
 153     gmx::AnalysisData            data;
 154     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 155
 156     gmx::AnalysisDataLifetimeModulePointer module(new gmx::AnalysisDataLifetimeModule);
 157     module->setCumulative(true);
 158     data.addModule(module);
 159
 160     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 161     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 162     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Lifetime", module.get()));
 163     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 164 }
 165
 166 TEST_F(LifetimeModuleTest, HandlesMultipleDataSets)
 167 {
 168     const AnalysisDataTestInput& input = MultiDataSetInputData::get();
 169     gmx::AnalysisData            data;
 170     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 171
 172     gmx::AnalysisDataLifetimeModulePointer module(new gmx::AnalysisDataLifetimeModule);
 173     module->setCumulative(false);
 174     data.addModule(module);
 175
 176     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 177     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 178     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Lifetime", module.get()));
 179     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 180 }
 181
 182 } // namespace