api/gmxapi/cpp/tests/context.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019,2020,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
  36 /*! \file
  37  * \brief Test gmxapi::Context
  38  *
  39  * Provides additional test coverage of template headers only used by client code.
  40  */
  41
  42 #include "gromacs/utility/gmxmpi.h"
  43
  44 #include "gmxapi/context.h"
  45 #include "gmxapi/mpi/gmxapi_mpi.h"
  46 #include "testingconfiguration.h"
  47
  48
  49 namespace gmxapi
  50 {
  51
  52 namespace testing
  53 {
  54
  55 namespace
  56 {
  57
  58 TEST_F(GmxApiTest, AllContext)
  59 {
  60     // Default Implicit COMM_WORLD for MPI builds.
  61     EXPECT_NO_THROW(auto context = createContext());
  62 }
  63
  64 #if GMX_LIB_MPI
  65 TEST_F(GmxApiTest, NullContext)
  66 {
  67     // Explicit COMM_NULL is not supported.
  68     EXPECT_ANY_THROW(assignResource(MPI_COMM_NULL));
  69 }
  70
  71 TEST_F(GmxApiTest, MpiWorldContext)
  72 {
  73     // Note that this test is only compiled when GMX_MPI is enabled for the
  74     // build tree, so we cannot unit test the behavior of non-MPI GROMACS
  75     // provided with MPI-enabled Context. For that, we defer to the Python
  76     // package testing.
  77     // Note also that the code should look the same for tMPI or regular MPI.
  78
  79     // Explicit COMM_WORLD.
  80     auto resources = assignResource(MPI_COMM_WORLD);
  81     EXPECT_TRUE(resources->size() != 0);
  82
  83     // Store the rank for debugging convenience.
  84     [[maybe_unused]] auto rank = resources->rank();
  85
  86     auto context = createContext(*resources);
  87 }
  88
  89 TEST_F(GmxApiTest, MpiSplitContext)
  90 {
  91     // Explicit sub-communicator.
  92     MPI_Comm communicator = MPI_COMM_NULL;
  93     int      rank{ 0 };
  94     MPI_Comm_rank(MPI_COMM_WORLD, &rank);
  95     // Run each rank as a separate ensemble member.
  96     MPI_Comm_split(MPI_COMM_WORLD, rank, rank, &communicator);
  97     EXPECT_NO_THROW(auto context = createContext(*assignResource(communicator)));
  98 }
  99 #endif
 100
 101 } // end anonymous namespace
 102
 103 } // end namespace testing
 104
 105 } // end namespace gmxapi