Environment variable docs maintenance
[gromacs.git] / cmake / gmxTestMPI_IN_PLACE.cmake
blob1d53dae33bbc36e782c27a101568d31137775335
2 # This file is part of the GROMACS molecular simulation package.
4 # Copyright (c) 2009,2011,2012,2014,2015,2016, 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.
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.
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.
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.
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.
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.
35 # - Define macro to check if MPI_IN_PLACE exists
37 #  GMX_TEST_MPI_IN_PLACE(VARIABLE)
39 #  VARIABLE will be set to true if MPI_IN_PLACE exists
42 include(CheckCSourceCompiles)
43 MACRO(GMX_TEST_MPI_IN_PLACE VARIABLE)
44   if(NOT DEFINED MPI_IN_PLACE_COMPILE_OK)
45     MESSAGE(STATUS "Checking for MPI_IN_PLACE")
47     set(CMAKE_REQUIRED_FLAGS ${MPI_COMPILE_FLAGS})
48     set(CMAKE_REQUIRED_INCLUDES ${MPI_INCLUDE_PATH})
49     set(CMAKE_REQUIRED_LIBRARIES ${MPI_LIBRARIES})
50     check_cxx_source_compiles(
51       "#include <mpi.h>
52 int main(void) {
53   void* buf;
54   MPI_Allreduce(MPI_IN_PLACE, buf, 10, MPI_FLOAT, MPI_SUM, MPI_COMM_WORLD);
55 }" MPI_IN_PLACE_COMPILE_OK)
57     if(MPI_IN_PLACE_COMPILE_OK)
58         MESSAGE(STATUS "Checking for MPI_IN_PLACE - yes")
59     else()
60         MESSAGE(STATUS "Checking for MPI_IN_PLACE - no")
61     endif()
62     set(MPI_IN_PLACE_COMPILE_OK "${MPI_IN_PLACE_COMPILE_OK}" CACHE INTERNAL "Result of mpi_in_place check")
63     set(CMAKE_REQUIRED_FLAGS)
64     set(CMAKE_REQUIRED_INCLUDES)
65     set(CMAKE_REQUIRED_LIBRARIES)
66   endif()
67   if (MPI_IN_PLACE_COMPILE_OK)
68     set(${VARIABLE} ${MPI_IN_PLACE_COMPILE_OK}
69       "Result of test for MPI_IN_PLACE")
70   endif()
71 ENDMACRO(GMX_TEST_MPI_IN_PLACE VARIABLE)