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