src/gromacs/analysisdata/tests/average.cpp

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \internal \file
  32  * \brief
  33  * Tests for functionality of analysis data averaging modules.
  34  *
  35  * These tests check that gmx::AnalysisDataAverageModule and
  36  * gmx::AnalysisDataFrameAverageModule compute averages correctly with simple
  37  * input data.
  38  * Checking is done using gmx::test::AnalysisDataTestFixture and reference
  39  * data.  Also the input data is written to the reference data to catch
  40  * out-of-date reference.
  41  *
  42  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  43  * \ingroup module_analysisdata
  44  */
  45 #include <gtest/gtest.h>
  46
  47 #include "gromacs/analysisdata/analysisdata.h"
  48 #include "gromacs/analysisdata/modules/average.h"
  49
  50 #include "testutils/datatest.h"
  51
  52 namespace
  53 {
  54
  55 using gmx::test::END_OF_FRAME;
  56 using gmx::test::MPSTOP;
  57 //! Input data for gmx::AnalysisDataAverageModule tests.
  58 const real inputdata[] = {
  59     1.0,  0.0, 1.0, 2.0, END_OF_FRAME,
  60     2.0,  1.0, 1.0, 1.0, END_OF_FRAME,
  61     3.0,  2.0, 0.0, 0.0, END_OF_FRAME
  62 };
  63 //! Multipoint input data for gmx::AnalysisDataAverageModule tests.
  64 const real mpinputdata[] = {
  65     // *INDENT-OFF*
  66     1.0,  0.0, 1.0, 2.0, MPSTOP,
  67     1.0, 0.0, MPSTOP,
  68     2.0, END_OF_FRAME,
  69     2.0,  1.0, 1.0, MPSTOP,
  70     2.0, END_OF_FRAME,
  71     3.0,  2.0, 0.0, 0.0, END_OF_FRAME
  72     // *INDENT-ON*
  73 };
  74
  75
  76 /********************************************************************
  77  * Tests for gmx::AnalysisDataAverageModule.
  78  */
  79
  80 //! Test fixture for gmx::AnalysisDataAverageModule.
  81 typedef gmx::test::AnalysisDataTestFixture AverageModuleTest;
  82
  83 TEST_F(AverageModuleTest, BasicTest)
  84 {
  85     gmx::test::AnalysisDataTestInput      input(inputdata);
  86     gmx::AnalysisData                     data;
  87     data.setColumnCount(input.columnCount());
  88     gmx::AnalysisDataAverageModulePointer module(
  89             new gmx::AnalysisDataAverageModule);
  90     data.addModule(module);
  91
  92     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
  93     ASSERT_NO_THROW(addReferenceCheckerModule("InputData", &data));
  94     ASSERT_NO_THROW(addReferenceCheckerModule("Average", module.get()));
  95     ASSERT_NO_THROW(presentAllData(input, &data));
  96 }
  97
  98 TEST_F(AverageModuleTest, HandlesMultipointData)
  99 {
 100     gmx::test::AnalysisDataTestInput input(mpinputdata);
 101     gmx::AnalysisData                data;
 102     data.setColumnCount(input.columnCount());
 103     data.setMultipoint(true);
 104     gmx::AnalysisDataAverageModulePointer module(
 105             new gmx::AnalysisDataAverageModule);
 106     data.addModule(module);
 107
 108     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 109     ASSERT_NO_THROW(addReferenceCheckerModule("InputData", &data));
 110     ASSERT_NO_THROW(addReferenceCheckerModule("Average", module.get()));
 111     ASSERT_NO_THROW(presentAllData(input, &data));
 112 }
 113
 114 TEST_F(AverageModuleTest, CanCustomizeXAxis)
 115 {
 116     gmx::test::AnalysisDataTestInput      input(inputdata);
 117     gmx::AnalysisData                     data;
 118     data.setColumnCount(input.columnCount());
 119     gmx::AnalysisDataAverageModulePointer module(new gmx::AnalysisDataAverageModule());
 120     data.addModule(module);
 121     module->setXAxis(0.5, 0.5);
 122
 123     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 124     ASSERT_NO_THROW(addReferenceCheckerModule("InputData", &data));
 125     ASSERT_NO_THROW(addReferenceCheckerModule("Average", module.get()));
 126     ASSERT_NO_THROW(presentAllData(input, &data));
 127 }
 128
 129 /********************************************************************
 130  * Tests for gmx::AnalysisDataFrameAverageModule.
 131  */
 132
 133 //! Test fixture for gmx::AnalysisDataFrameAverageModule.
 134 typedef gmx::test::AnalysisDataTestFixture FrameAverageModuleTest;
 135
 136 TEST_F(FrameAverageModuleTest, BasicTest)
 137 {
 138     gmx::test::AnalysisDataTestInput           input(inputdata);
 139     gmx::AnalysisData                          data;
 140     data.setColumnCount(input.columnCount());
 141     gmx::AnalysisDataFrameAverageModulePointer module(
 142             new gmx::AnalysisDataFrameAverageModule);
 143     data.addModule(module);
 144
 145     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 146     ASSERT_NO_THROW(addReferenceCheckerModule("InputData", &data));
 147     ASSERT_NO_THROW(addReferenceCheckerModule("FrameAverage", module.get()));
 148     ASSERT_NO_THROW(presentAllData(input, &data));
 149 }
 150
 151 } // namespace