src/gromacs/analysisdata/tests/average.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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 averaging modules.
  38  *
  39  * These tests check that gmx::AnalysisDataAverageModule and
  40  * gmx::AnalysisDataFrameAverageModule compute averages correctly with simple
  41  * input data.
  42  * Checking is done using gmx::test::AnalysisDataTestFixture and reference
  43  * data.  Also the input data is written to the reference data to catch
  44  * out-of-date reference.
  45  *
  46  * \author Teemu Murtola <teemu.murtola@gmail.com>
  47  * \ingroup module_analysisdata
  48  */
  49 #include <gtest/gtest.h>
  50
  51 #include "gromacs/analysisdata/analysisdata.h"
  52 #include "gromacs/analysisdata/modules/average.h"
  53
  54 #include "testutils/datatest.h"
  55 #include "testutils/testasserts.h"
  56
  57 using gmx::test::AnalysisDataTestInput;
  58
  59 namespace
  60 {
  61
  62 // Simple input data for gmx::AnalysisDataAverageModule tests.
  63 class SimpleInputData
  64 {
  65     public:
  66         static const AnalysisDataTestInput &get()
  67         {
  68             static SimpleInputData singleton;
  69             return singleton.data_;
  70         }
  71
  72         SimpleInputData() : data_(1, false)
  73         {
  74             data_.setColumnCount(0, 3);
  75             data_.addFrameWithValues(1.0,  0.0, 1.0, 2.0);
  76             data_.addFrameWithValues(2.0,  1.0, 1.0, 1.0);
  77             data_.addFrameWithValues(3.0,  2.0, 0.0, 0.0);
  78         }
  79
  80     private:
  81         AnalysisDataTestInput  data_;
  82 };
  83
  84 // Multipoint input data for gmx::AnalysisDataAverageModule tests.
  85 class MultipointInputData
  86 {
  87     public:
  88         static const AnalysisDataTestInput &get()
  89         {
  90             static MultipointInputData singleton;
  91             return singleton.data_;
  92         }
  93
  94         MultipointInputData() : data_(1, true)
  95         {
  96             using gmx::test::AnalysisDataTestInputFrame;
  97             data_.setColumnCount(0, 3);
  98             AnalysisDataTestInputFrame &frame1 = data_.addFrame(1.0);
  99             frame1.addPointSetWithValues(0, 0, 0.0, 1.0, 2.0);
 100             frame1.addPointSetWithValues(0, 0, 1.0, 0.0);
 101             frame1.addPointSetWithValues(0, 0, 2.0);
 102             AnalysisDataTestInputFrame &frame2 = data_.addFrame(2.0);
 103             frame2.addPointSetWithValues(0, 0, 1.0, 1.0);
 104             frame2.addPointSetWithValues(0, 0, 2.0);
 105             AnalysisDataTestInputFrame &frame3 = data_.addFrame(3.0);
 106             frame3.addPointSetWithValues(0, 0, 2.0, 0.0, 0.0);
 107         }
 108
 109     private:
 110         AnalysisDataTestInput  data_;
 111 };
 112
 113
 114 /********************************************************************
 115  * Tests for gmx::AnalysisDataAverageModule.
 116  */
 117
 118 //! Test fixture for gmx::AnalysisDataAverageModule.
 119 typedef gmx::test::AnalysisDataTestFixture AverageModuleTest;
 120
 121 TEST_F(AverageModuleTest, BasicTest)
 122 {
 123     const AnalysisDataTestInput &input = SimpleInputData::get();
 124     gmx::AnalysisData            data;
 125     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 126
 127     gmx::AnalysisDataAverageModulePointer module(
 128             new gmx::AnalysisDataAverageModule);
 129     data.addModule(module);
 130
 131     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 132     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 133     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 134     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 135 }
 136
 137 TEST_F(AverageModuleTest, HandlesMultipointData)
 138 {
 139     const AnalysisDataTestInput &input = MultipointInputData::get();
 140     gmx::AnalysisData            data;
 141     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 142
 143     gmx::AnalysisDataAverageModulePointer module(
 144             new gmx::AnalysisDataAverageModule);
 145     data.addModule(module);
 146
 147     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 148     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 149     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 150     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 151 }
 152
 153 TEST_F(AverageModuleTest, CanCustomizeXAxis)
 154 {
 155     const AnalysisDataTestInput &input = SimpleInputData::get();
 156     gmx::AnalysisData            data;
 157     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 158
 159     gmx::AnalysisDataAverageModulePointer module(new gmx::AnalysisDataAverageModule());
 160     data.addModule(module);
 161     module->setXAxis(0.5, 0.5);
 162
 163     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 164     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 165     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 166     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 167 }
 168
 169 /********************************************************************
 170  * Tests for gmx::AnalysisDataFrameAverageModule.
 171  */
 172
 173 //! Test fixture for gmx::AnalysisDataFrameAverageModule.
 174 typedef gmx::test::AnalysisDataTestFixture FrameAverageModuleTest;
 175
 176 TEST_F(FrameAverageModuleTest, BasicTest)
 177 {
 178     const AnalysisDataTestInput &input = SimpleInputData::get();
 179     gmx::AnalysisData            data;
 180     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 181
 182     gmx::AnalysisDataFrameAverageModulePointer module(
 183             new gmx::AnalysisDataFrameAverageModule);
 184     data.addModule(module);
 185
 186     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 187     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 188     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("FrameAverage", module.get()));
 189     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 190 }
 191
 192 } // namespace