forked from precice/precice
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCMakeLists.txt
More file actions
946 lines (778 loc) · 32.2 KB
/
Copy pathCMakeLists.txt
File metadata and controls
946 lines (778 loc) · 32.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
cmake_minimum_required (VERSION 3.22.1)
project(preCICE VERSION 3.3.1 LANGUAGES CXX)
set(preCICE_SOVERSION ${preCICE_VERSION_MAJOR})
#
# Overview of this configuration
#
# PREAMBLE
# Setup Options
# Find Mandatory Dependencies
# Find Configurable Dependencies
# Configuration of Target precice
# Configuration of Target precice-tools
# Configuration of Target testprecice
# Install Targets for precice
# CPack
#
#
# PREAMBLE
#
# Make our cmake modules visible to CMake
list (APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake")
list (APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake/modules")
include(CheckSTL)
include(CopyTargetProperty)
include(XSDKMacros)
include(Validation)
# CMake Policies
# CMP0074: find_package() uses <PackageName>_ROOT variables.
if(POLICY CMP0074)
cmake_policy(SET CMP0074 NEW)
endif()
# CMP0075 Include file check macros honor CMAKE_REQUIRED_LIBRARIES
if(POLICY CMP0075)
cmake_policy(SET CMP0075 NEW)
endif()
#
# Setup Options
#
if(NOT CMAKE_CONFIGURATION_TYPES AND NOT CMAKE_BUILD_TYPE)
message(WARNING "You did not specify a CMAKE_BUILD_TYPE in a single configuration build.
We will assume you asked for a Debug build.")
set(CMAKE_BUILD_TYPE Debug CACHE STRING "The type of this build" FORCE)
set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS Debug Release RelWithDebInfo MinSizeRel)
endif()
if (DEFINED BUILD_SHARED_LIBS AND NOT BUILD_SHARED_LIBS)
message(WARNING "You disabled BUILD_SHARED_LIBS. Note that 3.2.0 was the last release to honor this option. Newer preCICE releases always build as a shared library.")
endif()
option(PRECICE_FEATURE_MPI_COMMUNICATION "Enables MPI-based communication and running coupling tests." ON)
option(PRECICE_FEATURE_PETSC_MAPPING "Enable use of the PETSc linear algebra library for global-iterative RBF data mappings." ON)
option(PRECICE_FEATURE_PYTHON_ACTIONS "Enable Python support for preCICE actions." ON)
option(PRECICE_FEATURE_PROFILING_COMPRESSION "Enable profiling compression with LZMA." OFF)
option(PRECICE_CONFIGURE_PACKAGE_GENERATION "Configure package generation." ON)
option(PRECICE_FEATURE_GINKGO_MAPPING "Enable use of Ginkgo for accelerated data mapping." OFF)
option(PRECICE_FEATURE_KOKKOS_KERNELS_MAPPING "Enable use of Kokkos kernels for accelerated PU-RBF data mapping." OFF)
option(BUILD_TESTING "Build tests" ON)
option(PRECICE_ALWAYS_VALIDATE_LIBS "Validate libraries even after the validatation succeeded." OFF)
option(PRECICE_BINDINGS_C "Enable the native C bindings" ON)
option(PRECICE_BINDINGS_FORTRAN "Enable the native Fortran bindings" ON)
option(PRECICE_BUILD_TOOLS "Build the \"precice-tools\" executable" ON)
option(PRECICE_BUILD_UNITY "Use unity builds in preCICE" ON)
option(PRECICE_FEATURE_LIBBACKTRACE_STACKTRACES "Enable libbacktrace for stacktrace generation." OFF)
option(PRECICE_BUILD_BENCHMARKS "Build the preCICE-internal benchmarks" OFF)
option(CMAKE_INTERPROCEDURAL_OPTIMIZATION "Enable interprocedural optimization for all targets." OFF)
option(PRECICE_RELEASE_WITH_DEBUG_LOG "Enable debug logging in release builds" OFF)
option(PRECICE_RELEASE_WITH_TRACE_LOG "Enable trace logging in release builds" OFF)
option(PRECICE_RELEASE_WITH_ASSERTIONS "Enable assertions in release builds" OFF)
set(PRECICE_CXX_STANDARD "17" CACHE STRING "CXX Standard for all preCICE targets" )
option(PRECICE_HIDE_SYMBOLS "Hide non-API symbols in preCICE library" ON)
mark_as_advanced(PRECICE_HIDE_SYMBOLS PRECICE_CXX_STANDARD)
xsdk_tpl_option_override(PRECICE_FEATURE_MPI_COMMUNICATION TPL_ENABLE_MPI)
xsdk_tpl_option_override(PRECICE_FEATURE_PETSC_MAPPING TPL_ENABLE_PETSC)
xsdk_tpl_option_override(PRECICE_FEATURE_PYTHON_ACTIONS TPL_ENABLE_PYTHON)
if(PRECICE_FEATURE_PETSC_MAPPING AND NOT PRECICE_FEATURE_MPI_COMMUNICATION)
message(FATAL_ERROR "Please enable MPI to use PETSC.")
endif()
set(PRECICE_CTEST_MPI_FLAGS "" CACHE STRING "Add additional flags to mpiexec for running tests via CTest.")
include(XSDKOptions)
# Print information about this configuration
include(PrintHelper)
print_configuration(
ADDITIONAL
"PRECICE_CONFIGURE_PACKAGE_GENERATION;Configure package generation"
"PRECICE_CTEST_MPI_FLAGS;Additional CTest MPI Flags"
)
print_empty()
include(FeatureSummary)
add_feature_info(PRECICE_FEATURE_MPI_COMMUNICATION PRECICE_FEATURE_MPI_COMMUNICATION
"Enables the MPI communication back-end.
This enables the MPI communication back-end which is highly recommended on multi-node systems.
See the documentation of the CMake module FindMPI to control its functionality.
This feature can be enabled/disabled by setting the PRECICE_FEATURE_MPI_COMMUNICATION CMake option.
")
add_feature_info(PRECICE_FEATURE_PETSC_MAPPING PRECICE_FEATURE_PETSC_MAPPING
"Enables the PETSc-powered radial basic function mappings.
This enables the PETSc-based variant of radial basis function mappings which can run in parallel,
also across different compute nodes. This is highly recommended for large cases running in parallel.
This feature can be enabled/disabled by setting the PRECICE_FEATURE_PETSC_MAPPING CMake option.
Requires PRECICE_FEATURE_MPI_COMMUNICATION.
")
add_feature_info(PRECICE_FEATURE_KOKKOS_KERNELS_MAPPING PRECICE_FEATURE_KOKKOS_KERNELS_MAPPING
"Enables the Kokkos and Kokkos-kernels backend which supports the usage of GPUs or OpenMP for pum-rbf mappings.
The executor can be specified as a subtag of the mapping configuration.
This feature can be enabled/disabled by setting the PRECICE_FEATURE_KOKKOS_KERNELS_MAPPING CMake option.
Requires Kokkos-kernels and Kokkos as additional dependencies.
")
add_feature_info(PRECICE_FEATURE_GINKGO_MAPPING PRECICE_FEATURE_GINKGO_MAPPING
"Enables the Ginkgo backend which supports the usage of GPUs and OpenMP for (global) radial-basis function mappings.
Currently, this enables radial-basis function mappings to leverage the compute power of Nvidia/AMD GPUs and OpenMP.
It uses iterative solvers provided by Ginkgo or direct solvers offered by hip/cuSolver.
This feature can be enabled/disabled by setting the PRECICE_FEATURE_GINKGO_MAPPING CMake option.
Requires the Ginkgo and Kokkos as additional dependencies.
")
add_feature_info(PRECICE_FEATURE_PYTHON_ACTIONS PRECICE_FEATURE_PYTHON_ACTIONS
"Enables the support for user-defined python actions.
preCICE allows to manipulate coupling data at runtime using configurable actions.
This feature enables the support for user-defined actions written in Python based on numpy.
This feature can be enabled/disabled by setting the PRECICE_FEATURE_PYTHON_ACTIONS CMake option.
")
add_feature_info(PRECICE_BINDINGS_C PRECICE_BINDINGS_C
"Enables the native C bindings.
preCICE provides native bindings for C, which are compiled into the library.
This feature enables the compilation and installation of the bindings into the library.
Note that we strongly recommend to compile with C bindings enabled for compatibility reasons.
This feature can be enabled/disabled by setting the PRECICE_BINDINGS_C CMake option.
")
add_feature_info(PRECICE_BINDINGS_FORTRAN PRECICE_BINDINGS_FORTRAN
"Enables the native Fortran bindings.
preCICE provides native bindings for Fortran, which are compiled into the library.
This feature enables the compilation and installation of the bindings into the library.
Note that we strongly recommend to compile with Fortran bindings enabled for compatibility reasons.
This feature can be enabled/disabled by setting the PRECICE_BINDINGS_FORTRAN CMake option.
")
add_feature_info(PRECICE_BUILD_TOOLS PRECICE_BUILD_TOOLS
"Build the \"precice-tools\" executable
preCICE offers in addition to the core library a variety of tools in order to check configuration
files or generate xml references. The tools are compiled into an executable called \"precice-tools\".
This feature can be enabled/disabled by setting the PRECICE_BUILD_TOOLS CMake option.
")
add_feature_info(PRECICE_FEATURE_LIBBACKTRACE_STACKTRACES PRECICE_FEATURE_LIBBACKTRACE_STACKTRACES
"Enables libbacktrace for stracktrace generation.
preCICE assertions are helpful during development, however, the default stacktraces may not be sufficient.
This feature enables the support for libbacktrace in boost.stacktrace.
This feature can be enabled/disabled by setting the PRECICE_FEATURE_LIBBACKTRACE_STACKTRACES CMake option.
")
add_feature_info(PRECICE_FEATURE_PROFILING_COMPRESSION PRECICE_FEATURE_PROFILING_COMPRESSION
"Enables LZAM compression of profiling data.
preCICE profiling information can be useful, but in some cases the size of the rank files can become too large.
This feature enables LZMA compression of the records with the fastest preset to reduce the output sizes.
Not that this feature introduces some profiling overhead when flushing the buffered records to file.
This feature can be enabled/disabled by setting the PRECICE_FEATURE_PROFILING_COMPRESSION CMake option.
")
feature_summary(WHAT ENABLED_FEATURES DESCRIPTION "=== ENABLED FEATURES ===" QUIET_ON_EMPTY)
feature_summary(WHAT DISABLED_FEATURES DESCRIPTION "=== DISABLED FEATURES ===" QUIET_ON_EMPTY)
#
# Find Mandatory Dependencies
#
print_section("DEPENDENCIES")
find_package (Threads REQUIRED)
if(TPL_ENABLE_BOOST)
xsdk_tpl_require(BOOST BOOST_ROOT)
# Use BOOST_ROOT to set the directory
set(Boost_NO_SYSTEM_PATHS ON CACHE BOOL "" FORCE)
unset(ENV{BOOST_ROOT})
endif()
if(POLICY CMP0167)
cmake_policy(SET CMP0167 NEW)
endif()
option(Boost_USE_STATIC_LIBS "Force BoostConfig.cmake to find static libraries." OFF)
find_package(Boost 1.74.0 REQUIRED CONFIG
COMPONENTS log log_setup program_options thread unit_test_framework
)
mark_as_advanced(Boost_INCLUDE_DIR Boost_LOG_LIBRARY_RELEASE Boost_LOG_SETUP_LIBRARY_RELEASE Boost_PROGRAM_OPTIONS_LIBRARY_RELEASE Boost_SYSTEM_LIBRARY_RELEASE Boost_THREAD_LIBRARY_RELEASE Boost_UNIT_TEST_FRAMEWORK_LIBRARY_RELEASE)
mark_as_advanced(Boost_INCLUDE_DIR Boost_LOG_LIBRARY_DEBUG Boost_LOG_SETUP_LIBRARY_DEBUG Boost_PROGRAM_OPTIONS_LIBRARY_DEBUG Boost_SYSTEM_LIBRARY_DEBUG Boost_THREAD_LIBRARY_DEBUG Boost_UNIT_TEST_FRAMEWORK_LIBRARY_DEBUG)
message(STATUS "Found Boost ${Boost_VERSION}")
# Eigen
if(TPL_ENABLE_EIGEN3)
# Use EIGEN3_ROOT to set the directory
xsdk_tpl_require(EIGEN3 EIGEN3_INCLUDE_DIR)
endif()
# Try to find version 5 first and fallback to version 3.4 otherwise
find_package(Eigen3 5 NO_MODULE QUIET)
if(NOT Eigen3_FOUND)
find_package(Eigen3 3.4 REQUIRED NO_MODULE)
endif()
message(STATUS "Found Eigen ${Eigen3_VERSION}")
precice_validate_eigen()
# LibXML2
find_package(LibXml2 REQUIRED)
message(STATUS "Found LibXml2 ${LIBXML2_VERSION_STRING}")
precice_validate_libxml2()
# libfmt
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/thirdparty/fmt)
#
# Find Configurable Dependencies
#
# Option: PRECICE_FEATURE_MPI_COMMUNICATION
if (PRECICE_FEATURE_MPI_COMMUNICATION)
set(MPI_DETERMINE_LIBRARY_VERSION ON) # Try to detect the library vendor
find_package(MPI REQUIRED)
string(REGEX MATCH "^[^\n]*" PRECICE_MPI_VERSION "${MPI_CXX_LIBRARY_VERSION_STRING}")
message(STATUS "MPI Version: ${PRECICE_MPI_VERSION}")
endif()
# Option: PETSC
if (PRECICE_FEATURE_PETSC_MAPPING)
if (TPL_ENABLE_PETSC)
xsdk_tpl_require(PETSC PETSC_DIR PETSC_ARCH)
# PETSc detection uses primarily these ENVs
endif()
find_package(PETSc 3.15 REQUIRED)
# No validation required as PETSc does this internally
message(STATUS "Found PETSc ${PETSc_VERSION}")
else()
message(STATUS "PETSc support disabled")
endif()
# Common setup for Ginkgo and Kokkos Kernels
if(PRECICE_FEATURE_GINKGO_MAPPING OR PRECICE_FEATURE_KOKKOS_KERNELS_MAPPING)
find_package(Kokkos 4.1 REQUIRED)
message(STATUS "Found Kokkos version ${Kokkos_VERSION} at ${Kokkos_DIR}")
if(PRECICE_HIDE_SYMBOLS AND Kokkos_VERSION VERSION_LESS 4.4)
message(STATUS "preCICE symbol visibility turned back ON due to Kokkos < 4.4")
set(PRECICE_HIDE_SYMBOLS OFF)
endif()
include(CMakeDependentOption)
cmake_dependent_option(PRECICE_WITH_CUDA "Enable CUDA support in preCICE through Kokkos or Ginkgo" ON "Kokkos_ENABLE_CUDA AND (PRECICE_FEATURE_KOKKOS_KERNELS_MAPPING OR PRECICE_FEATURE_GINKGO_MAPPING)" OFF)
cmake_dependent_option(PRECICE_WITH_HIP "Enable HIP support in preCICE through Kokkos or Ginkgo" ON "Kokkos_ENABLE_HIP AND (PRECICE_FEATURE_KOKKOS_KERNELS_MAPPING OR PRECICE_FEATURE_GINKGO_MAPPING)" OFF)
cmake_dependent_option(PRECICE_WITH_OPENMP "Enable OpenMP support in preCICE through Kokkos or Ginkgo" ON "Kokkos_ENABLE_OPENMP AND (PRECICE_FEATURE_KOKKOS_KERNELS_MAPPING OR PRECICE_FEATURE_GINKGO_MAPPING)" OFF)
# SYCL is only supported in Kokkos-kernels currently
cmake_dependent_option(PRECICE_WITH_SYCL "Enable Kokkos SYCL support in preCICE" ON "PRECICE_FEATURE_KOKKOS_KERNELS_MAPPING;Kokkos_ENABLE_SYCL" OFF)
# Things Ginkgo and Kokkos Kernels share for the HIP setup
if(PRECICE_WITH_HIP)
include(CheckLanguage)
check_language(HIP)
enable_language(HIP)
set(CMAKE_HIP_STANDARD ${PRECICE_CXX_STANDARD})
set(CMAKE_HIP_STANDARD_REQUIRED ON)
find_package(hip REQUIRED)
endif()
endif()
# Option: Ginkgo
if (PRECICE_FEATURE_GINKGO_MAPPING)
find_package(Ginkgo 1.8.0 REQUIRED)
message(STATUS "Found Ginkgo ${GINKGO_PROJECT_VERSION} at ${Ginkgo_DIR}")
# We aim for the same configuration as Ginkgo itself and check immediately for device compiler
# such that preciceCore inherits all relevant flags directly
# 1. Check if Ginkgo was built with CUDA and if CUDA is available on the system
if(PRECICE_WITH_CUDA)
# Necessary for the unified kernels and the qr decomposition
include(CheckLanguage)
check_language(CUDA)
enable_language(CUDA)
set(CMAKE_CUDA_STANDARD ${PRECICE_CXX_STANDARD})
set(CMAKE_CUDA_STANDARD_REQUIRED ON)
set(CMAKE_CUDA_FLAGS "${GINKGO_CUDA_ARCH_FLAGS} --expt-relaxed-constexpr")
set(CMAKE_CUDA_ARCHITECTURES OFF)
endif()
# 2. Check if Ginkgo was built with HIP and if HIP is available on the system
if(PRECICE_WITH_HIP)
find_package(hipsolver REQUIRED)
find_package(hipblas REQUIRED)
endif()
if(PRECICE_WITH_OPENMP)
find_package(OpenMP 3.0 REQUIRED)
endif()
# That's essentially all backends we use from Ginkgo. The reference executor and OMP doesn't need any special treatments and
# DPCPP has not yet been tested/setup
else()
message(STATUS "Ginkgo support disabled")
endif()
if(PRECICE_FEATURE_KOKKOS_KERNELS_MAPPING)
find_package(KokkosKernels 4.1 REQUIRED)
message(STATUS "Found KokkosKernels version ${KokkosKernels_VERSION} at ${KokkosKernels_DIR}")
else()
message(STATUS "Kokkos-kernels support disabled")
endif()
if (PRECICE_BUILD_TOOLS AND BUILD_TESTING)
# We need this to run the script precice-profiling
find_package(Python3 REQUIRED COMPONENTS Interpreter)
message(STATUS "Found Python ${Python3_VERSION}")
endif()
# Option Python
if (PRECICE_FEATURE_PYTHON_ACTIONS)
find_package(Python3 REQUIRED COMPONENTS Development NumPy)
message(STATUS "Found Python ${Python3_VERSION} with NumPy ${Python3_NumPy_VERSION}")
precice_validate_libpython()
precice_validate_numpy()
else()
message(STATUS "Python support disabled")
endif()
# Option ENABLE_LIBBACKTRACE
# Note that the FindBacktrace module does not work reliably to find libbacktrace installations
if (PRECICE_FEATURE_LIBBACKTRACE_STACKTRACES)
add_subdirectory(thirdparty/libbacktrace)
endif()
# LZMA
if (PRECICE_FEATURE_PROFILING_COMPRESSION)
find_package(LibLZMA REQUIRED)
message(STATUS "Found LZMA ${LIBLZMA_VERSION_STRING}")
endif()
#
# Setup miscellaneous features
#
# Enable glibc++ assertions in debug builds
add_compile_definitions("$<$<CONFIG:DEBUG>:_GLIBCXX_ASSERTIONS>")
#
# Configuration of Target precice
#
print_empty()
print_section("TARGETS & PACKAGES")
# Core of preCICE bundling the sources and dependencies.
# The main library and tests link against this.
add_library(preciceCore OBJECT)
set_target_properties(preciceCore PROPERTIES
CXX_STANDARD ${PRECICE_CXX_STANDARD}
CXX_STANDARD_REQUIRED Yes
CXX_EXTENSIONS No
POSITION_INDEPENDENT_CODE YES
)
if(PRECICE_HIDE_SYMBOLS)
set_target_properties(preciceCore PROPERTIES
CXX_VISIBILITY_PRESET hidden
VISIBILITY_INLINES_HIDDEN YES
)
else()
set_target_properties(preciceCore PROPERTIES
CXX_VISIBILITY_PRESET default
VISIBILITY_INLINES_HIDDEN NO
)
endif()
# Setup release override options
if(PRECICE_RELEASE_WITH_DEBUG_LOG)
target_compile_definitions(preciceCore PUBLIC PRECICE_RELEASE_WITH_DEBUG_LOG)
endif()
if(PRECICE_RELEASE_WITH_TRACE_LOG)
target_compile_definitions(preciceCore PUBLIC PRECICE_RELEASE_WITH_TRACE_LOG)
endif()
if(PRECICE_RELEASE_WITH_ASSERTIONS)
target_compile_definitions(preciceCore PUBLIC PRECICE_RELEASE_WITH_ASSERTIONS)
endif()
# Setup Boost
target_compile_definitions(preciceCore PUBLIC BOOST_ALL_DYN_LINK BOOST_ASIO_ENABLE_OLD_SERVICES BOOST_GEOMETRY_DISABLE_DEPRECATED_03_WARNING)
target_link_libraries(preciceCore PUBLIC
Boost::boost
Boost::log
Boost::log_setup
Boost::program_options
Boost::thread
Boost::unit_test_framework
)
if(UNIX OR APPLE OR MINGW)
target_compile_definitions(preciceCore PUBLIC _GNU_SOURCE)
target_link_libraries(preciceCore PUBLIC ${CMAKE_DL_LIBS})
endif()
if(WIN32 OR CYGWIN)
# Required for SocketsCommunication
target_link_libraries(preciceCore PUBLIC ws2_32)
endif()
if(PRECICE_FEATURE_LIBBACKTRACE_STACKTRACES)
target_compile_definitions(preciceCore PRIVATE BOOST_STACKTRACE_USE_BACKTRACE)
target_link_libraries(preciceCore PRIVATE internal::libbacktrace)
endif()
# Force Intel compiler to honor nan and infinite and use value-preserving floating point mode
target_compile_options(preciceCore PUBLIC $<$<CXX_COMPILER_ID:IntelLLVM>:-fhonor-infinities -fhonor-nans -fp-model=precise>)
# Setup Eigen3
target_link_libraries(preciceCore PUBLIC Eigen3::Eigen)
target_compile_definitions(preciceCore PUBLIC "$<$<CONFIG:DEBUG>:EIGEN_INITIALIZE_MATRICES_BY_NAN>")
# Setup LIBXML2
target_link_libraries(preciceCore PUBLIC LibXml2::LibXml2)
# Setup FMT
target_link_libraries(preciceCore PUBLIC fmtlib-static)
# Setup MPI
if (PRECICE_FEATURE_MPI_COMMUNICATION)
target_link_libraries(preciceCore PUBLIC MPI::MPI_CXX)
else()
target_compile_definitions(preciceCore PUBLIC PRECICE_NO_MPI)
endif()
# Setup PETSC
if (PRECICE_FEATURE_PETSC_MAPPING AND PRECICE_FEATURE_MPI_COMMUNICATION)
target_link_libraries(preciceCore PUBLIC PETSc::PETSc)
else()
target_compile_definitions(preciceCore PUBLIC PRECICE_NO_PETSC)
endif()
# Common ground for any GPU support via Kokkos
if(PRECICE_FEATURE_KOKKOS_KERNELS_MAPPING OR PRECICE_FEATURE_GINKGO_MAPPING)
target_sources(preciceCore PRIVATE
src/mapping/device/Device.cpp
)
target_compile_definitions(preciceCore PUBLIC EIGEN_NO_CUDA)
# Disable compiler launcher since Kokkos ships its own nvcc wrapper
set_target_properties(preciceCore PROPERTIES CXX_COMPILER_LAUNCHER "")
if(PRECICE_WITH_CUDA)
target_compile_definitions(preciceCore PUBLIC PRECICE_WITH_CUDA)
# Required to make nvcc happy
target_compile_definitions(preciceCore PRIVATE BOOST_PP_VARIADICS=1)
target_compile_definitions(preciceCore PRIVATE BOOST_ASIO_USE_TS_EXECUTOR_AS_DEFAULT=1)
message(STATUS "Enabled CUDA support for preCICE via Kokkos.")
endif()
if(PRECICE_WITH_HIP)
target_compile_definitions(preciceCore PUBLIC PRECICE_WITH_HIP)
message(STATUS "Enabled HIP support for preCICE via Kokkos.")
endif()
if(PRECICE_WITH_SYCL)
target_compile_definitions(preciceCore PUBLIC PRECICE_WITH_SYCL)
message(STATUS "Enabled SYCL support for preCICE via Kokkos.")
endif()
if(PRECICE_WITH_OPENMP)
target_compile_definitions(preciceCore PUBLIC PRECICE_WITH_OPENMP)
message(STATUS "Enabled OpenMP support for preCICE via Kokkos.")
endif()
endif()
# Specific to Kokkos kernels
if (PRECICE_FEATURE_KOKKOS_KERNELS_MAPPING)
target_link_libraries(preciceCore PUBLIC KokkosKernels::kokkoskernels)
if(PRECICE_WITH_HIP)
target_link_libraries(preciceCore PRIVATE hip::device)
endif()
else()
target_compile_definitions(preciceCore PUBLIC PRECICE_NO_KOKKOS_KERNELS)
endif()
# Specific to Ginkgo
if (PRECICE_FEATURE_GINKGO_MAPPING)
# Next we configure the common kernels for the matrix assembly
target_sources(preciceCore PRIVATE
src/mapping/device/GinkgoRBFKernels.cpp
)
target_link_libraries(preciceCore PRIVATE Ginkgo::ginkgo)
if (NOT PRECICE_FEATURE_KOKKOS_KERNELS_MAPPING)
# Otherwise, linking to Kokkos is handled through the kernels interface
target_link_libraries(preciceCore PRIVATE Kokkos::kokkos)
endif()
# Now we setup cuSolver and hipSOLVER for preCICE
if(PRECICE_WITH_CUDA)
target_sources(preciceCore PRIVATE ${PROJECT_SOURCE_DIR}/src/mapping/device/CudaQRSolver.cuh ${PROJECT_SOURCE_DIR}/src/mapping/device/CudaQRSolver.cu)
target_link_libraries(preciceCore PRIVATE cusolver cublas)
endif()
if(PRECICE_WITH_HIP)
set(_hiplist ${PROJECT_SOURCE_DIR}/src/mapping/device/HipQRSolver.hip.cpp)
set_source_files_properties(${_hiplist} PROPERTIES LANGUAGE HIP)
target_sources(preciceCore PRIVATE ${_hiplist})
target_link_libraries(preciceCore PRIVATE hip::device Ginkgo::ginkgo roc::hipsolver roc::hipblas)
endif()
if(PRECICE_WITH_OPENMP)
target_link_libraries(preciceCore PUBLIC OpenMP::OpenMP_CXX)
# There is nothing special required for OpenMP, looking for OpenMP and setting the flag is handled by the unified kernels
endif()
# Finally, we link Ginkgo into preCICE
target_link_libraries(preciceCore PUBLIC Ginkgo::ginkgo)
else()
target_compile_definitions(preciceCore PUBLIC PRECICE_NO_GINKGO)
endif()
# Option Python
if (PRECICE_FEATURE_PYTHON_ACTIONS)
target_link_libraries(preciceCore PUBLIC Python3::NumPy Python3::Python)
target_compile_definitions(preciceCore PUBLIC NPY_NO_DEPRECATED_API=NPY_1_7_API_VERSION)
else()
target_compile_definitions(preciceCore PUBLIC PRECICE_NO_PYTHON)
endif()
# Setup profiling compression
if (PRECICE_FEATURE_PROFILING_COMPRESSION)
target_link_libraries(preciceCore PUBLIC LibLZMA::LibLZMA)
target_compile_definitions(preciceCore PUBLIC PRECICE_COMPRESSION)
endif()
# Includes configuration for the core
target_include_directories(preciceCore PUBLIC
$<BUILD_INTERFACE:${preCICE_SOURCE_DIR}/src>
$<BUILD_INTERFACE:${preCICE_BINARY_DIR}/src>
$<INSTALL_INTERFACE:include>
)
# Add precice as an empty target
add_library(precice SHARED)
set_target_properties(precice PROPERTIES
VERSION ${preCICE_VERSION}
SOVERSION ${preCICE_SOVERSION}
)
if(PRECICE_HIDE_SYMBOLS)
set_target_properties(precice PROPERTIES
CXX_VISIBILITY_PRESET hidden
VISIBILITY_INLINES_HIDDEN YES
)
else()
set_target_properties(precice PROPERTIES
CXX_VISIBILITY_PRESET default
VISIBILITY_INLINES_HIDDEN NO
)
endif()
target_include_directories(precice PUBLIC
$<BUILD_INTERFACE:${preCICE_SOURCE_DIR}/src>
$<BUILD_INTERFACE:${preCICE_BINARY_DIR}/src>
$<INSTALL_INTERFACE:include>
)
target_link_libraries(precice PRIVATE preciceCore)
# Sources Configuration
include(${CMAKE_CURRENT_LIST_DIR}/src/sources.cmake)
# File Configuration
configure_file("${PROJECT_SOURCE_DIR}/src/precice/impl/versions.hpp.in" "${PROJECT_BINARY_DIR}/src/precice/impl/versions.hpp" @ONLY)
configure_file("${PROJECT_SOURCE_DIR}/src/testing/SourceLocation.hpp.in" "${PROJECT_BINARY_DIR}/src/testing/SourceLocation.hpp" @ONLY)
configure_file("${PROJECT_SOURCE_DIR}/src/precice/Version.h.in" "${PROJECT_BINARY_DIR}/src/precice/Version.h" @ONLY)
if(PRECICE_BUILD_UNITY)
set_target_properties(preciceCore PROPERTIES
UNITY_BUILD Yes
UNITY_BUILD_MODE GROUP
)
get_target_property(_precice_sources preciceCore SOURCES)
foreach(SOURCE_FILE IN LISTS _precice_sources)
if(SOURCE_FILE MATCHES "^src/([a-z0-9]+)/")
set_source_files_properties(${SOURCE_FILE} PROPERTIES UNITY_GROUP "${CMAKE_MATCH_1}")
endif()
endforeach()
unset(_precice_sources)
endif()
# Configure version file generation
include(GenerateVersionInformation)
# Configure CMake variables only. The result contains a placeholder for the git revision
configure_file("${PROJECT_SOURCE_DIR}/src/precice/impl/versions.cpp.in" "${PROJECT_BINARY_DIR}/src/precice/impl/versions.cpp.in" @ONLY)
# Dynamically replace the git revision information.
include(${CMAKE_CURRENT_LIST_DIR}/cmake/DetectGitRevision.cmake)
# Setup export header
include(GenerateExportHeader)
GENERATE_EXPORT_HEADER(preciceCore
EXPORT_FILE_NAME "src/precice/export.h"
BASE_NAME PRECICE
EXPORT_MACRO_NAME PRECICE_API
INCLUDE_GUARD_NAME PRECICE_EXPORT
)
# Workaround for making exports work for the preciceCore object library when building preCICE as a shared library
target_compile_definitions(preciceCore PUBLIC preciceCore_EXPORTS)
# Add the export header to the public headers of the preCICE lib
set_property(TARGET precice APPEND PROPERTY PUBLIC_HEADER
${PROJECT_BINARY_DIR}/src/precice/export.h)
#
# Configuration of precice tools
#
if (PRECICE_BUILD_TOOLS)
macro(precice_add_tool TARGET MAIN)
add_executable(${TARGET} ${MAIN})
target_link_libraries(${TARGET}
PRIVATE
precice
)
set_target_properties(${TARGET} PROPERTIES
CXX_STANDARD ${PRECICE_CXX_STANDARD}
CXX_STANDARD_REQUIRED Yes
CXX_EXTENSIONS No
)
endmacro()
precice_add_tool(precice-tools "src/drivers/main.cpp")
precice_add_tool(precice-config-doc "src/drivers/doc.cpp")
precice_add_tool(precice-config-validate "src/drivers/validate.cpp")
precice_add_tool(precice-version "src/drivers/version.cpp")
endif()
#
# Configuration of Target testprecice
#
IF (BUILD_TESTING)
add_executable(testprecice "src/testing/main.cpp")
target_link_libraries(testprecice
PRIVATE
preciceCore
)
set_target_properties(testprecice PROPERTIES
CXX_STANDARD ${PRECICE_CXX_STANDARD}
CXX_STANDARD_REQUIRED Yes
CXX_EXTENSIONS No
ENABLE_EXPORTS Yes
)
target_include_directories(testprecice PRIVATE
${preCICE_SOURCE_DIR}/src
${preCICE_SOURCE_DIR}/tests
)
message(STATUS "Including test sources")
# Test Sources Configuration
include(${CMAKE_CURRENT_LIST_DIR}/src/tests.cmake)
include(${CMAKE_CURRENT_LIST_DIR}/tests/tests.cmake)
if(PRECICE_BUILD_UNITY)
set_target_properties(testprecice PROPERTIES
UNITY_BUILD Yes
UNITY_BUILD_MODE GROUP
)
# Add integration tests from tests/ sources to a single unity group
get_target_property(_testprecice_sources testprecice SOURCES)
foreach(SOURCE_FILE IN LISTS _testprecice_sources)
if(SOURCE_FILE MATCHES "^src/([a-z0-9]+)/tests?/")
set(group "${CMAKE_MATCH_1}")
# The SocketCommunication includes boost/asio.hpp which clashes with the precice::query namespace.
# We exclude that one test for the sake of simplicity
if(NOT SOURCE_FILE MATCHES "SocketCommunicationTest.cpp$")
set_source_files_properties(${SOURCE_FILE} PROPERTIES UNITY_GROUP "${group}")
endif()
elseif(SOURCE_FILE MATCHES "^src/testing/")
set_source_files_properties(${SOURCE_FILE} PROPERTIES UNITY_GROUP "testing")
elseif(SOURCE_FILE MATCHES "^tests/")
set_source_files_properties(${SOURCE_FILE} PROPERTIES UNITY_GROUP "integration")
endif()
endforeach()
endif()
else(BUILD_TESTING)
message(STATUS "Excluding test sources")
endif(BUILD_TESTING)
# Include Native C Bindings
if (PRECICE_BINDINGS_C)
# include(${CMAKE_CURRENT_LIST_DIR}/extras/bindings/c/CMakeLists.txt)
add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/extras/bindings/c)
endif()
# Include Native Fortran Bindings
if (PRECICE_BINDINGS_FORTRAN)
# include((${CMAKE_CURRENT_LIST_DIR}/extras/bindings/fortran/CMakeLists.txt)
add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/extras/bindings/fortran)
endif()
# Build benchmarks if enabled
if(PRECICE_BUILD_BENCHMARKS)
find_package(benchmark REQUIRED)
add_executable(precice-bench)
include(${CMAKE_CURRENT_LIST_DIR}/benchmarks/sources.cmake)
target_link_libraries(precice-bench
PRIVATE
preciceCore
benchmark::benchmark
)
set_target_properties(precice-bench PROPERTIES
CXX_STANDARD ${PRECICE_CXX_STANDARD}
CXX_STANDARD_REQUIRED Yes
CXX_EXTENSIONS No
)
target_include_directories(precice-bench PRIVATE
${preCICE_SOURCE_DIR}/src
${preCICE_SOURCE_DIR}/benchmark
)
endif()
#
# Install Targets for precice
#
# Setup General Install for:
# precice - the library
# precice-tools - the precice binary
include(GNUInstallDirs)
install(TARGETS precice
EXPORT preciceTargets
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/precice
INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/precice
)
if(PRECICE_BUILD_TOOLS)
install(TARGETS precice-tools precice-version precice-config-validate precice-config-doc
EXPORT preciceTargets
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
)
install(PROGRAMS ${preCICE_SOURCE_DIR}/tools/profiling/precice-profiling
DESTINATION ${CMAKE_INSTALL_BINDIR})
endif()
# Install examples
install(DIRECTORY examples
DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/precice
PATTERN ".gitignore" EXCLUDE
)
# Export the Targets to install
install(EXPORT preciceTargets
FILE preciceTargets.cmake
NAMESPACE precice::
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/precice
)
# Generate a Package Config File for precice
include(CMakePackageConfigHelpers)
write_basic_package_version_file("preciceConfigVersion.cmake"
VERSION ${preCICE_VERSION}
COMPATIBILITY SameMajorVersion
)
# Install the Config and the ConfigVersion files
install(FILES "cmake/preciceConfig.cmake" "${preCICE_BINARY_DIR}/preciceConfigVersion.cmake"
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/precice
)
# Setup the config in the build directory
export(EXPORT preciceTargets
NAMESPACE precice::
FILE "preciceTargets.cmake")
file(COPY "cmake/preciceConfig.cmake"
DESTINATION "${preCICE_BINARY_DIR}")
# Add an alias to allow subprojects to use the namespaced name
add_library(precice::precice ALIAS precice)
# Set the directory used to prepare files for packaging
set(PRECICE_PACKAGING_DIR "${CMAKE_CURRENT_BINARY_DIR}/packaging")
mark_as_advanced(PRECICE_PACKAGING_DIR)
# Compress and install the manpages
find_program(GZIP_EXE gzip DOC "The gzip executable")
if(GZIP_EXE)
# Process manpages for binaries
file(COPY docs/man/man1/precice-tools.1 docs/man/man1/precice-version.1 docs/man/man1/precice-config-validate.1 docs/man/man1/precice-config-doc.1 DESTINATION packaging/man1)
file(GLOB PRECICE_MAN_PAGES "${PRECICE_PACKAGING_DIR}/man1/*.1")
foreach(manpage ${PRECICE_MAN_PAGES})
message(STATUS "Compressing manpage: ${manpage}")
execute_process(COMMAND "${GZIP_EXE}" "-9nf" "${manpage}")
endforeach()
# Install compressed manpages
install(DIRECTORY ${PRECICE_PACKAGING_DIR}/man1
DESTINATION ${CMAKE_INSTALL_MANDIR}
)
else()
message(WARNING "Installing uncompressed manpages")
# Install uncompressed manpages
install(DIRECTORY docs/man/man1
DESTINATION ${CMAKE_INSTALL_MANDIR}
)
endif()
# Configure the pkg-config file for the binary directory
set(_precice_bindings "")
if (PRECICE_BINDINGS_C)
set(_precice_bindings "-I${PROJECT_SOURCE_DIR}/extras/bindings/c/include")
endif()
configure_file(
"${PROJECT_SOURCE_DIR}/cmake/binary.pc.in"
"libprecice.pc"
@ONLY
)
unset(_precice_bindings)
# Configure the pkg-config file for the installation
configure_file(
"${PROJECT_SOURCE_DIR}/cmake/install.pc.in"
"lib/pkgconfig/libprecice.pc"
@ONLY
)
install(DIRECTORY "${preCICE_BINARY_DIR}/lib/pkgconfig"
DESTINATION ${CMAKE_INSTALL_LIBDIR}
)
#
# Add uninstall
#
include(${CMAKE_CURRENT_LIST_DIR}/cmake/Uninstall.cmake)
#
# CPack
#
if (PRECICE_CONFIGURE_PACKAGE_GENERATION)
include(${CMAKE_CURRENT_LIST_DIR}/cmake/CPackConfig.cmake)
endif()
#
# CTest
#
if (BUILD_TESTING)
print_empty()
print_section("TESTS")
include(${CMAKE_CURRENT_LIST_DIR}/cmake/CTestConfig.cmake)
#
# Add test_install
#
include(${CMAKE_CURRENT_LIST_DIR}/cmake/TestInstall.cmake)
endif()
#
# Tooling
#
add_custom_target(
doxygen
COMMAND doxygen
WORKING_DIRECTORY ${preCICE_SOURCE_DIR}
USES_TERMINAL
)
add_custom_target(
format
COMMAND tools/formatting/format-all
WORKING_DIRECTORY ${preCICE_SOURCE_DIR}
USES_TERMINAL
)
add_custom_target(
sourcesIndex
COMMAND tools/building/updateSourceFiles.py
WORKING_DIRECTORY ${preCICE_SOURCE_DIR}
USES_TERMINAL
)
add_custom_target(
changelog
COMMAND tools/building/createChangelog
WORKING_DIRECTORY ${preCICE_SOURCE_DIR}
USES_TERMINAL
)
add_custom_target(
tidy
COMMAND tools/linting/run_clang_tidy.sh
WORKING_DIRECTORY ${preCICE_SOURCE_DIR}
USES_TERMINAL
)