src/gromacs/applied_forces/awh/tests/biassharing.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 #include "gmxpre.h"
  36
  37 #include "gromacs/applied_forces/awh/biassharing.h"
  38
  39 #include <gmock/gmock.h>
  40 #include <gmock/gmock-matchers.h>
  41 #include <gtest/gtest.h>
  42
  43 #include "gromacs/mdtypes/commrec.h"
  44 #include "thread_mpi/tmpi.h"
  45
  46 #include "gromacs/applied_forces/awh/tests/awh_setup.h"
  47 #include "testutils/testasserts.h"
  48
  49 namespace gmx
  50 {
  51
  52 namespace test
  53 {
  54
  55 // This test requires thread-MPI
  56 #if GMX_THREAD_MPI
  57
  58 namespace
  59 {
  60
  61 //! The number of thread-MPI ranks to run this test on
  62 const int c_numRanks = 4;
  63
  64 //! The number of simulations sharing the same bias
  65 const int c_numSharingBiases = 2;
  66
  67 /*! \brief The actual test body, executed by each MPI rank
  68  *
  69  * Sets ups sharing and sums over sahring simulations.
  70  */
  71 void parallelTestFunction(const void gmx_unused* dummy)
  72 {
  73     int numRanks;
  74     MPI_Comm_size(MPI_COMM_WORLD, &numRanks);
  75     GMX_RELEASE_ASSERT(numRanks == c_numRanks, "Expect c_numRanks thread-MPI ranks");
  76
  77     int myRank;
  78     MPI_Comm_rank(MPI_COMM_WORLD, &myRank);
  79     const int shareGroup = 1 + (myRank / c_numSharingBiases);
  80
  81     t_commrec commRecord = { 0 };
  82     commRecord.nnodes    = 1;
  83
  84     const std::vector<char> serializedAwhParametersPerDim = awhDimParamSerialized();
  85     auto              awhDimArrayRef = gmx::arrayRefFromArray(&serializedAwhParametersPerDim, 1);
  86     AwhTestParameters params = getAwhTestParameters(AwhHistogramGrowthType::ExponentialLinear,
  87                                                     AwhPotentialType::Convolved,
  88                                                     awhDimArrayRef,
  89                                                     false,
  90                                                     0.4,
  91                                                     false,
  92                                                     0.5,
  93                                                     0,
  94                                                     shareGroup);
  95
  96     BiasSharing biasSharing(params.awhParams, commRecord, MPI_COMM_WORLD);
  97
  98     EXPECT_EQ(biasSharing.numSharingSimulations(0), c_numSharingBiases);
  99     EXPECT_EQ(biasSharing.sharingSimulationIndex(0), myRank % c_numSharingBiases);
 100
 101     const std::array<int, c_numRanks> input{ 1, 2, 4, 8 };
 102     std::array<int, 1>                buffer{ input[myRank] };
 103
 104     biasSharing.sumOverMasterRanks(buffer, 0);
 105     int expectedSum = 0;
 106     for (int i = 0; i < c_numSharingBiases; i++)
 107     {
 108         expectedSum += input[(myRank / c_numSharingBiases) * c_numSharingBiases + i];
 109     }
 110     EXPECT_EQ(buffer[0], expectedSum);
 111 }
 112
 113 } // namespace
 114
 115 TEST(BiasSharingTest, SharingWorks)
 116 {
 117     if (tMPI_Init_fn(FALSE, c_numRanks, TMPI_AFFINITY_NONE, parallelTestFunction, static_cast<const void*>(this))
 118         != TMPI_SUCCESS)
 119     {
 120         GMX_THROW(gmx::InternalError("Failed to spawn thread-MPI threads"));
 121     }
 122 }
 123
 124 #endif
 125
 126 } // namespace test
 127 } // namespace gmx