src/gromacs/math/tests/dofit.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,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 structure similarity measures rmsd and size-independent rho factor.
  38  *
  39  * \author Christian Blau <cblau@gwdg.de>
  40  * \ingroup module_math
  41  */
  42 #include "gmxpre.h"
  43
  44 #include <array>
  45
  46 #include <gtest/gtest.h>
  47
  48 #include "gromacs/math/do_fit.h"
  49 #include "gromacs/math/vec.h"
  50
  51 #include "testutils/testasserts.h"
  52
  53 namespace
  54 {
  55
  56 using gmx::RVec;
  57 using gmx::test::defaultRealTolerance;
  58 class StructureSimilarityTest : public ::testing::Test
  59 {
  60 protected:
  61     static constexpr int       c_nAtoms = 4;
  62     std::array<RVec, c_nAtoms> structureA_{ { { 1, 0, 0 }, { 0, 1, 0 }, { 0, 0, 1 }, { 0, 0, 0 } } };
  63     std::array<RVec, c_nAtoms> structureB_{ { { 0, 1, 0 }, { 0, 0, 1 }, { 1, 0, 0 }, { 0, 0, 0 } } };
  64     std::array<real, c_nAtoms> masses_{ { 1, 1, 1, 0 } };
  65     std::array<int, 3>         index_{ { 0, 1, 2 } };
  66     rvec*                      x1_ = gmx::as_rvec_array(structureA_.data());
  67     rvec*                      x2_ = gmx::as_rvec_array(structureB_.data());
  68     real*                      m_  = masses_.data();
  69 };
  70
  71 TEST_F(StructureSimilarityTest, StructureComparedToSelfHasZeroRMSD)
  72 {
  73     EXPECT_REAL_EQ_TOL(0., rmsdev(c_nAtoms, m_, x1_, x1_), defaultRealTolerance());
  74 }
  75
  76 TEST_F(StructureSimilarityTest, StructureComparedToSelfHasZeroRho)
  77 {
  78     EXPECT_REAL_EQ_TOL(0., rhodev(c_nAtoms, m_, x1_, x1_), defaultRealTolerance());
  79 }
  80
  81 TEST_F(StructureSimilarityTest, YieldsCorrectRMSD)
  82 {
  83     EXPECT_REAL_EQ_TOL(sqrt(2.0), rmsdev(c_nAtoms, m_, x1_, x2_), defaultRealTolerance());
  84 }
  85
  86 TEST_F(StructureSimilarityTest, YieldsCorrectRho)
  87 {
  88     EXPECT_REAL_EQ_TOL(2., rhodev(c_nAtoms, m_, x1_, x2_), defaultRealTolerance());
  89 }
  90
  91 TEST_F(StructureSimilarityTest, YieldsCorrectRMSDWithIndex)
  92 {
  93     EXPECT_REAL_EQ_TOL(sqrt(2.0), rmsdev_ind(index_.size(), index_.data(), m_, x1_, x2_),
  94                        defaultRealTolerance());
  95 }
  96
  97 TEST_F(StructureSimilarityTest, YieldsCorrectRhoWidthIndex)
  98 {
  99     EXPECT_REAL_EQ_TOL(2., rhodev_ind(index_.size(), index_.data(), m_, x1_, x2_), defaultRealTolerance());
 100 }
 101
 102 } // namespace