done

Author: Xiangyu-Hu

CMakeLists.txt

@@ -1,95 +1,105 @@
 cmake_minimum_required(VERSION 3.16)
-project(SPHINXsys VERSION 1.0.0 LANGUAGES CXX)
+project(SPHinXsys VERSION 1.0.0 LANGUAGES CXX)
 
 set(SPHINXSYS_PROJECT_DIR ${PROJECT_SOURCE_DIR})
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${SPHINXSYS_PROJECT_DIR}/cmake)
 include(Common) # brings macro to current namespace
 
-#------ Options
+# ------ Options
 option(SPHINXSYS_2D "Build sphinxsys_2d library" ON)
 option(SPHINXSYS_3D "Build sphinxsys_3d library" ON)
 option(SPHINXSYS_BUILD_TESTS "Build tests" ON)
 option(SPHINXSYS_DEVELOPER_MODE "Developer mode has more flags active for code quality" ON)
 
-#------ Global properties (Some cannot be set on INTERFACE targets)
+# ------ Global properties (Some cannot be set on INTERFACE targets)
 set(CMAKE_VERBOSE_MAKEFILE OFF CACHE BOOL "Enable verbose compilation commands for Makefile and Ninja" FORCE) # Extra fluff needed for Ninja: https://github.com/ninja-build/ninja/issues/900
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON) # Generate `compile_commands.json` file which is necessary for code completioner, static analyzer, etc
 
-#set(CMAKE_CXX_STANDARD_REQUIRED ON) # C++ standard requirement for all targets is NOT optional 
+# set(CMAKE_CXX_STANDARD_REQUIRED ON) # C++ standard requirement for all targets is NOT optional
 set(CMAKE_CXX_EXTENSIONS OFF) # Disable any non-standard compiler specific C++ extensions for all targets.
 
 set(CMAKE_POSITION_INDEPENDENT_CODE TRUE) # Enable for all targets, needed for python modules
 
-#------ Declare core library
+# ------ Declare core library
 add_library(sphinxsys_core INTERFACE)
 
-#------ Local properties
+# ------ Local properties
 target_compile_features(sphinxsys_core INTERFACE cxx_std_17) # Requires a compiler supporting at least C++17
-### Generic properties below enabled for INTERFACE targets only for CMake>=3.19 
-#set_target_properties(sphinxsys_core PROPERTIES CXX_EXTENSIONS OFF) # Disable any non-standard compiler specific C++ extensions
-#set_target_properties(sphinxsys_core PROPERTIES CXX_STANDARD_REQUIRED ON) # C++ standard requirement for targets is NOT optional
-#set_target_properties(sphinxsys_core PROPERTIES CXX_STANDARD 17) 
 
+# ## Generic properties below enabled for INTERFACE targets only for CMake>=3.19
+# set_target_properties(sphinxsys_core PROPERTIES CXX_EXTENSIONS OFF) # Disable any non-standard compiler specific C++ extensions
+# set_target_properties(sphinxsys_core PROPERTIES CXX_STANDARD_REQUIRED ON) # C++ standard requirement for targets is NOT optional
+# set_target_properties(sphinxsys_core PROPERTIES CXX_STANDARD 17)
 if(${CMAKE_SYSTEM_NAME} MATCHES Windows)
     set_target_properties(sphinxsys_core PROPERTIES WINDOWS_EXPORT_ALL_SYMBOLS ON) # For correct DLL generation on Windows
     target_compile_definitions(sphinxsys_core INTERFACE _USE_MATH_DEFINES NOMINMAX)
     target_compile_options(sphinxsys_core INTERFACE /MP)
-    target_compile_options(sphinxsys_core INTERFACE /permissive-) 
-    # target_compile_options(sphinxsys_core INTERFACE $<$<BOOL:${SPHINXSYS_DEVELOPER_MODE}>:/W4 /WX>) # TODO: For when one gets rid of Simbody 
+    target_compile_options(sphinxsys_core INTERFACE /permissive-)
+
+# target_compile_options(sphinxsys_core INTERFACE $<$<BOOL:${SPHINXSYS_DEVELOPER_MODE}>:/W4 /WX>) # TODO: For when one gets rid of Simbody
 elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
     target_compile_options(sphinxsys_core INTERFACE $<$<BOOL:${SPHINXSYS_DEVELOPER_MODE}>:-Werror>)
