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