Update instructions in containers.rst
[gromacs.git] / cmake / gmxTestMPI_IN_PLACE.cmake
blob54cdb1046ddf90d31dcace41b9592f42c84e41ec
2 # This file is part of the GROMACS molecular simulation package.
4 # Copyright (c) 2009,2011,2012,2014,2015 by the GROMACS development team.
5 # Copyright (c) 2016,2020, by the GROMACS development team, led by
6 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
7 # and including many others, as listed in the AUTHORS file in the
8 # top-level source directory and at http://www.gromacs.org.
10 # GROMACS is free software; you can redistribute it and/or
11 # modify it under the terms of the GNU Lesser General Public License
12 # as published by the Free Software Foundation; either version 2.1
13 # of the License, or (at your option) any later version.
15 # GROMACS is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18 # Lesser General Public License for more details.
20 # You should have received a copy of the GNU Lesser General Public
21 # License along with GROMACS; if not, see
22 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
23 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
25 # If you want to redistribute modifications to GROMACS, please
26 # consider that scientific software is very special. Version
27 # control is crucial - bugs must be traceable. We will be happy to
28 # consider code for inclusion in the official distribution, but
29 # derived work must not be called official GROMACS. Details are found
30 # in the README & COPYING files - if they are missing, get the
31 # official version at http://www.gromacs.org.
33 # To help us fund GROMACS development, we humbly ask that you cite
34 # the research papers on the package. Check out http://www.gromacs.org.
36 # - Define macro to check if MPI_IN_PLACE exists
38 #  GMX_TEST_MPI_IN_PLACE(VARIABLE)
40 #  VARIABLE will be set to true if MPI_IN_PLACE exists
43 include(CheckCSourceCompiles)
44 MACRO(GMX_TEST_MPI_IN_PLACE VARIABLE)
45   if(NOT DEFINED MPI_IN_PLACE_COMPILE_OK)
46     MESSAGE(STATUS "Checking for MPI_IN_PLACE")
48     if(CMAKE_VERSION VERSION_LESS 3.12)
49       foreach(_FLAG ${MPI_COMPILE_FLAGS})
50         set(CMAKE_REQUIRED_FLAGS "${CMAKE_REQUIRED_FLAGS} ${_FLAG}")
51       endforeach()
52     else()
53       list(JOIN MPI_COMPILE_FLAGS " " CMAKE_REQUIRED_FLAGS)
54     endif()
55     set(CMAKE_REQUIRED_INCLUDES ${MPI_INCLUDE_PATH})
56     set(CMAKE_REQUIRED_LIBRARIES ${MPI_LIBRARIES})
57     check_cxx_source_compiles(
58       "#include <mpi.h>
59 int main(void) {
60   void* buf;
61   MPI_Allreduce(MPI_IN_PLACE, buf, 10, MPI_FLOAT, MPI_SUM, MPI_COMM_WORLD);
62 }" MPI_IN_PLACE_COMPILE_OK)
64     if(MPI_IN_PLACE_COMPILE_OK)
65         MESSAGE(STATUS "Checking for MPI_IN_PLACE - yes")
66     else()
67         MESSAGE(STATUS "Checking for MPI_IN_PLACE - no")
68     endif()
69     set(MPI_IN_PLACE_COMPILE_OK "${MPI_IN_PLACE_COMPILE_OK}" CACHE INTERNAL "Result of mpi_in_place check")
70     set(CMAKE_REQUIRED_FLAGS)
71     set(CMAKE_REQUIRED_INCLUDES)
72     set(CMAKE_REQUIRED_LIBRARIES)
73   endif()
74   if (MPI_IN_PLACE_COMPILE_OK)
75     set(${VARIABLE} ${MPI_IN_PLACE_COMPILE_OK}
76       "Result of test for MPI_IN_PLACE")
77   endif()
78 ENDMACRO(GMX_TEST_MPI_IN_PLACE VARIABLE)