Skip to content

Latest commit

 

History

History
120 lines (79 loc) · 2.98 KB

README.md

File metadata and controls

120 lines (79 loc) · 2.98 KB
Raw

CMake-MPIhelper

CMake 2.6 required

CMake modules to check for MPI functions.

Include into your project

To use CMake-MPIhelper, simply add this repository as git submodule into your own repository

mkdir externals
git submodule add git://github.com/RWTH-ELP/CMake-MPIhelper.git externals/CMake-MPIhelper

and adding externals/CMake-MPIhelper/cmake to your CMAKE_MODULE_PATH

set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/externals/CMake-MPIhelper/cmake" ${CMAKE_MODULE_PATH})

Usage

check_fortran_mpi_symbol_exists(symbol, variable)

Checks whether fortran MPI symbol symbol exists and stores result in variable.

Example:

find_package(CheckFortranMPISymbolExists)

check_fortran_mpi_symbol_exists(MPI_DOUBLE_COMPLEX, HAVE_MPI_DOUBLE_COMPLEX)
if (HAVE_MPI_DOUBLE_COMPLEX)
	# found MPI_DOUBLE_COMPLEX
endif ()

check_fortran_mpi_function_exists(function, variable)

Checks whether fortran MPI function function exists and stores result in variable.

Example:

find_package(CheckFortranMPIFunctionExists)

check_fortran_mpi_function_exists(MPI_INIT_THREAD, HAVE_MPI_INIT_THREAD)
if (HAVE_MPI_INIT_THREAD)
	# found HAVE_MPI_INIT_THREAD
endif ()

check_mpi_function_exists(function, variable)

Checks whether C MPI function function exists and stores result in variable.

Example:

find_package(CheckMPIFunctionExists)

check_mpi_function_exists(MPI_Init, HAVE_MPI_INIT)
if (HAVE_MPI_INIT)
	# found MPI_Init
endif ()

check_mpi_symbol_exists(symbol, variable)

Checks whether C MPI symbol symbol exists and stores result in variable.

Example:

find_package(CheckMPISymbolExists)

check_mpi_symbol_exists(MPI_LONG_LONG_INT, HAVE_MPI_LONG_LONG_INT)
if (HAVE_MPI_LONG_LONG_INT)
	# found MPI_LONG_LONG_INT
endif ()

check_mpi_symbol_is_rvalue(symbol, variable)

Checks whether C MPI symbol symbol exists, doesn't give a compiler error when used and stores result in variable.

Example:

find_package(CheckMPISymbolIsRvalue)

check_mpi_symbol_is_rvalue(MPI_UB, HAVE_MPI_UB)
if (HAVE_MPI_UB)
	# can use MPI_UB
endif ()

check_type_basic_type(type, basic_type, variable)

Sets variable to a valid basic C type derived from basic_type dependent of the size of type.

Example:

find_package(CheckTypeBasicType)

check_type_basic_type(MPI_Fint uint MPI_FINT_TYPE)
# MPI_FINT_TYPE is e.g. uint64_t

Copyright

Copyright © 2015-2021 RWTH Aachen University, Federal Republic of Germany.

See the file LICENSE in the package base directory for details.

Written by Alexander Haase.