-    target_compile_options(sphinxsys_core INTERFACE  $<$<BOOL:${SPHINXSYS_DEVELOPER_MODE}>:-Wall>)
-    # target_compile_options(sphinxsys_core INTERFACE  $<$<BOOL:${SPHINXSYS_DEVELOPER_MODE}>:-Wextra>) # TODO: 
+    target_compile_options(sphinxsys_core INTERFACE $<$<BOOL:${SPHINXSYS_DEVELOPER_MODE}>:-Wall>)
+
+    # target_compile_options(sphinxsys_core INTERFACE  $<$<BOOL:${SPHINXSYS_DEVELOPER_MODE}>:-Wextra>) # TODO:
     # target_compile_options(sphinxsys_core INTERFACE $<$<BOOL:${SPHINXSYS_DEVELOPER_MODE}>:-Wpedantic>) # For strict C++ standard compliance # TODO:
 endif()
 
-#------ Dependencies
-### SIMD flags
+# ------ Dependencies
+# ## SIMD flags
 find_package(SIMD QUIET)
 target_compile_options(sphinxsys_core INTERFACE ${SIMD_CXX_FLAGS})
-### Simbody
+
+# ## Simbody
 find_package(Simbody CONFIG REQUIRED)
 set(Simbody_LIBS
-    $<$<BOOL:${Simbody_LIBRARIES}>:${Simbody_LIBRARIES}>               # contains "SimTKcommon SimTKmath SimTKsimbody" in triplet with dynamic linking, empty otherwise
+    $<$<BOOL:${Simbody_LIBRARIES}>:${Simbody_LIBRARIES}> # contains "SimTKcommon SimTKmath SimTKsimbody" in triplet with dynamic linking, empty otherwise
     $<$<BOOL:${Simbody_STATIC_LIBRARIES}>:${Simbody_STATIC_LIBRARIES}> # contains "SimTKcommon_static SimTKmath_static SimTKsimbody_static" in triplet with static linking, empty otherwise
 )
 target_link_libraries(sphinxsys_core INTERFACE ${Simbody_LIBS})
 target_compile_definitions(sphinxsys_core INTERFACE _SILENCE_CXX17_ITERATOR_BASE_CLASS_DEPRECATION_WARNING) # Because of Simbody headers
-### Eigen
+
+# ## Eigen
 find_package(Eigen3 CONFIG REQUIRED)
 target_link_libraries(sphinxsys_core INTERFACE Eigen3::Eigen)
-### TBB
+
+# ## TBB
 find_package(TBB CONFIG REQUIRED)
-target_link_libraries(sphinxsys_core INTERFACE TBB::tbb TBB::tbbmalloc $<$<PLATFORM_ID:Windows>:TBB::tbbmalloc_proxy>) 
-### Threads
+target_link_libraries(sphinxsys_core INTERFACE TBB::tbb TBB::tbbmalloc $<$<PLATFORM_ID:Windows>:TBB::tbbmalloc_proxy>)
+
+# ## Threads
 find_package(Threads REQUIRED)
 target_link_libraries(sphinxsys_core INTERFACE Threads::Threads)
-### Boost
-set(Boost_NO_WARN_NEW_VERSIONS TRUE)    # In case your CMake version is older than the release of Boost found
-                                        # Boost geometry and program-options are old enough to afford skipping this warning
+
+# ## Boost
+set(Boost_NO_WARN_NEW_VERSIONS TRUE) # In case your CMake version is older than the release of Boost found
+
+# Boost geometry and program-options are old enough to afford skipping this warning
 find_package(Boost REQUIRED)
 find_path(BOOST_INCLUDE_DIR boost/geometry) # Header-only Boost libraries are not components
+
 if(NOT BOOST_INCLUDE_DIR)
     message(FATAL_ERROR "Please install Boost.Geometry library")
 endif()
+
 target_link_libraries(sphinxsys_core INTERFACE Boost::boost)
 find_package(Boost QUIET COMPONENTS program_options)
+
 if(TARGET Boost::program_options)
     target_compile_definitions(sphinxsys_core INTERFACE BOOST_AVAILABLE)
     target_link_libraries(sphinxsys_core INTERFACE Boost::program_options)
 endif()
 
-#------ Setup the concrete libraries
-add_subdirectory(SPHINXsys)
+# ------ Setup the concrete libraries
+add_subdirectory(src)
 add_subdirectory(modules)
 
-#------ Setup the tests
+# ------ Setup the tests
 if(SPHINXSYS_BUILD_TESTS)
     enable_testing()
     add_subdirectory(tests)
 endif()
 
-#------ Extra scripts to install
-file(COPY        ${CMAKE_CURRENT_SOURCE_DIR}/PythonScriptStore/RegressionTest/regression_test_base_tool.py
-     DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/PythonScriptStore/RegressionTest)
-        
+# ------ Extra scripts to install
+file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/PythonScriptStore/RegressionTest/regression_test_base_tool.py
+    DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/PythonScriptStore/RegressionTest)

