Update precompiled headers lib (#127)

* Update shared library generation

* Improve error messages

* Update License

* Fix logger print

* Update readme and version

* Add compare methodes to precompiled classes

* Update contributing checklist

Author: tobre1

.gitignore

@@ -6,6 +6,7 @@ install*/
 *.vtk
 *.vtu
 *.vtp
+*_lstest*
 *.vscode/
 .vs
 CMakeSettings.json

CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.20 FATAL_ERROR)
 project(
   ViennaLS
   LANGUAGES CXX
-  VERSION 4.4.0)
+  VERSION 4.5.0)
 
 # --------------------------------------------------------------------------------------------------------
 # Library options
@@ -103,7 +103,7 @@ include(cmake/vtk.cmake)
 
 CPMAddPackage(
   NAME ViennaCore
-  VERSION 1.4.4
+  VERSION 1.5.0
   GIT_REPOSITORY "https://github.com/ViennaTools/ViennaCore"
   OPTIONS "VIENNACORE_FORMAT_EXCLUDE docs/ build/"
   EXCLUDE_FROM_ALL ${VIENNALS_BUILD_PYTHON})
@@ -198,12 +198,28 @@ if(VIENNALS_PRECOMPILE_HEADERS)
     set(VIENNALS_LINKAGE STATIC)
   endif()
 
-  add_library(${PROJECT_NAME}Lib ${VIENNALS_LINKAGE})
-  add_library(${PROJECT_NAME}::Lib ALIAS ${PROJECT_NAME}Lib)
+  set(LIB_NAME "viennals")
+  add_library(${LIB_NAME} ${VIENNALS_LINKAGE})
 
-  target_link_libraries(${PROJECT_NAME}Lib PUBLIC ${PROJECT_NAME})
-  target_sources(${PROJECT_NAME}Lib PUBLIC "lib/specialisations.cpp")
-  set_target_properties(${PROJECT_NAME}Lib PROPERTIES WINDOWS_EXPORT_ALL_SYMBOLS ON)
+  target_link_libraries(${LIB_NAME} PRIVATE ${PROJECT_NAME})
+  target_compile_definitions(${LIB_NAME} PRIVATE VIENNALS_USE_PRECOMPILED)
+  target_sources(${LIB_NAME} PRIVATE "lib/specialisations.cpp")
+
+  set_target_properties(
+    ${LIB_NAME}
+    PROPERTIES VERSION ${PROJECT_VERSION} # full x.y.z appears in filename
+               SOVERSION ${PROJECT_VERSION_MAJOR} # major version for SONAME
+               WINDOWS_EXPORT_ALL_SYMBOLS ON)
+
+  target_link_libraries(${PROJECT_NAME} INTERFACE ${LIB_NAME})
+  target_compile_definitions(${PROJECT_NAME} INTERFACE VIENNALS_USE_PRECOMPILED)
+
+  install(
+    TARGETS ${LIB_NAME}
+    EXPORT ViennaLSTargets
+    LIBRARY DESTINATION lib
+    ARCHIVE DESTINATION lib
+    RUNTIME DESTINATION bin)
 endif()
 
 # --------------------------------------------------------------------------------------------------------

CONTRIBUTING.md

@@ -4,8 +4,8 @@
 
 * Make sure everything builds with & without shared libs
 
-* Run clang-format on ALL files of the project (use format-project.sh)
+* Run clang-format on ALL files of the project (use CMake target `format`)
 
-* Wrap all implemented interface functions for Python in Wrapping/pyWrap.cpp
+* Wrap all implemented interface functions for Python in python/pyWrap.cpp
 
 * IMPORTANT: Check the ReadMe file in / to make sure nothing changed

LICENSE

