Add CHANGELOG.md

CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+## [1.3.2] - 2024-06-10
+
+### Fixed
+
+- Add missing call to update of face-connectivity prior to mesh smoothing strategies, 
+  which let to invalid meshing attempts in example 2 and example 6 (based on issue [#24](https://github.com/FloSewn/TQMesh/issues/24)) 
+  ([`0ce9393`](https://github.com/FloSewn/TQMesh/commit/0ce9393))
+
+### Changed
+
+- Remove `ve_intersection_` attribute in `src/algorithm/FrontUpdate.h`, which prevented quad layer heights 
+  to be removed adequately in the vicinity of small element sizes and which had no impact on the actual mesh generation
+  ([#26](https://github.com/FloSewn/TQMesh/issues/26)) ([`1762bdd`](https://github.com/FloSewn/TQMesh/commit/1762bdd))
+- Change namespace `TQMesh::TQAlgorithm` simply to `TQMesh`
+- Add single include header files `src/algorithm/TQMesh.h` and `src/utils/CppUtils.h` to reduce include statements 
+  within exampes / TQMesh application
+
+### Added
+
+- **convert2foam.py** to convert the TQMesh text-format to the OpenFOAM compatible mesh format ([#19](https://github.com/FloSewn/TQMesh/issues/19)) ([`df2a078`](https://github.com/FloSewn/TQMesh/commit/df2a078))
+- New example **thin fracture**, which involves merging two meshes that model a thin fraction interface (based on [#26](https://github.com/FloSewn/TQMesh/issues/26)).
+- **MeshChecker** class in `src/algorithm/MeshChecker.h`, which acts as interface for general mesh validity checks ([`7ca7320`](https://github.com/FloSewn/TQMesh/commit/7ca7320))
+  (might be extened in future for mesh quality checks)
+

README.md

@@ -100,9 +100,9 @@ results in the *input/* and *src/examples* directories.
 <details>
 <summary>Local mesh refinement</summary>
 
-This example shows a triangular mesh which features local element refinement. 
-The element size is determined either by the domain's edge segments, 
-through sizing factors that are attributed to boundary vertices or through a size function which is defined by the user.
+**TQMesh** combines a simple definition of mesh domain boundaries with a versatile specification of the 
+element size. The latter is either determined by the domain's edge segments, 
+through sizing factors that are attributed to boundary vertices or via user-defined size functions.
 
 <img src="doc/simple_triangular_mesh.png" alt="TQMesh-simple-triangular-mesh" width="300"/>
 <img src="doc/thin_fracture.png" alt="TQMesh-thin-fracture" width="338"/>
@@ -138,7 +138,6 @@ These colors can be adjusted during the meshing process, as indicated in this ex
 It also possible to define interior mesh vertices, in order to influence the local element refinement, as shown below.
 
 <img src="doc/fixed_vertices.png" alt="TQMesh-fixed-vertices" width="250"/>
-<img src="doc/multiple_meshes.png" alt="TQMesh-multiple-meshes" width="250"/>
 </details>
 
 <details>
@@ -149,6 +148,7 @@ This makes it even easier to assign different color values to different element
 This example shows the output from a successive mesh generation.
 
 <img src="doc/merge_meshes.png" alt="TQMesh-merge-meshes" width="250"/>
+<img src="doc/multiple_meshes.png" alt="TQMesh-multiple-meshes" width="250"/>
 </details>
 
 <details>
@@ -268,8 +268,9 @@ The following plots show some performance statistics.
 <img src="doc/BenchmarkPlot_QTree.png" alt="TQMesh-QTree-Benchmark" width="400"/> <img src="doc/BenchmarkPlot_Mesh.png" alt="TQMesh-Mesh-Benchmark" width="400"/>
 
 ## To Do's
-* Boundary definition via splines
+* Fixed edges within domains
 * Enhanced quad triangle-to-quad morphing
+* Boundary definition via splines
 * Improved documentation / testing
 
 Feel free to contribute!