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 namespace
  58 {
  59
  60 using gmx::test::END_OF_FRAME;
  61 using gmx::test::MPSTOP;
  62 //! Input data for gmx::AnalysisDataAverageModule tests.
  63 const real inputdata[] = {
  64     1.0,  0.0, 1.0, 2.0, END_OF_FRAME,
  65     2.0,  1.0, 1.0, 1.0, END_OF_FRAME,
  66     3.0,  2.0, 0.0, 0.0, END_OF_FRAME
  67 };
  68 //! Multipoint input data for gmx::AnalysisDataAverageModule tests.
  69 const real mpinputdata[] = {
  70 /* *INDENT-OFF* */
  71     1.0,  0.0, 1.0, 2.0, MPSTOP,
  72           1.0, 0.0, MPSTOP,
  73           2.0, END_OF_FRAME,
  74     2.0,  1.0, 1.0, MPSTOP,
  75           2.0, END_OF_FRAME,
  76     3.0,  2.0, 0.0, 0.0, END_OF_FRAME
  77 /* *INDENT-ON* */
  78 };
  79
  80
  81 /********************************************************************
  82  * Tests for gmx::AnalysisDataAverageModule.
  83  */
  84
  85 //! Test fixture for gmx::AnalysisDataAverageModule.
  86 typedef gmx::test::AnalysisDataTestFixture AverageModuleTest;
  87
  88 TEST_F(AverageModuleTest, BasicTest)
  89 {
  90     gmx::test::AnalysisDataTestInput      input(inputdata);
  91     gmx::AnalysisData                     data;
  92     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
  93
  94     gmx::AnalysisDataAverageModulePointer module(
  95             new gmx::AnalysisDataAverageModule);
  96     data.addModule(module);
  97
  98     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
  99     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 100     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 101     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 102 }
 103
 104 TEST_F(AverageModuleTest, HandlesMultipointData)
 105 {
 106     gmx::test::AnalysisDataTestInput input(mpinputdata);
 107     gmx::AnalysisData                data;
 108     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 109
 110     gmx::AnalysisDataAverageModulePointer module(
 111             new gmx::AnalysisDataAverageModule);
 112     data.addModule(module);
 113
 114     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 115     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 116     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 117     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 118 }
 119
 120 TEST_F(AverageModuleTest, CanCustomizeXAxis)
 121 {
 122     gmx::test::AnalysisDataTestInput      input(inputdata);
 123     gmx::AnalysisData                     data;
 124     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 125
 126     gmx::AnalysisDataAverageModulePointer module(new gmx::AnalysisDataAverageModule());
 127     data.addModule(module);
 128     module->setXAxis(0.5, 0.5);
 129
 130     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 131     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 132     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("Average", module.get()));
 133     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 134 }
 135
 136 /********************************************************************
 137  * Tests for gmx::AnalysisDataFrameAverageModule.
 138  */
 139
 140 //! Test fixture for gmx::AnalysisDataFrameAverageModule.
 141 typedef gmx::test::AnalysisDataTestFixture FrameAverageModuleTest;
 142
 143 TEST_F(FrameAverageModuleTest, BasicTest)
 144 {
 145     gmx::test::AnalysisDataTestInput           input(inputdata);
 146     gmx::AnalysisData                          data;
 147     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 148
 149     gmx::AnalysisDataFrameAverageModulePointer module(
 150             new gmx::AnalysisDataFrameAverageModule);
 151     data.addModule(module);
 152
 153     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 154     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("InputData", &data));
 155     ASSERT_NO_THROW_GMX(addReferenceCheckerModule("FrameAverage", module.get()));
 156     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 157 }
 158
 159 } // namespace