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_(3, false)
  73         {
  74             data_.addFrameWithValues(1.0,  0.0, 1.0, 2.0);
  75             data_.addFrameWithValues(2.0,  1.0, 1.0, 1.0);
  76             data_.addFrameWithValues(3.0,  2.0, 0.0, 0.0);
  77         }
  78
  79     private:
  80         AnalysisDataTestInput  data_;
  81 };
  82
  83 // Multipoint input data for gmx::AnalysisDataAverageModule tests.
  84 class MultipointInputData
  85 {
  86     public:
  87         static const AnalysisDataTestInput &get()
  88         {
  89             static MultipointInputData singleton;
  90             return singleton.data_;
  91         }
  92
  93         MultipointInputData() : data_(3, true)
  94         {
  95             using gmx::test::AnalysisDataTestInputFrame;
  96             AnalysisDataTestInputFrame &frame1 = data_.addFrame(1.0);
  97             frame1.addPointSetWithValues(0, 0.0, 1.0, 2.0);
  98             frame1.addPointSetWithValues(0, 1.0, 0.0);
  99             frame1.addPointSetWithValues(0, 2.0);
 100             AnalysisDataTestInputFrame &frame2 = data_.addFrame(2.0);
 101             frame2.addPointSetWithValues(0, 1.0, 1.0);
 102             frame2.addPointSetWithValues(0, 2.0);
 103             AnalysisDataTestInputFrame &frame3 = data_.addFrame(3.0);
 104             frame3.addPointSetWithValues(0, 2.0, 0.0, 0.0);
 105         }
 106
 107     private:
 108         AnalysisDataTestInput  data_;
 109 };
 110
 111
 112 /********************************************************************
 113  * Tests for gmx::AnalysisDataAverageModule.
 114  */
 115
 116 //! Test fixture for gmx::AnalysisDataAverageModule.
 117 typedef gmx::test::AnalysisDataTestFixture AverageModuleTest;
 118
 119 TEST_F(AverageModuleTest, BasicTest)
 120 {
 121     const AnalysisDataTestInput &input = SimpleInputData::get();
 122     gmx::AnalysisData            data;
 123     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 124
 125     gmx::AnalysisDataAverageModulePointer module(
 126             new gmx::AnalysisDataAverageModule);
 127     data.addModule(module);
 128
 129     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 130     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 131     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 132     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 133 }
 134
 135 TEST_F(AverageModuleTest, HandlesMultipointData)
 136 {
 137     const AnalysisDataTestInput &input = MultipointInputData::get();
 138     gmx::AnalysisData            data;
 139     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 140
 141     gmx::AnalysisDataAverageModulePointer module(
 142             new gmx::AnalysisDataAverageModule);
 143     data.addModule(module);
 144
 145     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 146     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 147     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 148     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 149 }
 150
 151 TEST_F(AverageModuleTest, CanCustomizeXAxis)
 152 {
 153     const AnalysisDataTestInput &input = SimpleInputData::get();
 154     gmx::AnalysisData            data;
 155     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 156
 157     gmx::AnalysisDataAverageModulePointer module(new gmx::AnalysisDataAverageModule());
 158     data.addModule(module);
 159     module->setXAxis(0.5, 0.5);
 160
 161     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 162     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 163     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 164     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 165 }
 166
 167 /********************************************************************
 168  * Tests for gmx::AnalysisDataFrameAverageModule.
 169  */
 170
 171 //! Test fixture for gmx::AnalysisDataFrameAverageModule.
 172 typedef gmx::test::AnalysisDataTestFixture FrameAverageModuleTest;
 173
 174 TEST_F(FrameAverageModuleTest, BasicTest)
 175 {
 176     const AnalysisDataTestInput &input = SimpleInputData::get();
 177     gmx::AnalysisData            data;
 178     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 179
 180     gmx::AnalysisDataFrameAverageModulePointer module(
 181             new gmx::AnalysisDataFrameAverageModule);
 182     data.addModule(module);
 183
 184     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 185     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 186     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("FrameAverage", module.get()));
 187     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 188 }
 189
 190 } // namespace