@@ -1,9 +1,4 @@
-Parts of the code (located in the 'external/' subfolder) have different
-licenses. The individual licenses apply for this specific part. Please consult
-the respective LICENSE files.
-
-
-Copyright (c) 2015-2023      Institute for Microelectronics, TU Wien.
+Copyright (c) 2015-2025      Institute for Microelectronics, TU Wien.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -55,15 +55,14 @@ Releases are tagged on the maser branch and available in the [releases section](
 
 * [ViennaHRLE](https://github.com/ViennaTools/ViennaHRLE)
 
-* [VTK](https://github.com/Kitware/VTK) (optional)
+* [VTK](https://github.com/Kitware/VTK) (optional, but recommended for mesh export and visualization)
 
 * [pybind11](https://github.com/pybind/pybind11) (only for building Python libs)
 
 ## Using ViennaLS in your project
 
 Have a look at the [example repo](https://github.com/ViennaTools/viennals-example) for creating a project with ViennaLS as a dependency.
 
-
 ## Installing
 
 Since this is a header only project, it does not require any installation.
@@ -73,11 +72,11 @@ However, we recommend the following procedure in order to set up all dependencie
 git clone https://github.com/ViennaTools/ViennaLS.git
 cd ViennaLS
 
-cmake -B build -DCMAKE_INSTALL_PREFIX=/path/to/your/custom/install/
+cmake -B build -D CMAKE_INSTALL_PREFIX=/path/to/your/custom/install/
 cmake --install build
 ```
 
-This will install the necessary headers and CMake files to the specified path. If DCMAKE_INSTALL_PREFIX is not specified, it will be installed to the standard path for your system, usually /usr/local/ .
+This will install the necessary headers and CMake files to the specified path. If `CMAKE_INSTALL_PREFIX` is not specified, it will be installed to the standard path for your system, usually `/usr/local/`.
 
 ## Installing without VTK
 
@@ -86,7 +85,7 @@ In order to install ViennaLS without VTK, run:
 git clone https://github.com/ViennaTools/ViennaLS.git
 cd ViennaLS
 
-cmake -B build -DCMAKE_INSTALL_PREFIX=/path/to/your/custom/install/ -DVIENNALS_USE_VTK=OFF
+cmake -B build -D CMAKE_INSTALL_PREFIX=/path/to/your/custom/install/ -D VIENNALS_USE_VTK=OFF
 cmake --install build
 ```
 
@@ -97,7 +96,7 @@ The CMake configuration automatically checks if the dependencies are installed.
 ## Building the Python package
 
 > [!NOTE]  
-> On systems that feature a package manager (e.g. Ubuntu/Debian `apt`), the dependencies can be installed beforehand (e.g. using ```sudo apt install libvtk9-dev```), which saves a considerable amount of time during compilation.
+> On systems that feature a package manager (e.g. Ubuntu/Debian `apt`), VTK can be installed beforehand (e.g. using ```sudo apt install libvtk9-dev```), which saves a considerable amount of time during compilation.
 
 The Python package can be built and installed using the `pip` command:
 
@@ -150,7 +149,7 @@ We recommend using [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake) to consum
 
 * Installation with CPM
   ```cmake
-  CPMAddPackage("gh:viennatools/viennals@4.4.0")
+  CPMAddPackage("gh:viennatools/viennals@4.5.0")
   ```
 
 * With a local installation
@@ -202,4 +201,7 @@ http://www.iue.tuwien.ac.at/
 
 ## License
 
-See file LICENSE in the base directory.
+ViennaLS is licensed under the [MIT License](./LICENSE).
+
+Some third-party libraries used by ViennaLS are under their own permissive licenses (MIT, BSD).  
+See [`THIRD_PARTY_LICENSES.md`](./THIRD_PARTY_LICENSES.md) for details.

THIRD_PARTY_LICENSES.md

@@ -0,0 +1,38 @@
+# Third-Party Licenses
+
+ViennaLS is licensed under the MIT License.  
+This file lists third-party libraries used by ViennaLS and their respective licenses.
+
+---
+
+### ViennaCore
+
+**License:** MIT
+**URL:** [https://github.com/ViennaTools/viennacore](https://github.com/ViennaTools/viennacore)
+
+---
+
+#### ViennaHRLE
+
+**License:** MIT
+**URL:** [https://github.com/ViennaTools/viennahrle](https://github.com/ViennaTools/viennahrle)
+
+---
+
+#### VTK (Visualization Toolkit)
+
+**License:** BSD 3-Clause
+**URL:** [https://vtk.org/](https://vtk.org/)
+**Note:** Used for mesh export and visualization.
+
+---
+
+### pybind11
+
+**License:** BSD 3-Clause
+**URL:** [https://github.com/pybind/pybind11](https://github.com/pybind/pybind11)
+**Note:** Used only when building Python bindings.
+
+---
+
+

include/viennals/lsAdvect.hpp

@@ -386,13 +386,13 @@ template <class T, int D> class Advect {
     // check whether a level set and velocities have been given
     if (levelSets.empty()) {
       Logger::getInstance()
-          .addWarning("No level sets passed to Advect. Not advecting.")
+          .addError("No level sets passed to Advect. Not advecting.")
           .print();
       return std::numeric_limits<double>::max();
     }
     if (velocities == nullptr) {
       Logger::getInstance()
-          .addWarning("No velocity field passed to Advect. Not advecting.")
+          .addError("No velocity field passed to Advect. Not advecting.")
           .print();
       return std::numeric_limits<double>::max();
     }
@@ -814,9 +814,7 @@ template <class T, int D> class Advect {
   void prepareLS() {
     // check whether a level set and velocities have been given
     if (levelSets.empty()) {
-      Logger::getInstance()
-          .addWarning("No level sets passed to Advect.")
-          .print();
+      Logger::getInstance().addError("No level sets passed to Advect.").print();
       return;
     }
 
@@ -854,7 +852,7 @@ template <class T, int D> class Advect {
           levelSets.back());
     } else {
       Logger::getInstance()
-          .addWarning("Advect: Integration scheme not found.")
+          .addError("Advect: Integration scheme not found.")
           .print();
     }
   }
@@ -938,7 +936,7 @@ template <class T, int D> class Advect {
       currentTimeStep = integrateTime(is, maxTimeStep);
     } else {
       Logger::getInstance()
-          .addWarning("Advect: Integration scheme not found. Not integrating.")
+          .addError("Advect: Integration scheme not found.")
           .print();
       currentTimeStep = -1.;
     }

include/viennals/lsBooleanOperation.hpp

@@ -316,17 +316,16 @@ template <class T, int D> class BooleanOperation {
   void apply() {
     if (levelSetA == nullptr) {
       Logger::getInstance()
-          .addWarning("No level set was passed to BooleanOperation. Not "
-                      "performing operation.")
+          .addError("No level set was passed to BooleanOperation.")
           .print();
       return;
     }
 
     if (static_cast<unsigned>(operation) < 3) {
       if (levelSetB == nullptr) {
         Logger::getInstance()
-            .addWarning("Only one level set was passed to BooleanOperation, "
-                        "although two were required. Not performing operation.")
+            .addError("Only one level set was passed to BooleanOperation, "
+                      "although two were required.")
             .print();
         return;
       }
@@ -348,8 +347,7 @@ template <class T, int D> class BooleanOperation {
     case BooleanOperationEnum::CUSTOM:
       if (operationComp == nullptr) {
         Logger::getInstance()
-            .addWarning("No comparator supplied to custom BooleanOperation. "
-                        "Not performing operation.")
+            .addError("No comparator supplied to custom BooleanOperation.")
             .print();
         return;
       }

include/viennals/lsCalculateCurvatures.hpp

@@ -3,6 +3,7 @@
 #include <hrleCartesianPlaneIterator.hpp>
 #include <lsCurvatureFormulas.hpp>
 #include <lsDomain.hpp>
+#include <lsExpand.hpp>
 
 #include <vcLogger.hpp>
 #include <vcSmartPointer.hpp>
@@ -60,7 +61,7 @@ template <class T, int D> class CalculateCurvatures {
   void apply() {
     if (levelSet == nullptr) {
       Logger::getInstance()
-          .addWarning("No level set was passed to CalculateCurvatures.")
+          .addError("No level set was passed to CalculateCurvatures.")
           .print();
     }
 
@@ -70,8 +71,10 @@ template <class T, int D> class CalculateCurvatures {
       Logger::getInstance()
           .addWarning("CalculateCurvatures: Level set width must be "
                       "at least " +
-                      std::to_string(minWidth) + " !")
+                      std::to_string(minWidth) + ". Expanding level set to " +
+                      std::to_string(minWidth) + ".")
           .print();
+      Expand<T, D>(levelSet, minWidth).apply();
     }
 
     std::vector<std::vector<T>> meanCurvaturesVector(

include/viennals/lsCalculateNormalVectors.hpp

@@ -7,6 +7,7 @@
 #include <hrleSparseStarIterator.hpp>
 
 #include <lsDomain.hpp>
+#include <lsExpand.hpp>
 
 #include <vcLogger.hpp>
 #include <vcSmartPointer.hpp>
@@ -44,16 +45,19 @@ template <class T, int D> class CalculateNormalVectors {
   void apply() {
     if (levelSet == nullptr) {
       Logger::getInstance()
-          .addWarning("No level set was passed to CalculateNormalVectors.")
+          .addError("No level set was passed to CalculateNormalVectors.")
           .print();
     }
 
     if (levelSet->getLevelSetWidth() < (maxValue * 4) + 1) {
       Logger::getInstance()
           .addWarning("CalculateNormalVectors: Level set width must be "
                       "greater than " +
-                      std::to_string((maxValue * 4) + 1) + "!")
+                      std::to_string((maxValue * 4) + 1) +
+                      ". Expanding level set to " +
+                      std::to_string((maxValue * 4) + 1) + ".")
           .print();
+      Expand<T, D>(levelSet, (maxValue * 4) + 1).apply();
     }
 
     std::vector<std::vector<Vec3D<T>>> normalVectorsVector(
@@ -64,7 +68,7 @@ template <class T, int D> class CalculateNormalVectors {
 
     auto grid = levelSet->getGrid();
 
-    //! Calculate Normalvectors
+    // Calculate Normalvectors
 #pragma omp parallel num_threads(levelSet->getNumberOfSegments())
     {
       int p = 0;
@@ -111,10 +115,10 @@ template <class T, int D> class CalculateNormalVectors {
 
         denominator = std::sqrt(denominator);
         if (std::abs(denominator) < 1e-12) {
-          std::ostringstream oss;
-          oss << "CalculateNormalVectors: Vector of length 0 at "
-              << neighborIt.getIndices();
-          Logger::getInstance().addWarning(oss.str()).print();
+          Logger::getInstance()
+              .addWarning("CalculateNormalVectors: Vector of length 0 at " +
+                          neighborIt.getIndices().to_string())
+              .print();
           for (unsigned i = 0; i < D; ++i)
             n[i] = 0.;
         } else {