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