src/gromacs/mdrun/simulationcontext.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019,2020, 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 #include "gmxpre.h"
  37
  38 #include "simulationcontext.h"
  39
  40 #include "config.h"
  41
  42 #include <cassert>
  43
  44 #include "gromacs/mdrunutility/multisim.h"
  45 #include "gromacs/utility/gmxassert.h"
  46 #include "gromacs/utility/gmxmpi.h"
  47
  48 #include "runner.h"
  49
  50 namespace gmx
  51 {
  52 //! \cond libapi
  53 SimulationContext::SimulationContext(MPI_Comm                    communicator,
  54                                      ArrayRef<const std::string> multiSimDirectoryNames) :
  55     libraryWorldCommunicator_(communicator)
  56 {
  57     GMX_RELEASE_ASSERT((GMX_LIB_MPI && (communicator != MPI_COMM_NULL))
  58                                || (!GMX_LIB_MPI && (communicator == MPI_COMM_NULL)),
  59                        "With real MPI, a non-null communicator is required. "
  60                        "Without it, the communicator must be null.");
  61     if (multiSimDirectoryNames.empty())
  62     {
  63         simulationCommunicator_ = communicator;
  64     }
  65     else
  66     {
  67         multiSimulation_ = buildMultiSimulation(communicator, multiSimDirectoryNames);
  68         // Use the communicator resulting from the split for the multi-simulation.
  69         simulationCommunicator_ = multiSimulation_->simulationComm_;
  70     }
  71 }
  72
  73 //! \endcond
  74 } // end namespace gmx