src/gromacs/analysisdata/tests/lifetime.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014, 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 <gtest/gtest.h>
  51
  52 #include "gromacs/analysisdata/analysisdata.h"
  53 #include "gromacs/analysisdata/modules/lifetime.h"
  54
  55 #include "gromacs/analysisdata/tests/datatest.h"
  56 #include "testutils/testasserts.h"
  57
  58 using gmx::test::AnalysisDataTestInput;
  59
  60 namespace
  61 {
  62
  63 // Simple input data for gmx::AnalysisDataLifetimeModule tests.
  64 class SimpleInputData
  65 {
  66     public:
  67         static const AnalysisDataTestInput &get()
  68         {
  69 #ifndef INTEL_STATIC_ANON_NAMESPACE_BUG
  70             static SimpleInputData singleton;
  71             return singleton.data_;
  72 #else
  73             static SimpleInputData singleton_lifetime;
  74             return singleton_lifetime.data_;
  75 #endif
  76         }
  77
  78         SimpleInputData() : data_(1, false)
  79         {
  80             data_.setColumnCount(0, 3);
  81             data_.addFrameWithValues(1.0,  1.0, 1.0, 1.0);
  82             data_.addFrameWithValues(2.0,  1.0, 0.0, 1.0);
  83             data_.addFrameWithValues(3.0,  0.0, 1.0, 1.0);
  84         }
  85
  86     private:
  87         AnalysisDataTestInput  data_;
  88 };
  89
  90 // Input data with multiple data sets for gmx::AnalysisDataLifetimeModule tests.
  91 class MultiDataSetInputData
  92 {
  93     public:
  94         static const AnalysisDataTestInput &get()
  95         {
  96 #ifndef INTEL_STATIC_ANON_NAMESPACE_BUG
  97             static MultiDataSetInputData singleton;
  98             return singleton.data_;
  99 #else
 100             static MultiDataSetInputData singleton_lifetime;
 101             return singleton_lifetime.data_;
 102 #endif
 103         }
 104
 105         MultiDataSetInputData() : data_(2, false)
 106         {
 107             using gmx::test::AnalysisDataTestInputFrame;
 108             data_.setColumnCount(0, 2);
 109             data_.setColumnCount(1, 2);
 110             AnalysisDataTestInputFrame &frame1 = data_.addFrame(1.0);
 111             frame1.addPointSetWithValues(0, 0, 1.0, 1.0);
 112             frame1.addPointSetWithValues(1, 0, 0.0, 0.0);
 113             AnalysisDataTestInputFrame &frame2 = data_.addFrame(2.0);
 114             frame2.addPointSetWithValues(0, 0, 1.0, 0.0);
 115             frame2.addPointSetWithValues(1, 0, 1.0, 0.0);
 116             AnalysisDataTestInputFrame &frame3 = data_.addFrame(3.0);
 117             frame3.addPointSetWithValues(0, 0, 1.0, 0.0);
 118             frame3.addPointSetWithValues(1, 0, 1.0, 1.0);
 119         }
 120
 121     private:
 122         AnalysisDataTestInput  data_;
 123 };
 124
 125
 126 /********************************************************************
 127  * Tests for gmx::AnalysisDataLifetimeModule.
 128  */
 129
 130 //! Test fixture for gmx::AnalysisDataLifetimeModule.
 131 typedef gmx::test::AnalysisDataTestFixture LifetimeModuleTest;
 132
 133 TEST_F(LifetimeModuleTest, BasicTest)
 134 {
 135     const AnalysisDataTestInput &input = SimpleInputData::get();
 136     gmx::AnalysisData            data;
 137     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 138
 139     gmx::AnalysisDataLifetimeModulePointer module(
 140             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(
 157             new gmx::AnalysisDataLifetimeModule);
 158     module->setCumulative(true);
 159     data.addModule(module);
 160
 161     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 162     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 163     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Lifetime", module.get()));
 164     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 165 }
 166
 167 TEST_F(LifetimeModuleTest, HandlesMultipleDataSets)
 168 {
 169     const AnalysisDataTestInput &input = MultiDataSetInputData::get();
 170     gmx::AnalysisData            data;
 171     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 172
 173     gmx::AnalysisDataLifetimeModulePointer module(
 174             new gmx::AnalysisDataLifetimeModule);
 175     module->setCumulative(false);
 176     data.addModule(module);
 177
 178     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 179     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 180     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Lifetime", module.get()));
 181     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 182 }
 183
 184 } // namespace