Merge pull request #11 from gismo/heat-equation

Reorder the directories add scripts for cleaning, running and linking; update precice function documentation for doxygen. The CI is failing, a PR has made to the main G+Smo to change the cmake file for solving the CI issue.

.github/workflows/ci.yml

@@ -33,7 +33,7 @@ jobs:
         with:
           path: ./gismo/optional/${{ github.event.repository.name }}
           #token: ${{ secrets.GH_PAT }}
-          
+
       # Step to install preCICE
       - name: Install preCICE
         if: runner.os == 'Linux'
@@ -48,6 +48,7 @@ jobs:
           make -j 10
           sudo make install
           precice_DIR=$(pwd)
+          export precice_DIR=$(pwd)
 
       # Step to install preCICE
       - name: Install preCICE for mac
@@ -62,7 +63,8 @@ jobs:
           make -j 10
           sudo make install
           precice_DIR=$(pwd)
-          
+          export precice_DIR=$(pwd)
+
       - name: "Run for ${{ matrix.os }}"
         shell: bash
         working-directory: ${{ runner.workspace }}
@@ -71,5 +73,6 @@ jobs:
           ctest -S ${{ github.event.repository.name }}/gismo/cmake/ctest_script.cmake \
           -D CTEST_BUILD_NAME="${{ github.event.repository.name }}_actions_$GITHUB_RUN_NUMBER" \
           -D CTEST_SITE="${{ matrix.os }}_[actions]" \
+          -D LABELS_FOR_SUBPROJECTS="gsPreCICE-examples"    \
           -D CMAKE_ARGS="-DCMAKE_BUILD_TYPE=$BUILD_TYPE;-DCMAKE_CXX_STANDARD=11;-DGISMO_WITH_XDEBUG=ON;-DGISMO_BUILD_UNITTESTS=ON;-Dprecice_DIR=$precice_DIR" \
-          -D GISMO_OPTIONAL="${{ github.event.repository.name }}" -Q
+          -D GISMO_OPTIONAL="gsElasticity\\;${{ github.event.repository.name }}" -Q

.gitignore

@@ -38,6 +38,10 @@
 *.pvd
 *.vtk
 
+# Files from macOS
+*.DS_Store
+.DS_Store
+.DS_Store?
 
 # Log files
 *.log

CMakeLists.txt

@@ -53,4 +53,11 @@ set(gismo_UNITTESTS ${gismo_UNITTESTS} ${unittests_SRCS}
   CACHE INTERNAL "gismo list of unittests")
 
 # Look for CMakeLists.txt in examples
-add_subdirectory(examples)
+# add example files
+if(GISMO_BUILD_EXAMPLES)
+    add_custom_target(${PROJECT_NAME}-examples)
+    add_subdirectory(examples)
+else()
+    add_subdirectory(examples EXCLUDE_FROM_ALL)
+endif(GISMO_BUILD_EXAMPLES)
+

README.md

@@ -9,8 +9,7 @@
 |Repository|[gismo/gismo/gsPreCICE](https://github.com/gismo/gsPreCICE)|
 |Developer|[Hugo Verhelst](https://github.com/hverhelst), [Jingya Li](https://github.com/Crazy-Rich-Meghan) |
 |Dependency|[preCICE v.3](https://github.com/gismo/gsPreCICE)|
-|Maintainer|[[email protected]](mailto:[email protected])|
-
+|Maintainer|[Jingya Li](https://github.com/Crazy-Rich-Meghan), [Hugo Verhelst](https://github.com/hverhelst)|
 
 ## Start here
 
@@ -50,11 +49,13 @@ cd fluid-<other solvers>
 
 **Note**: You need to perform steps 2 and 5 if you want to run the simulation with other libraries.
 
+## Examples
+- [Partitioned Heat Conduction](examples/partitioned-heat-conduction/README.md)
 
 ## Versions
 
 The latest supported G+Smo version is v24.08.0, and the latest supported preCICE version is v3.1.2.
 
 ## References
 
-[1] Benjamin Uekermann, Hans-Joachim Bungartz, Lucia Cheung Yau, Gerasimos Chourdakis and Alexander Rusch. Official preCICE Adapters for Standard Open-Source Solvers. In Proceedings of the _7th GACM Colloquium on Computational Mechanics for Young Scientists from Academia_, 2017.
+[1] Benjamin Uekermann, Hans-Joachim Bungartz, Lucia Cheung Yau, Gerasimos Chourdakis and Alexander Rusch. Official preCICE Adapters for Standard Open-Source Solvers. In Proceedings of the _7th GACM Colloquium on Computational Mechanics for Young Scientists from Academia_, 2017.

examples/CMakeLists.txt

@@ -11,8 +11,11 @@ aux_cpp_directory(${CMAKE_CURRENT_SOURCE_DIR} FILES)
 foreach(file ${FILES})
     add_gismo_executable(${file})
     get_filename_component(tarname ${file} NAME_WE) # name without extension
-    set_property(TEST ${tarname} PROPERTY LABELS "${PROJECT_NAME}")
-    set_target_properties(${tarname} PROPERTIES FOLDER "${PROJECT_NAME}")
+      if(GISMO_TEST_PRECICE)
+        set_property(TEST ${tarname} PROPERTY LABELS "${PROJECT_NAME}-examples")
+      endif()
+      set_target_properties(${tarname} PROPERTIES FOLDER "${PROJECT_NAME}")
+      add_dependencies(${PROJECT_NAME}-examples ${tarname})
     # install the example executables (optionally)
     install(TARGETS ${tarname} DESTINATION "${BIN_INSTALL_DIR}" COMPONENT exe OPTIONAL)
 endforeach(file ${FILES})
@@ -24,8 +27,11 @@ FOREACH(subdir ${SUBDIRS})
   foreach(file ${FILES})
       add_gismo_executable(${file})
       get_filename_component(tarname ${file} NAME_WE) # name without extension
-      set_property(TEST ${tarname} PROPERTY LABELS "${PROJECT_NAME}")
+      if(GISMO_TEST_PRECICE)
+        set_property(TEST ${tarname} PROPERTY LABELS "${PROJECT_NAME}")
+      endif()
       set_target_properties(${tarname} PROPERTIES FOLDER "${PROJECT_NAME}")
+      add_dependencies(${PROJECT_NAME}-examples ${tarname})
       # install the example executables (optionally)
       install(TARGETS ${tarname} DESTINATION "${BIN_INSTALL_DIR}" COMPONENT exe OPTIONAL)
   endforeach(file ${FILES})
@@ -40,8 +46,11 @@ FOREACH(subdir ${SUBDIRS})
     foreach(file ${FILES})
         add_gismo_executable(${file})
         get_filename_component(tarname ${file} NAME_WE) # name without extension
-        set_property(TEST ${tarname} PROPERTY LABELS "${PROJECT_NAME}")
+        if(GISMO_TEST_PRECICE)
+          set_property(TEST ${tarname} PROPERTY LABELS "${PROJECT_NAME}")
+        endif()
         set_target_properties(${tarname} PROPERTIES FOLDER "${PROJECT_NAME}")
+        add_dependencies(${PROJECT_NAME}-examples ${tarname})
         # install the example executables (optionally)
         install(TARGETS ${tarname} DESTINATION "${BIN_INSTALL_DIR}" COMPONENT exe OPTIONAL)
     endforeach(file ${FILES})