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 #ifndef STATIC_ANON_NAMESPACE_BUG
  69             static SimpleInputData singleton;
  70             return singleton.data_;
  71 #else
  72             static SimpleInputData singleton_average;
  73             return singleton_average.data_;
  74 #endif
  75         }
  76
  77         SimpleInputData() : data_(1, false)
  78         {
  79             data_.setColumnCount(0, 3);
  80             data_.addFrameWithValues(1.0,  0.0, 1.0, 2.0);
  81             data_.addFrameWithValues(2.0,  1.0, 1.0, 1.0);
  82             data_.addFrameWithValues(3.0,  2.0, 0.0, 0.0);
  83         }
  84
  85     private:
  86         AnalysisDataTestInput  data_;
  87 };
  88
  89 // Multipoint input data for gmx::AnalysisDataAverageModule tests.
  90 class MultipointInputData
  91 {
  92     public:
  93         static const AnalysisDataTestInput &get()
  94         {
  95 #ifndef STATIC_ANON_NAMESPACE_BUG
  96             static MultipointInputData singleton;
  97             return singleton.data_;
  98 #else
  99             static MultipointInputData singleton_average;
 100             return singleton_average.data_;
 101 #endif
 102         }
 103
 104         MultipointInputData() : data_(1, true)
 105         {
 106             using gmx::test::AnalysisDataTestInputFrame;
 107             data_.setColumnCount(0, 3);
 108             AnalysisDataTestInputFrame &frame1 = data_.addFrame(1.0);
 109             frame1.addPointSetWithValues(0, 0, 0.0, 1.0, 2.0);
 110             frame1.addPointSetWithValues(0, 0, 1.0, 0.0);
 111             frame1.addPointSetWithValues(0, 0, 2.0);
 112             AnalysisDataTestInputFrame &frame2 = data_.addFrame(2.0);
 113             frame2.addPointSetWithValues(0, 0, 1.0, 1.0);
 114             frame2.addPointSetWithValues(0, 0, 2.0);
 115             AnalysisDataTestInputFrame &frame3 = data_.addFrame(3.0);
 116             frame3.addPointSetWithValues(0, 0, 2.0, 0.0, 0.0);
 117         }
 118
 119     private:
 120         AnalysisDataTestInput  data_;
 121 };
 122
 123 // Input data with multiple data sets for gmx::AnalysisDataAverageModule tests.
 124 class MultiDataSetInputData
 125 {
 126     public:
 127         static const AnalysisDataTestInput &get()
 128         {
 129 #ifndef STATIC_ANON_NAMESPACE_BUG
 130             static MultiDataSetInputData singleton;
 131             return singleton.data_;
 132 #else
 133             static MultiDataSetInputData singleton_average;
 134             return singleton_average.data_;
 135 #endif
 136         }
 137
 138         MultiDataSetInputData() : data_(2, true)
 139         {
 140             using gmx::test::AnalysisDataTestInputFrame;
 141             data_.setColumnCount(0, 3);
 142             data_.setColumnCount(1, 2);
 143             AnalysisDataTestInputFrame &frame1 = data_.addFrame(1.0);
 144             frame1.addPointSetWithValues(0, 0, 0.0, 1.0, 2.0);
 145             frame1.addPointSetWithValues(0, 0, 1.0, 0.0);
 146             frame1.addPointSetWithValues(1, 0, 2.0, 1.0);
 147             frame1.addPointSetWithValues(1, 1, 2.0);
 148             AnalysisDataTestInputFrame &frame2 = data_.addFrame(2.0);
 149             frame2.addPointSetWithValues(0, 0, 1.0, 1.0);
 150             frame2.addPointSetWithValues(0, 2, 2.0);
 151             frame2.addPointSetWithValues(1, 0, 1.0, 0.0);
 152             AnalysisDataTestInputFrame &frame3 = data_.addFrame(3.0);
 153             frame3.addPointSetWithValues(0, 0, 2.0, 0.0, 0.0);
 154             frame3.addPointSetWithValues(1, 0, 0.0, 2.0);
 155         }
 156
 157     private:
 158         AnalysisDataTestInput  data_;
 159 };
 160
 161
 162 /********************************************************************
 163  * Tests for gmx::AnalysisDataAverageModule.
 164  */
 165
 166 //! Test fixture for gmx::AnalysisDataAverageModule.
 167 typedef gmx::test::AnalysisDataTestFixture AverageModuleTest;
 168
 169 TEST_F(AverageModuleTest, BasicTest)
 170 {
 171     const AnalysisDataTestInput &input = SimpleInputData::get();
 172     gmx::AnalysisData            data;
 173     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 174
 175     gmx::AnalysisDataAverageModulePointer module(
 176             new gmx::AnalysisDataAverageModule);
 177     data.addModule(module);
 178
 179     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 180     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 181     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 182     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 183 }
 184
 185 TEST_F(AverageModuleTest, HandlesMultipointData)
 186 {
 187     const AnalysisDataTestInput &input = MultipointInputData::get();
 188     gmx::AnalysisData            data;
 189     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 190
 191     gmx::AnalysisDataAverageModulePointer module(
 192             new gmx::AnalysisDataAverageModule);
 193     data.addModule(module);
 194
 195     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 196     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 197     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 198     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 199 }
 200
 201 TEST_F(AverageModuleTest, HandlesMultipleDataSets)
 202 {
 203     const AnalysisDataTestInput &input = MultiDataSetInputData::get();
 204     gmx::AnalysisData            data;
 205     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 206
 207     gmx::AnalysisDataAverageModulePointer module(
 208             new gmx::AnalysisDataAverageModule);
 209     data.addModule(module);
 210
 211     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 212     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 213     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 214     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 215 }
 216
 217 TEST_F(AverageModuleTest, HandlesDataSetAveraging)
 218 {
 219     const AnalysisDataTestInput &input = MultiDataSetInputData::get();
 220     gmx::AnalysisData            data;
 221     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 222
 223     gmx::AnalysisDataAverageModulePointer module(
 224             new gmx::AnalysisDataAverageModule);
 225     module->setAverageDataSets(true);
 226     data.addModule(module);
 227
 228     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 229     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 230     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 231     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 232 }
 233
 234 TEST_F(AverageModuleTest, CanCustomizeXAxis)
 235 {
 236     const AnalysisDataTestInput &input = SimpleInputData::get();
 237     gmx::AnalysisData            data;
 238     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 239
 240     gmx::AnalysisDataAverageModulePointer module(new gmx::AnalysisDataAverageModule());
 241     data.addModule(module);
 242     module->setXAxis(0.5, 0.5);
 243
 244     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 245     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 246     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 247     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 248 }
 249
 250 TEST_F(AverageModuleTest, CanCustomizeNonUniformXAxis)
 251 {
 252     const AnalysisDataTestInput &input = SimpleInputData::get();
 253     gmx::AnalysisData            data;
 254     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 255
 256     gmx::AnalysisDataAverageModulePointer module(new gmx::AnalysisDataAverageModule());
 257     data.addModule(module);
 258     module->setXAxisValue(0, 2.0);
 259     module->setXAxisValue(1, 3.0);
 260     module->setXAxisValue(2, 5.0);
 261
 262     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 263     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 264     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 265     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 266 }
 267
 268 /********************************************************************
 269  * Tests for gmx::AnalysisDataFrameAverageModule.
 270  */
 271
 272 //! Test fixture for gmx::AnalysisDataFrameAverageModule.
 273 typedef gmx::test::AnalysisDataTestFixture FrameAverageModuleTest;
 274
 275 TEST_F(FrameAverageModuleTest, BasicTest)
 276 {
 277     const AnalysisDataTestInput &input = SimpleInputData::get();
 278     gmx::AnalysisData            data;
 279     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 280
 281     gmx::AnalysisDataFrameAverageModulePointer module(
 282             new gmx::AnalysisDataFrameAverageModule);
 283     data.addModule(module);
 284
 285     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 286     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 287     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("FrameAverage", module.get()));
 288     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 289 }
 290
 291 TEST_F(FrameAverageModuleTest, HandlesMultipleDataSets)
 292 {
 293     const AnalysisDataTestInput &input = MultiDataSetInputData::get();
 294     gmx::AnalysisData            data;
 295     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 296
 297     gmx::AnalysisDataFrameAverageModulePointer module(
 298             new gmx::AnalysisDataFrameAverageModule);
 299     data.addModule(module);
 300
 301     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 302     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 303     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("FrameAverage", module.get()));
 304     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 305 }
 306
 307 } // namespace