mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-02-25 18:55:30 -06:00
Separate build concerns for better maintainability
Introduce a main build file which uses modules in the cmake/ directory for most of its bulk work, which agains retrieve information from files in the root of the source tree (dune.module, CMakeLists_files.cmake) to get information about the project. Thus, the cmake/ directory is shared between all the projects down to the last bit; only project-specific customizations go into the main file in form of _hook macros (which are called in specific places).
This commit is contained in:
Roland Kaufmann
parent
f9c9b19c37
commit
e713e5637d
252
CMakeLists.txt
252
CMakeLists.txt
@ -1,221 +1,71 @@
|
||||
# -*- mode: cmake; tab-width: 2; indent-tabs-mode: t; truncate-lines: t; compile-command: "cmake -Wdev" -*-
|
||||
# vim: set filetype=cmake autoindent tabstop=2 shiftwidth=2 noexpandtab softtabstop=2 nowrap:
|
||||
|
||||
# Key information about the library
|
||||
set (project "opm-autodiff")
|
||||
set (${project}_NAME "${project}")
|
||||
set (${project}_DESCRIPTION "OPM module for automatic differentiation")
|
||||
set (${project}_DIR "opm")
|
||||
set (${project}_VERSION_MAJOR 1)
|
||||
set (${project}_VERSION_MINOR 0)
|
||||
set (doxy_dir "doc/doxygen")
|
||||
###########################################################################
|
||||
# #
|
||||
# Note: The bulk of the build system is located in the cmake/ directory. #
|
||||
# This file only contains the specializations for this particular #
|
||||
# project. Most likely you are interested in editing one of these #
|
||||
# files instead: #
|
||||
# #
|
||||
# dune.module Name and version number #
|
||||
# CMakeLists_files.cmake Path of source files #
|
||||
# cmake/Modules/${project}-prereqs.cmake Dependencies #
|
||||
# #
|
||||
###########################################################################
|
||||
|
||||
# Defines that must be present in config.h for our headers
|
||||
set (${project}_CONFIG_VAR
|
||||
HAVE_DYNAMIC_BOOST_TEST
|
||||
)
|
||||
|
||||
# Prerequisites
|
||||
set (${project}_DEPS
|
||||
# Compile with C99 support if available
|
||||
"C99"
|
||||
# Compile with C++0x/11 support if available
|
||||
"CXX11Features"
|
||||
# Various runtime library enhancements
|
||||
"Boost 1.39.0
|
||||
COMPONENTS system unit_test_framework REQUIRED"
|
||||
# DUNE prerequisites
|
||||
"dune-common REQUIRED;
|
||||
dune-istl REQUIRED;
|
||||
opm-core REQUIRED"
|
||||
# Eigen
|
||||
"Eigen3 3.1"
|
||||
# Tim Davis' SuiteSparse package (UMFPACK component)
|
||||
"SuiteSparse COMPONENTS umfpack"
|
||||
)
|
||||
|
||||
# Additional search modules
|
||||
set (${project}_MODULE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules")
|
||||
list (APPEND CMAKE_MODULE_PATH ${${project}_MODULE_DIR})
|
||||
|
||||
# Include special
|
||||
if (CMAKE_VERSION VERSION_LESS "2.8.5")
|
||||
message (STATUS "Enabling compatibility modules for CMake 2.8.5")
|
||||
list (APPEND CMAKE_MODULE_PATH "${${project}_MODULE_DIR}/compat-2.8.5")
|
||||
endif (CMAKE_VERSION VERSION_LESS "2.8.5")
|
||||
|
||||
if (CMAKE_VERSION VERSION_LESS "2.8.7")
|
||||
message (STATUS "Enabling compatibility modules for CMake 2.8.7")
|
||||
list (APPEND CMAKE_MODULE_PATH "${${project}_MODULE_DIR}/compat-2.8.7")
|
||||
endif (CMAKE_VERSION VERSION_LESS "2.8.7")
|
||||
|
||||
# Don't write default flags into the cache, preserve that for user set values
|
||||
include (AddOptions)
|
||||
no_default_options ()
|
||||
|
||||
# C++ project
|
||||
cmake_minimum_required (VERSION 2.8)
|
||||
project (${${project}_NAME})
|
||||
enable_language (C)
|
||||
enable_language (CXX)
|
||||
|
||||
# Print system information to better pinpoint issues from log alone
|
||||
include (UseSystemInfo)
|
||||
system_info ()
|
||||
# additional search modules
|
||||
list (APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules")
|
||||
|
||||
# Very early try to print repo id (to pinpoint version if something goes wrong)
|
||||
include (UseVCSInfo)
|
||||
vcs_info ()
|
||||
# not the same location as most of the other projects? this hook overrides
|
||||
macro (dir_hook)
|
||||
endmacro (dir_hook)
|
||||
|
||||
# Print toolchain information to identify compilers with potential bugs
|
||||
include (UseCompVer)
|
||||
compiler_info ()
|
||||
# project information is in dune.module. Read this file and set variables.
|
||||
# we cannot generate dune.module since it is read by dunecontrol before
|
||||
# the build starts, so it makes sense to keep the data there then.
|
||||
include (OpmInit)
|
||||
|
||||
# Default settings: build static debug library
|
||||
include (OpmDefaults)
|
||||
opm_defaults (${project})
|
||||
message (STATUS "Build type: ${CMAKE_BUILD_TYPE}")
|
||||
# list of prerequisites for this particular project; this is in a
|
||||
# separate file (in cmake/Modules sub-directory) because it is shared
|
||||
# with the find module
|
||||
include (${project}-prereqs)
|
||||
|
||||
# Use tricks to do faster builds
|
||||
include (UseFastBuilds)
|
||||
# read the list of components from this file (in the project directory);
|
||||
# it should set various lists with the names of the files to include
|
||||
include (CMakeLists_files.cmake)
|
||||
|
||||
# Precompiled headers
|
||||
include (UsePrecompHeaders)
|
||||
macro (config_hook)
|
||||
# opm_need_version_of ("dune-common")
|
||||
endmacro (config_hook)
|
||||
|
||||
# Optimise if we're not doing a debug build
|
||||
include (UseOptimization)
|
||||
macro (prereqs_hook)
|
||||
endmacro (prereqs_hook)
|
||||
|
||||
# Turn on all warnings; this must be done before adding any
|
||||
# prerequisites, in case they alter the list of warnings
|
||||
include (UseWarnings)
|
||||
macro (sources_hook)
|
||||
endmacro (sources_hook)
|
||||
|
||||
# Parallel computing must be explicitly enabled
|
||||
option (USE_MPI "Use Message Passing Interface for parallel computing" OFF)
|
||||
if (NOT USE_MPI)
|
||||
set (CMAKE_DISABLE_FIND_PACKAGE_MPI TRUE)
|
||||
endif (NOT USE_MPI)
|
||||
macro (fortran_hook)
|
||||
endmacro (fortran_hook)
|
||||
|
||||
### --- begin opm-autodiff specific --- ###
|
||||
# Parallel programming
|
||||
include (UseOpenMP)
|
||||
find_openmp (${project})
|
||||
### --- end opm-autodiff specific --- ###
|
||||
macro (tests_hook)
|
||||
endmacro (tests_hook)
|
||||
|
||||
# Macro to set standard variables (INCLUDE_DIRS, LIBRARIES etc.)
|
||||
include (OpmFind)
|
||||
find_and_append_package_list_to (${project} ${${project}_DEPS})
|
||||
|
||||
# Remove testing framework requirement from the main library;
|
||||
# It is not possible to query for Boost twice with different components.
|
||||
list (REMOVE_ITEM ${project}_LIBRARIES ${Boost_UNIT_TEST_FRAMEWORK_LIBRARY})
|
||||
|
||||
# Don't import more libraries than we need to
|
||||
include (UseOnlyNeeded)
|
||||
|
||||
# Put debug information into every executable
|
||||
include (UseDebugSymbols)
|
||||
|
||||
# Detect if Boost is in a shared library
|
||||
include (UseDynamicBoost)
|
||||
|
||||
# Needed for Debian installation scheme
|
||||
include (UseMultiArch)
|
||||
|
||||
# This module contains code to figure out which files is where
|
||||
include (OpmFiles)
|
||||
opm_auto_dirs ()
|
||||
|
||||
# Put libraries in lib/
|
||||
opm_out_dirs ()
|
||||
|
||||
# Identify the compilation units in the library; sources in opm/,
|
||||
# tests files in tests/, examples in examples/
|
||||
opm_sources (${project})
|
||||
|
||||
# Create configuration header which describes available features
|
||||
# necessary to compile this library. Singular version is the names that
|
||||
# is required by this project alone, plural version transitively
|
||||
# includes the necessary defines by the dependencies
|
||||
include (ConfigVars)
|
||||
list (APPEND ${project}_CONFIG_VARS ${${project}_CONFIG_VAR})
|
||||
|
||||
# Write configuration variables to this file. Note that it is a temporary.
|
||||
message (STATUS "Writing config file \"${PROJECT_BINARY_DIR}/config.h\"...")
|
||||
set (CONFIG_H "${PROJECT_BINARY_DIR}/config.h.tmp")
|
||||
configure_vars (
|
||||
FILE CXX ${CONFIG_H}
|
||||
WRITE ${${project}_CONFIG_VARS}
|
||||
)
|
||||
|
||||
# Overwrite the config.h that is used by the code only if we have some
|
||||
# real changes. Thus, we don't have to recompile if a reconfigure is run
|
||||
# due to some files being added, for instance
|
||||
execute_process (COMMAND
|
||||
${CMAKE_COMMAND} -E copy_if_different ${CONFIG_H} ${PROJECT_BINARY_DIR}/config.h
|
||||
)
|
||||
|
||||
# Compile main library; pull in all required includes and libraries
|
||||
include (OpmCompile)
|
||||
opm_compile (${project})
|
||||
# all setup common to the OPM library modules is done here
|
||||
include (OpmLibMain)
|
||||
|
||||
# download Eigen if user doesn't have the correct version
|
||||
if (NOT EIGEN3_FOUND)
|
||||
message(STATUS "Downloading Eigen3")
|
||||
include(ExternalProject)
|
||||
externalProject_Add(Eigen3
|
||||
GIT_REPOSITORY git://github.com/OPM/eigen3
|
||||
UPDATE_COMMAND git checkout 9f6cc779c101b87184076322603f496e5fdd0432
|
||||
CMAKE_ARGS -DEIGEN_TEST_NO_OPENGL=1 -DEIGEN_BUILD_PKGCONFIG=0 -DCMAKE_INSTALL_PREFIX=${CMAKE_BINARY_DIR}/eigen3-installed)
|
||||
message (STATUS "Downloading Eigen3")
|
||||
include (ExternalProject)
|
||||
externalProject_Add (Eigen3
|
||||
GIT_REPOSITORY git://github.com/OPM/eigen3
|
||||
UPDATE_COMMAND git checkout 9f6cc779c101b87184076322603f496e5fdd0432
|
||||
CMAKE_ARGS -DEIGEN_TEST_NO_OPENGL=1 -DEIGEN_BUILD_PKGCONFIG=0 -DCMAKE_INSTALL_PREFIX=${CMAKE_BINARY_DIR}/eigen3-installed
|
||||
)
|
||||
|
||||
include_directories(${CMAKE_BINARY_DIR}/eigen3-installed/include/eigen3)
|
||||
add_dependencies(opmautodiff Eigen3)
|
||||
include_directories (${CMAKE_BINARY_DIR}/eigen3-installed/include/eigen3)
|
||||
add_dependencies (opmautodiff Eigen3)
|
||||
endif (NOT EIGEN3_FOUND)
|
||||
|
||||
|
||||
# Installation target: copy the library together with debug and
|
||||
# configuration files to system directories
|
||||
include (OpmInstall)
|
||||
opm_install (${project})
|
||||
message (STATUS "This build defaults to installing in ${CMAKE_INSTALL_PREFIX}")
|
||||
|
||||
# Installation of CMake modules to help user programs locate the library
|
||||
include (OpmProject)
|
||||
opm_cmake_config (${project})
|
||||
|
||||
# Routines to build satellites such as tests, tutorials and samples
|
||||
include (OpmSatellites)
|
||||
|
||||
# Example programs are found in the examples/ directory
|
||||
opm_compile_satellites (${project} examples "" "")
|
||||
|
||||
# Infrastructure for testing
|
||||
enable_testing ()
|
||||
include (CTest)
|
||||
|
||||
# Make datafiles necessary for tests available in output directory
|
||||
opm_data (tests datafiles "${tests_DIR}")
|
||||
opm_compile_satellites (${project} tests "" "${tests_REGEXP}")
|
||||
|
||||
# Use this target to run all tests
|
||||
add_custom_target (check
|
||||
COMMAND ${CMAKE_CTEST_COMMAND}
|
||||
DEPENDS tests
|
||||
COMMENT "Checking if library is functional"
|
||||
VERBATIM
|
||||
)
|
||||
|
||||
# Generate documentation from source code with Doxygen;
|
||||
# setup install target for this documentation
|
||||
include (OpmDoc)
|
||||
opm_doc (${project} ${doxy_dir})
|
||||
|
||||
# Provide compatibility with using this build in dunecontrol
|
||||
include (DuneCompat)
|
||||
include (LibtoolArchives)
|
||||
configure_la (${project} ${${project}_TARGET} ${project}_LIBTOOL_ARCHIVE)
|
||||
|
||||
### clean in-source builds ###
|
||||
include (OpmDistClean)
|
||||
opm_dist_clean (${project})
|
||||
|
||||
### emulate the with-xxx feature of autotools;
|
||||
include (OpmKnown)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user