src/gromacs/analysisdata/tests/average.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,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 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 "gromacs/analysisdata/tests/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 // Input data with multiple data sets for gmx::AnalysisDataAverageModule tests.
 114 class MultiDataSetInputData
 115 {
 116     public:
 117         static const AnalysisDataTestInput &get()
 118         {
 119             static MultiDataSetInputData singleton;
 120             return singleton.data_;
 121         }
 122
 123         MultiDataSetInputData() : data_(2, true)
 124         {
 125             using gmx::test::AnalysisDataTestInputFrame;
 126             data_.setColumnCount(0, 3);
 127             data_.setColumnCount(1, 2);
 128             AnalysisDataTestInputFrame &frame1 = data_.addFrame(1.0);
 129             frame1.addPointSetWithValues(0, 0, 0.0, 1.0, 2.0);
 130             frame1.addPointSetWithValues(0, 0, 1.0, 0.0);
 131             frame1.addPointSetWithValues(1, 0, 2.0, 1.0);
 132             frame1.addPointSetWithValues(1, 1, 2.0);
 133             AnalysisDataTestInputFrame &frame2 = data_.addFrame(2.0);
 134             frame2.addPointSetWithValues(0, 0, 1.0, 1.0);
 135             frame2.addPointSetWithValues(0, 2, 2.0);
 136             frame2.addPointSetWithValues(1, 0, 1.0, 0.0);
 137             AnalysisDataTestInputFrame &frame3 = data_.addFrame(3.0);
 138             frame3.addPointSetWithValues(0, 0, 2.0, 0.0, 0.0);
 139             frame3.addPointSetWithValues(1, 0, 0.0, 2.0);
 140         }
 141
 142     private:
 143         AnalysisDataTestInput  data_;
 144 };
 145
 146
 147 /********************************************************************
 148  * Tests for gmx::AnalysisDataAverageModule.
 149  */
 150
 151 //! Test fixture for gmx::AnalysisDataAverageModule.
 152 typedef gmx::test::AnalysisDataTestFixture AverageModuleTest;
 153
 154 TEST_F(AverageModuleTest, BasicTest)
 155 {
 156     const AnalysisDataTestInput &input = SimpleInputData::get();
 157     gmx::AnalysisData            data;
 158     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 159
 160     gmx::AnalysisDataAverageModulePointer module(
 161             new gmx::AnalysisDataAverageModule);
 162     data.addModule(module);
 163
 164     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 165     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 166     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 167     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 168 }
 169
 170 TEST_F(AverageModuleTest, HandlesMultipointData)
 171 {
 172     const AnalysisDataTestInput &input = MultipointInputData::get();
 173     gmx::AnalysisData            data;
 174     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 175
 176     gmx::AnalysisDataAverageModulePointer module(
 177             new gmx::AnalysisDataAverageModule);
 178     data.addModule(module);
 179
 180     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 181     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 182     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 183     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 184 }
 185
 186 TEST_F(AverageModuleTest, HandlesMultipleDataSets)
 187 {
 188     const AnalysisDataTestInput &input = MultiDataSetInputData::get();
 189     gmx::AnalysisData            data;
 190     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 191
 192     gmx::AnalysisDataAverageModulePointer module(
 193             new gmx::AnalysisDataAverageModule);
 194     data.addModule(module);
 195
 196     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 197     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 198     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 199     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 200 }
 201
 202 TEST_F(AverageModuleTest, HandlesDataSetAveraging)
 203 {
 204     const AnalysisDataTestInput &input = MultiDataSetInputData::get();
 205     gmx::AnalysisData            data;
 206     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 207
 208     gmx::AnalysisDataAverageModulePointer module(
 209             new gmx::AnalysisDataAverageModule);
 210     module->setAverageDataSets(true);
 211     data.addModule(module);
 212
 213     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 214     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 215     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 216     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 217 }
 218
 219 TEST_F(AverageModuleTest, CanCustomizeXAxis)
 220 {
 221     const AnalysisDataTestInput &input = SimpleInputData::get();
 222     gmx::AnalysisData            data;
 223     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 224
 225     gmx::AnalysisDataAverageModulePointer module(new gmx::AnalysisDataAverageModule());
 226     data.addModule(module);
 227     module->setXAxis(0.5, 0.5);
 228
 229     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 230     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 231     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 232     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 233 }
 234
 235 TEST_F(AverageModuleTest, CanCustomizeNonUniformXAxis)
 236 {
 237     const AnalysisDataTestInput &input = SimpleInputData::get();
 238     gmx::AnalysisData            data;
 239     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 240
 241     gmx::AnalysisDataAverageModulePointer module(new gmx::AnalysisDataAverageModule());
 242     data.addModule(module);
 243     module->setXAxisValue(0, 2.0);
 244     module->setXAxisValue(1, 3.0);
 245     module->setXAxisValue(2, 5.0);
 246
 247     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 248     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 249     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 250     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 251 }
 252
 253 /********************************************************************
 254  * Tests for gmx::AnalysisDataFrameAverageModule.
 255  */
 256
 257 //! Test fixture for gmx::AnalysisDataFrameAverageModule.
 258 typedef gmx::test::AnalysisDataTestFixture FrameAverageModuleTest;
 259
 260 TEST_F(FrameAverageModuleTest, BasicTest)
 261 {
 262     const AnalysisDataTestInput &input = SimpleInputData::get();
 263     gmx::AnalysisData            data;
 264     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 265
 266     gmx::AnalysisDataFrameAverageModulePointer module(
 267             new gmx::AnalysisDataFrameAverageModule);
 268     data.addModule(module);
 269
 270     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 271     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 272     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("FrameAverage", module.get()));
 273     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 274 }
 275
 276 TEST_F(FrameAverageModuleTest, HandlesMultipleDataSets)
 277 {
 278     const AnalysisDataTestInput &input = MultiDataSetInputData::get();
 279     gmx::AnalysisData            data;
 280     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 281
 282     gmx::AnalysisDataFrameAverageModulePointer module(
 283             new gmx::AnalysisDataFrameAverageModule);
 284     data.addModule(module);
 285
 286     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 287     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 288     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("FrameAverage", module.get()));
 289     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 290 }
 291
 292 } // namespace