src/gromacs/analysisdata/tests/average.cpp

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