Added QMMMForceProvider class for QMMM MdModule
[alexxy/gromacs.git] / src / gromacs / applied_forces / qmmm / tests / qmmmforceprovider.cpp
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 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  * Tests for QMMMForceProvider class for QMMM MDModule
38  *
39  * \author Dmitry Morozov <dmitry.morozov@jyu.fi>
40  * \ingroup module_applied_forces
41  */
42 #include "gmxpre.h"
43
44 #include "gromacs/applied_forces/qmmm/qmmmforceprovider.h"
45
46 #include <vector>
47
48 #include <gtest/gtest.h>
49
50 #include "gromacs/domdec/localatomsetmanager.h"
51 #include "gromacs/fileio/confio.h"
52 #include "gromacs/gmxpreprocess/grompp.h"
53 #include "gromacs/math/vec.h"
54 #include "gromacs/pbcutil/pbc.h"
55 #include "gromacs/topology/mtop_lookup.h"
56 #include "gromacs/topology/mtop_util.h"
57 #include "gromacs/topology/topology.h"
58 #include "gromacs/utility/arrayref.h"
59 #include "gromacs/utility/path.h"
60 #include "gromacs/utility/textwriter.h"
61 #include "testutils/cmdlinetest.h"
62 #include "testutils/refdata.h"
63 #include "testutils/testasserts.h"
64 #include "testutils/testfilemanager.h"
65
66 namespace gmx
67 {
68
69 class QMMMForceProviderTest : public ::testing::Test
70 {
71 public:
72     void setDefaultParameters()
73     {
74         parameters_.active_                = true;
75         std::vector<gmx::index> qmIndicies = { 0, 1, 2 };
76         std::vector<gmx::index> mmIndicies = { 3, 4, 5 };
77         LocalAtomSet            set1 = atomSetManager_.add(ArrayRef<const gmx::index>(qmIndicies));
78         LocalAtomSet            set2 = atomSetManager_.add(ArrayRef<const gmx::index>(mmIndicies));
79         qmAtomSet_                   = std::make_unique<LocalAtomSet>(set1);
80         mmAtomSet_                   = std::make_unique<LocalAtomSet>(set2);
81     }
82
83 protected:
84     QMMMParameters                parameters_;
85     LocalAtomSetManager           atomSetManager_;
86     std::unique_ptr<LocalAtomSet> qmAtomSet_;
87     std::unique_ptr<LocalAtomSet> mmAtomSet_;
88     PbcType                       pbcType_;
89     MDLogger                      logger_;
90 };
91
92 TEST_F(QMMMForceProviderTest, CanConstructOrNot)
93 {
94     setDefaultParameters();
95
96     // GMX_CP2K is defined in CMakeList.txt trough set_source_files_properties()
97     if (GMX_CP2K)
98     {
99         // if libcp2k linked then we do not expect throws
100         EXPECT_NO_THROW(QMMMForceProvider forceProvider(
101                 parameters_, *qmAtomSet_, *mmAtomSet_, pbcType_, logger_));
102     }
103     else
104     {
105         // if libcp2k not linked then we expect throw from constructor
106         EXPECT_ANY_THROW(QMMMForceProvider forceProvider(
107                 parameters_, *qmAtomSet_, *mmAtomSet_, pbcType_, logger_));
108     }
109 }
110
111 } // namespace gmx