Doxyfile

@@ -51,7 +51,7 @@ PROJECT_BRIEF          =
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           = ./SPHINXsys/logo.png
+PROJECT_LOGO           = ./assets/logo.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -790,8 +790,8 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = SPHINXsys \
-                         ./SPHINXsys/mainpage.md
+INPUT                  = assets \
+                         ./assets/mainpage.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

README.md

@@ -0,0 +1,14 @@
+FILE(GLOB_RECURSE SPHinXsysHeaderPathList ${SPHINXSYS_PROJECT_DIR}/src/*.h)
+
+SET(SPHinXsysHeaderPath "")
+
+FOREACH(file_path ${SPHinXsysHeaderPathList})
+    GET_FILENAME_COMPONENT(dir_path ${file_path} PATH)
+    SET(SPHinXsysHeaderPath ${SPHinXsysHeaderPath} ${dir_path})
+ENDFOREACH()
+
+LIST(REMOVE_DUPLICATES SPHinXsysHeaderPath)
+
+INCLUDE_DIRECTORIES("${SPHinXsysHeaderPath}")
+LINK_DIRECTORIES("${CMAKE_BINARY_DIR}/SPHinXsys/lib")
+LINK_DIRECTORIES("${CMAKE_BINARY_DIR}/SPHinXsys/bin")

SPHINXsys/CMakeLists.txt

@@ -0,0 +1,17 @@
+FILE(GLOB_RECURSE SPHinXsysHeaderPathListShared ${SPHINXSYS_PROJECT_DIR}/src/shared/*.h)
+FILE(GLOB_RECURSE SPHinXsysHeaderPathListFor2DBuild ${SPHINXSYS_PROJECT_DIR}/src/for_2D_build/*.h)
+FILE(GLOB_RECURSE SPHinXsysHeaderPathListFor2DBuildHpp ${CMAKE_CURRENT_SOURCE_DIR}/src/for_2D_build/*.hpp)
+
+SET(SPHinXsysHeaderPath "")
+
+FOREACH(file_path ${SPHinXsysHeaderPathListShared} ${SPHinXsysHeaderPathListFor2DBuild} ${SPHinXsysHeaderPathListFor2DBuildHpp})
+    GET_FILENAME_COMPONENT(dir_path ${file_path} PATH)
+    SET(SPHinXsysHeaderPath ${SPHinXsysHeaderPath} ${dir_path})
+ENDFOREACH()
+
+LIST(REMOVE_DUPLICATES SPHinXsysHeaderPath)
+
+# message(STATUS ${SPHinXsysHeaderPath})
+INCLUDE_DIRECTORIES("${SPHinXsysHeaderPath}")
+LINK_DIRECTORIES("${CMAKE_BINARY_DIR}/SPHinXsys/lib")
+LINK_DIRECTORIES("${CMAKE_BINARY_DIR}/SPHinXsys/bin")

SPHINXsys/logo-16x16.ico assets/logo-16x16.ico

@@ -0,0 +1,16 @@
+FILE(GLOB_RECURSE SPHinXsysHeaderPathListShared ${SPHINXSYS_PROJECT_DIR}/src/shared/*.h)
+FILE(GLOB_RECURSE SPHinXsysHeaderPathListFor3DBuild ${SPHINXSYS_PROJECT_DIR}/src/for_3D_build/*.h)
+FILE(GLOB_RECURSE SPHinXsysHeaderPathListFor3DBuildHpp ${SPHINXSYS_PROJECT_DIR}/src/for_3D_build/*.hpp)
+
+SET(SPHinXsysHeaderPath "")
+
+FOREACH(file_path ${SPHinXsysHeaderPathListShared} ${SPHinXsysHeaderPathListFor3DBuild} ${SPHinXsysHeaderPathListFor3DBuildHpp})
+    GET_FILENAME_COMPONENT(dir_path ${file_path} PATH)
+    SET(SPHinXsysHeaderPath ${SPHinXsysHeaderPath} ${dir_path})
+ENDFOREACH()
+
+LIST(REMOVE_DUPLICATES SPHinXsysHeaderPath)
+
+INCLUDE_DIRECTORIES("${SPHinXsysHeaderPath}")
+LINK_DIRECTORIES("${CMAKE_BINARY_DIR}/SPHinXsys/lib")
+LINK_DIRECTORIES("${CMAKE_BINARY_DIR}/SPHinXsys/bin")