[CMake] Provide out-of-source build by jijn · Pull Request #768 · prisms-center/phaseField

jijn · 2026-01-08T07:51:01Z

Provide out-of-source build. This fixes #767.

landinjm · 2026-01-12T14:52:35Z

src/core/CMakeLists.txt

+            $<BUILD_INTERFACE:${CMAKE_BINARY_DIR}/src>
+    )
+endforeach()
+


I fail to see why this section is needed. Aren't the includes already being added to path later down the line?

The source code looks like:
#include <prismspf/core/conditional_ostreams.h>

The old one actually includes
${CMAKE_SOURCE_DIR}/include/prismspf/core/*.h

What you want to include is
${CMAKE_SOURCE_DIR}/include/

so it can find
prismspf/core/*.h

Instead, can we add the following lines to cmake/macros/macro_define_library.cmake

target_include_directories(${_target} SYSTEM PRIVATE ${CMAKE_BINARY_DIR}/include ${CMAKE_SOURCE_DIR}/include ${CMAKE_BINARY_DIR}/src )

That should do the trick and prevent code duplication

okay, I can do this.

Tried this, got the error:

[ 38%] Building CXX object CMakeFiles/prisms_pf_debug.dir/src/core/constraint_handler.cc.o /usr/bin/c++ -DBOOST_ATOMIC_DYN_LINK -DBOOST_ATOMIC_NO_LIB -DBOOST_IOSTREAMS_DYN_LINK -DBOOST_IOSTREAMS_NO_LIB -DBOOST_SERIALIZATION_DYN_LINK -DBOOST_SERIALIZATION_NO_LIB -DBOOST_SYSTEM_DYN_LINK -DBOOST_SYSTEM_NO_LIB -DBOOST_THREAD_DYN_LINK -DBOOST_THREAD_NO_LIB -DDEBUG -D_GLIBCXX_ASSERTIONS -I/mnt/c/Users/xxx/phaseField/include -I/mnt/c/Users/xxx/phaseField/src -isystem /home/xxx/vtk-install/include/vtk-9.6 -isystem /home/xxx/dealii-candi/deal.II-v9.7.0/include -isystem /home/xxx/dealii-candi/deal.II-v9.7.0/include/deal.II/bundled -isystem /usr/lib/x86_64-linux-gnu/openmpi/include -isystem /usr/lib/x86_64-linux-gnu/openmpi/include/openmpi -isystem /usr/include/suitesparse -isystem /home/xxx/dealii-candi/hdf5-1.12.2/include -isystem /home/xxx/dealii-candi/p4est-2.3.6/FAST/include -std=c++20 -Wall -Wextra -Wpedantic -Wshadow -Wnon-virtual-dtor -Wold-style-cast -Wcast-align -Wunused -Woverloaded-virtual -Wnull-dereference -Wdouble-promotion -Wformat=2 -Wimplicit-fallthrough -Wmisleading-indentation -Wduplicated-cond -Wduplicated-branches -Wlogical-op -Wuseless-cast -fopenmp-simd -march=native -O0 -ggdb -Wa,--compress-debug-sections -MD -MT CMakeFiles/prisms_pf_debug.dir/src/core/constraint_handler.cc.o -MF CMakeFiles/prisms_pf_debug.dir/src/core/constraint_handler.cc.o.d -o CMakeFiles/prisms_pf_debug.dir/src/core/constraint_handler.cc.o -c /mnt/c/Users/xxx/phaseField/src/core/constraint_handler.cc /mnt/c/Users/xxx/phaseField/src/core/constraint_handler.cc:690:10: fatal error: core/constraint_handler.inst: No such file or directory 690 | #include "core/constraint_handler.inst" | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ compilation terminated. make[2]: *** [CMakeFiles/prisms_pf_debug.dir/build.make:90: CMakeFiles/prisms_pf_debug.dir/src/core/constraint_handler.cc.o] Error 1 make[2]: Leaving directory '/mnt/c/Users/xxx/phaseField/build' make[1]: *** [CMakeFiles/Makefile2:343: CMakeFiles/prisms_pf_debug.dir/all] Error 2 make[1]: Leaving directory '/mnt/c/Users/xxx/phaseField/build' make: *** [Makefile:136: all] Error 2

It includes two folders

-I/mnt/c/Users/xxx/phaseField/include -I/mnt/c/Users/xxx/phaseField/src

but it want to find
/build/src/core/constraint_handler.inst

The issue has been resolved in the latest commit 9e29f6f

applications/MgNd_precipitate_single_Bppp/CMakeLists.txt

landinjm · 2026-01-12T20:04:44Z

applications/MgNd_precipitate_single_Bppp/CMakeLists.txt

+    set_target_properties(
+        main-debug main-release
+        PROPERTIES
+        RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}


I don't think we should include this in this PR. Out-of-source application builds are another topics

I can split it to a separate PR

I suggest to include this. First, it won't affect current in-source build. Second, it is unnecessary to have a separate PR.

landinjm · 2026-01-12T20:06:20Z

CMakeLists.txt

 configure_file(
    ${CMAKE_SOURCE_DIR}/include/prismspf/config.h.in
-    ${CMAKE_BINARY_DIR}/include/prismspf/config.h
+    ${CMAKE_SOURCE_DIR}/include/prismspf/config.h


Can these two configure files calls be

configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/include/prismspf/config.h.in ${CMAKE_CURRENT_BINARY_DIR}/include/prismspf/config.h )

This will give them in the build directory as intended.

I now put "config.h" in the install directory instead of the build directory. In this case, we can completely separate the source/build directory from the install directory. Now we can build applications solely with the install directory.

landinjm · 2026-01-12T20:08:01Z

cmake/macros/macro_expand_template_instantiations.cmake

        else()
            # We're in the main project context, use current binary dir
-            set(_main_build_dir ${CMAKE_BINARY_DIR})
+            set(_main_build_dir ${CMAKE_SOURCE_DIR})


We don't actually need to change this if we keep everything with respect to the binary dir

I believe this impacts the application build, as it cannot locate headers within PRISMS_BINARY_DIR/include. That's why I moved config.h to the PRISMS source directory. If there is a way to expose PRISMS_BINARY_DIR to the application build, I am happy to revert this change.

I now move config.h to the install directory

jijn · 2026-01-13T20:25:23Z

What I did:

fix the code duplication problem, revert those changes in src/xxx/CmakeLists.txt
remove all dependency on files in the PRISMS source/build folder
I didn't remove the C dependency to make sure we can successfully build the applications. You can fix this in a separate PR.

Now we can compile applications solely rely on the installed library. You can delete the source code folder 'phaseField' completely without affecting the application build.

This is done by

clean the dependency on files in the source folder or the build folder
generate and put config.h to install_dir
copy VERSION to install_dir
copy cmake/ to install_dir
point all macros such as PRISMS_PF_SOURCE_DIR to install_dir

include files are now installed to install_dir/include/prismspf/xxx.h instead of install_dir/include/prismspf/prismspf/xxx.h

I didn't separate the out-of-source application builds, since it is wired that we cannot support both. This code wouldn't break current in-source build.

landinjm · 2026-01-19T15:11:32Z

Once merge conflicts are fixed this can be merged

jijn · 2026-01-19T20:33:41Z

The following commits should fix the application build error.

jijn added 2 commits January 8, 2026 02:42

[CMake] Provide out-of-source build

fbdb9e9

remove unused code

9906c15

jijn mentioned this pull request Jan 8, 2026

more installation docs #766

Merged

$@fractalsbyx$ fractalsbyx requested a review from landinjm January 8, 2026 18:34

$@fractalsbyx$ fractalsbyx added Status: Good first issue Install: General Status: ⚠ Medium Priority Status: Needs review labels Jan 8, 2026

landinjm reviewed Jan 12, 2026

View reviewed changes

update those under tests

517f10c

landinjm requested changes Jan 12, 2026

View reviewed changes

jijn added 2 commits January 13, 2026 15:08

prevent code duplication

892dc11

Clean dependency on PRISMS source directory

9e29f6f

jijn added 3 commits January 14, 2026 12:56

installed to a single cmake folder, clean CMakeLists.txt

cde660c

fix application build after relocating cmake

ab5ad5c

install LICENSE file

e394394

landinjm self-requested a review January 14, 2026 19:08

landinjm approved these changes Jan 19, 2026

View reviewed changes

jijn added 2 commits January 19, 2026 15:04

Merge remote-tracking branch 'upstream/master' into fix/outsourcebuild

51bcc3a

format fix: white space

0f9a4ed

jijn added 4 commits January 19, 2026 16:08

fix application build

907a4c2

bug fix

66543dc

bug fix2

2c36490

bug fix3

c8e6e0a

landinjm added this pull request to the merge queue Jan 20, 2026

Merged via the queue into prisms-center:master with commit 2ecf611 Jan 20, 2026
3 checks passed

jijn deleted the fix/outsourcebuild branch February 7, 2026 06:07

Conversation

jijn commented Jan 8, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jijn commented Jan 13, 2026

Uh oh!

landinjm commented Jan 19, 2026

Uh oh!

jijn commented Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jijn commented Jan 19, 2026 •

edited

Loading