src/gromacs/gmxpreprocess/tests/gpp_bond_atomtype.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,2021, 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  * Test routines that handle check handling of bond atom types during preprocessing.
  38  *
  39  * \author Paul Bauer <paul.bauer.q@gmail.com>
  40  */
  41 #include "gmxpre.h"
  42
  43 #include "gromacs/gmxpreprocess/gpp_bond_atomtype.h"
  44
  45 #include <gtest/gtest.h>
  46
  47 #include "gromacs/gmxpreprocess/grompp_impl.h"
  48 #include "gromacs/gmxpreprocess/notset.h"
  49 #include "gromacs/topology/atoms.h"
  50 #include "gromacs/topology/symtab.h"
  51 #include "gromacs/utility/enumerationhelpers.h"
  52
  53 class PreprocessingBondAtomTypeTest : public ::testing::Test
  54 {
  55 public:
  56     PreprocessingBondAtomTypeTest() { open_symtab(&symtab_); }
  57
  58     int addType(const char* name);
  59
  60     ~PreprocessingBondAtomTypeTest() override { done_symtab(&symtab_); }
  61
  62 protected:
  63     PreprocessingBondAtomType bat_;
  64     t_symtab                  symtab_;
  65 };
  66
  67 int PreprocessingBondAtomTypeTest::addType(const char* name)
  68 {
  69     return bat_.addBondAtomType(&symtab_, name);
  70 }
  71
  72 TEST_F(PreprocessingBondAtomTypeTest, EmptyOnCreate)
  73 {
  74     EXPECT_EQ(bat_.size(), 0);
  75 }
  76
  77 TEST_F(PreprocessingBondAtomTypeTest, IndexOutOfRangeInvalid)
  78 {
  79     EXPECT_FALSE(bat_.isSet(-1));
  80     EXPECT_FALSE(bat_.isSet(0));
  81 }
  82
  83 TEST_F(PreprocessingBondAtomTypeTest, AddTypeWorks)
  84 {
  85     EXPECT_EQ(addType("Foo"), 0);
  86     EXPECT_TRUE(bat_.isSet(0));
  87     EXPECT_EQ(bat_.size(), 1);
  88 }
  89
  90 TEST_F(PreprocessingBondAtomTypeTest, AddMultipleTypesWorks)
  91 {
  92     EXPECT_EQ(addType("Foo"), 0);
  93     EXPECT_TRUE(bat_.isSet(0));
  94     EXPECT_EQ(bat_.size(), 1);
  95     EXPECT_EQ(addType("Bar"), 1);
  96     EXPECT_TRUE(bat_.isSet(1));
  97     EXPECT_EQ(bat_.size(), 2);
  98 }
  99
 100 TEST_F(PreprocessingBondAtomTypeTest, CannotAddDuplicateEntry)
 101 {
 102     EXPECT_EQ(addType("Foo"), 0);
 103     EXPECT_TRUE(bat_.isSet(0));
 104     EXPECT_EQ(bat_.size(), 1);
 105     EXPECT_EQ(addType("Bar"), 1);
 106     EXPECT_TRUE(bat_.isSet(1));
 107     EXPECT_EQ(bat_.size(), 2);
 108     EXPECT_EQ(addType("Foo"), 0);
 109     EXPECT_FALSE(bat_.isSet(3));
 110     EXPECT_EQ(bat_.size(), 2);
 111 }
 112
 113 TEST_F(PreprocessingBondAtomTypeTest, ReturnsCorrectIndexOnDuplicateType)
 114 {
 115     EXPECT_EQ(addType("Foo"), 0);
 116     EXPECT_TRUE(bat_.isSet(0));
 117     EXPECT_EQ(bat_.size(), 1);
 118     EXPECT_EQ(addType("Bar"), 1);
 119     EXPECT_TRUE(bat_.isSet(1));
 120     EXPECT_EQ(bat_.size(), 2);
 121     EXPECT_EQ(addType("BAT"), 2);
 122     EXPECT_TRUE(bat_.isSet(2));
 123     EXPECT_EQ(bat_.size(), 3);
 124     EXPECT_EQ(addType("Bar"), 1);
 125     EXPECT_FALSE(bat_.isSet(4));
 126     EXPECT_EQ(bat_.size(), 3);
 127 }
 128
 129 TEST_F(PreprocessingBondAtomTypeTest, CorrectNameFound)
 130 {
 131     EXPECT_EQ(addType("Foo"), 0);
 132     EXPECT_EQ(bat_.bondAtomTypeFromName("Foo"), 0);
 133 }
 134
 135 TEST_F(PreprocessingBondAtomTypeTest, WrongNameNotFound)
 136 {
 137     EXPECT_EQ(addType("Foo"), 0);
 138     EXPECT_FALSE(bat_.bondAtomTypeFromName("Bar").has_value());
 139 }
 140
 141 TEST_F(PreprocessingBondAtomTypeTest, CorrectNameFromTypeNumber)
 142 {
 143     EXPECT_EQ(addType("Foo"), 0);
 144     EXPECT_EQ(addType("Bar"), 1);
 145     EXPECT_STREQ(*bat_.atomNameFromBondAtomType(0), "Foo");
 146     EXPECT_STREQ(*bat_.atomNameFromBondAtomType(1), "Bar");
 147 }
 148
 149 TEST_F(PreprocessingBondAtomTypeTest, NoNameFromIncorrectTypeNumber)
 150 {
 151     EXPECT_FALSE(bat_.atomNameFromBondAtomType(-1).has_value());
 152 }