Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance system sc and p4est linkage #1231

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

sandro-elsweijer
Copy link
Collaborator

Describe your changes here:
Enhances the system SC and p4est linkage in such a way, that the include path is also found and linked to the executables.
Furthermore, the output of cmake is enhanced so that is easier to see if something has gone wrong during linkage of external modules.

All these boxes must be checked by the reviewers before merging the pull request:

As a reviewer please read through all the code lines and make sure that the code is fully understood, bug free, well-documented and well-structured.

General

  • The reviewer executed the new code features at least once and checked the results manually

  • The code follows the t8code coding guidelines

  • New source/header files are properly added to the Makefiles

  • The code is well documented

  • All function declarations, structs/classes and their members have a proper doxygen documentation

  • All new algorithms and data structures are sufficiently optimal in terms of memory and runtime (If this should be merged, but there is still potential for optimization, create a new issue)

Tests

  • The code is covered in an existing or new test case using Google Test

Github action

  • The code compiles without warning in debugging and release mode, with and without MPI (this should be executed automatically in a github action)

  • All tests pass (in various configurations, this should be executed automatically in a github action)

    If the Pull request introduces code that is not covered by the github action (for example coupling with a new library):

    • Should this use case be added to the github action?
    • If not, does the specific use case compile and all tests pass (check manually)

Scripts and Wiki

  • If a new directory with source-files is added, it must be covered by the script/find_all_source_files.scp to check the indentation of these files.
  • If this PR introduces a new feature, it must be covered in an example/tutorial and a Wiki article.

Licence

  • The author added a BSD statement to doc/ (or already has one)

@sandro-elsweijer sandro-elsweijer added enhancement Enhances already existing code priority: medium Should be solved within half a year workload: low Would take half a day or less CMake Is about the CMake build system labels Aug 22, 2024
@jmark jmark enabled auto-merge September 3, 2024 12:54
@jmark jmark disabled auto-merge September 3, 2024 14:06
@jmark
Copy link
Collaborator

jmark commented Sep 3, 2024

@sandro-elsweijer The tests are failing for the CMake testsuite.

@jmark jmark assigned sandro-elsweijer and unassigned jmark Sep 3, 2024
include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(P4EST DEFAULT_MSG P4EST_INCLUDE_DIR P4EST_LIBRARIES)

if(NOT SC_LIBRARIES)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be if(NOT P4EST_LIBRARIES) ?

@maelk3
Copy link
Collaborator

maelk3 commented Sep 4, 2024

As it currently stands, the system SC and P4est libraries include path are already taken into consideration. As using find_package in config mode retrieves the SC-config.cmake files and doing target_link_libraries(T8 SC::SC) implies that all interface properties of the SC target are added to the T8 target (including include paths, compiler flags/definitions). Furthermore, the include path can be explicitly retrieved using get_target_property(T8_INCLUDE_DIR T8CODE::T8 INTERFACE_INCLUDE_DIRECTORIES). Having said that, I think the FindP4est.cmake and FindSC.cmake can be useful in case SC and P4est have not being installed with their respective CMake build system. However, we should favor using find_package in config mode as it is more robust and gets more information (like library version, necessary compiler flags...).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CMake Is about the CMake build system enhancement Enhances already existing code priority: medium Should be solved within half a year workload: low Would take half a day or less
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

3 participants