Merge branch 'release'

Author: FranzBangar

.github/workflows/build_ci.yml

@@ -6,7 +6,7 @@ jobs:
     pytests:
         strategy:
             matrix:
-                python-version: ["3.8", "3.9", "3.10", "3.11"]
+                python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
             fail-fast: false
         runs-on: ubuntu-latest
         steps:

.vscode/settings.json

@@ -4,7 +4,7 @@
         "editor.defaultFormatter": "ms-python.black-formatter",
         "editor.wordBasedSuggestions": "off",
         "editor.codeActionsOnSave": {
-            "source.organizeImports": "explicit"
+            "source.organizeImports.isort": "explicit"
         },
     },
     "python.analysis.typeCheckingMode": "basic",

CHANGELOG.md

@@ -4,14 +4,33 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-# [1.6.4]
+# [1.7.0]
+### Added
+- Automatic grading:
+  - `FixedCountGrader`: simple and quick, grades all blocks in all directions with the same number. Useful while developing meshes - settings blocking etc.
+  - `SimpleGrader`: quick and good for cases where blocks do not differ much in size. Sets simple-graded counts on blocks based on wanted cell size.
+  - `SmoothGrader`: Tries to stretch and squeeze cells within blocks by using two graded chops in each direction. The idea is to try to keep difference in cell size between neighbouring blocks as little as possible. Blocks that cannot maintain required cell size are simply/uniformly chopped.
+- Possibility to define rings by their inner radius
+- Spline round shapes
+- Cylinders:
+  - Add symmetry patch to SemiCylinder
+- New examples:
+  - Quarter cylinder
+  - One core cylinder
+- `ShapeOptimizer` can optimize shapes _before_ they are added  to mesh
+
+### Changed
+- Renamed `classy_blocks.typing` module to `classy_blocks.cbtyping` due to name clash
+- Bugfixes
+
+## [1.6.4]
 ### Added
 - MappedSketch.merge() method
 
 ### Changed
 - Improved blocking in cyclone example
 
-# [1.6.3]
+## [1.6.3]
 ### Changed
 - Bugfix: sorting of cells by sensitivity
 - Bugfix: sensitivity calculation moved clamps around
@@ -21,7 +40,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 - Quality caching (produced invalid results and did not speed up optimization)
 
-# [1.6.2]
+## [1.6.2]
 ### Added
 - QuarterSplineRound and QuarterSplineRoundRing; cylinders and rings with an arbitrary, parametrized spline cross-section
 - Lofts and Shapes, created with spline side-edges (when multiple sketches for mid-sections are provided)
@@ -30,15 +49,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Bugfixes
 
-# [1.6.1]
+## [1.6.1]
 ### Added
 - Assemblies and *Joints
   - Examples thereof
 
 ### Changed
 - Some bugfixes
 
-# [1.6.0]
+## [1.6.0]
 ### Added
 - Array element; handling multiple points at once (makes transforms faster)
 - Complete overhaul of Optimization:
@@ -55,14 +74,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 - QuadMap is no longer needed (handled by Grid classes)
 
-# [1.5.3]
+## [1.5.3]
 ### Added
 - RoundSolidShape.remove_inner_edges() can now remove edges from a specific face (start, end or both)
 
 ### Changed
 - Bugfix: invalid cells in round shapes (due to wrong spline point calculation)
 
-# [1.5.2]
+## [1.5.2]
 ### Added
 - Spline edges on QuarterDisk, HalfDisk and Disk (FourCoreDisk) to improve mesh quality
 - Face.remove_edges() to reset all edges to simple lines
@@ -71,7 +90,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Updated affected tutorials (diffusers, cyclone)
 
-# [1.5.1]
+## [1.5.1]
 ### Added
 - Optimization:
   - Choice of solver (different problems require - work best - with different solvers)
@@ -86,7 +105,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Improved optimization speed
 
-# [1.5.0]
+## [1.5.0]
 ### Added
 - Curves:
   - get_tangent()
@@ -114,15 +133,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Calling .transform() with a Mirror transformation will warn about creating an inverted block
 
 
-# [1.4.1]
+## [1.4.1]
 ### Changed
 - Improved optimization output
 
 ### Removed
 - Relaxation within optimization
 - Numerical integration of analytic curve lengths; use discretization instead
 
-# [1.4.0]
+## [1.4.0]
 ### Added
 - Channel example
 - Cyclone example
@@ -157,7 +176,7 @@ that parameter is of a similar magnitudes than points' coordinates.
 ### Removed
 - Junction.delta() is now handled by optimization automatically
 
-# [1.3.3]
+## [1.3.3]
 ### Added
 - Airfoil example
 - Translation and Rotational Link: move together with vertices being optimized (see the airfoil example)
@@ -172,19 +191,19 @@ that parameter is of a similar magnitudes than points' coordinates.
 ### Removed
 - Curve.get_closest_param() now finds initial_param automatically
 
-# [1.3.2] Curves
+## [1.3.2] Curves
 ### Added
 - *Curve objects for dealing with edge specification and optimization
 
-# [1.3.1] Optimization/Backport
+## [1.3.1] Optimization/Backport
 ### Added
 - mesh.clear() removes lists of all items that were populated during mesh.assemble()
 - mesh.backport() updates user supplied operations' points with results of optimization/modification
 
 ### Changed
 - Optimizer: under-relaxation for the first optimization iterations
 
-# [1.3.0] Blocking Optimization
+## [1.3.0] Blocking Optimization
 ### Added
 - **Blocking Optimization**
   - Finders for easier fetching vertices, generated by mesh.assemble()
@@ -208,7 +227,7 @@ that parameter is of a similar magnitudes than points' coordinates.
   - Calling .project_side() on an Operation will add the new geometry to edges instead of replacing them (but will replace existing label for the side)
 
 
-# [1.2.0] Shell Shape
+## [1.2.0] Shell Shape
 ### Added
 - A Shell Shape, created from arbitrary set of faces
 ### Changed

README.md

@@ -77,17 +77,15 @@ _Unchecked items are not implemented yet but are on a TODO list_
     - [x] Ring (annulus)
     - [x] Hemisphere
 - [x] Stacks (collections of similar Shapes stacked on top of each other)
-- [ ] Predefined parametric Objects
+- [x] Predefined parametric Objects
     - [x] T-joint (round pipes)
     - [x] X-joint
     - [x] N-joint (multiple pipes)
-    - [ ] Collector (a barrel with multiple radial outlets)
 - [ ] Other building tools
     - [x] Use existing Operation's Face to generate a new Operation
     - [x] Chain Shape's start/end surface to generate a new Shape
     - [x] Expand Shape's outer surface to generate a new Shape (Cylinder/Annulus > Annulus)
     - [x] Contract Shape's inner surface into a new Shape (Annulus > Cylinder/Annulus)
-    - [ ] Join two Operations by extending their Edges
     - [x] Offset Operation's faces to form new operations
 
 ## Modifiers
@@ -106,6 +104,7 @@ After blocks have been placed, it is possible to create new geometry based on pl
 - [x] Automatic propagation of grading and cell count from a single block to all connected blocks as required by blockMesh
 - [x] Projections of vertices, edges and block faces to geometry (triangulated and [searchable surfaces](https://www.openfoam.com/documentation/guides/latest/doc/guide-meshing-snappyhexmesh-geometry.html#meshing-snappyhexmesh-searchable-objects))
 - [x] Face merging as described by [blockMesh user guide](https://www.openfoam.com/documentation/user-guide/4-mesh-generation-and-conversion/4.3-mesh-generation-with-the-blockmesh-utility#x13-470004.3.2). Breaks the pure-hexahedral-mesh rule but can often save the day for trickier geometries. Automatic duplication of points on merged block faces
+- [x] Auto grading for high-Re meshes
 - [ ] Auto grading for Low-Re meshes: boundary layer with specified cell-to-cell expansion, transition with 2:1 expansion, and specified 'bulk' cell size
 
 # Examples
@@ -254,6 +253,16 @@ A collection of pre-assembled parametric Shapes, ready to be used for further co
 Three pipes, joined in a single point.
 ![N-Joint](showcase/n_joint.png)
 
+## Automatic Grading
+After blocks have been positioned their cell count must be defined. This can be done manually with something like `operation.chop(axis, start_size=..., c2c_expansion=...)` or anything that `.chop()` method supports. Not all blocks need to be chopped as cell counts will be propagated throughout the mesh so it is advisable to only _chop_ the minimum required.
+
+All that can also be avoided by using automatic graders, for instance, `SmoothGrader` will set counts so that desired cell size will be obtained but will also use multigrading to keep cell sizes between neighbouring blocks as uniform as possible.
+
+![SmoothGrader, automatic grading of blocks](showcase/smooth_grader.png)
+
+Also other, quicker and simpler graders are available.
+The ultimate grader that will also create inflation layers on walls for resolved boundary layer is in development.
+
 ## Projection To Geometry
 
 [Any geometry that snappyHexMesh understands](https://www.openfoam.com/documentation/guides/latest/doc/guide-meshing-snappyhexmesh-geometry.html)
@@ -367,6 +376,13 @@ Airfoil core with blunt trailing edge (imported points from NACA generator) and
 (see `examples/complex/airfoil.py`). A simulation-ready mesh needs additional blocks to expand domain further away from the airfoil.
 ![Airfoil](showcase/airfoil.png "Airfoil core mesh")
 
+## Automatic Edge Grading
+When setting cell counts and expansion ratios, it is possible to specify which value to keep constant. Mostly this will be used for keeping thickness of the first cell at the wall consistent to maintain desired `y+` throughout the mesh. This is done by simple specifying a `preserve="..."` keyword.
+
+Example: a block chopped in a classic way where cell sizes will increase when block size increases:
+![Classic block grading](showcase/classy_classic_grading.png "Classic block grading")
+The same case but with a specified `preserve="start_size"` keyword for the bottom and `preserve="end_size"` for the top edge:
+![Grading for consistent cell size](showcase/classy_edges_grading.png "Classy block grading")
 
 ## Debugging
 

classy_blocks.code-workspace

@@ -12,7 +12,10 @@
             "Pylance",
             "scipy"
         ],
-        "editor.autoClosingBrackets": "never"
+        "editor.autoClosingBrackets": "never",
+        "isort.importStrategy": "fromEnvironment",
+        "editor.defaultFormatter": null,
+        "ruff.organizeImports": false
     },
     "extensions": {
         "recommendations": [

examples/advanced/edge_grading.py

@@ -0,0 +1,33 @@
+# NOT FINISHED!
+# TODO: add operation.grade_edge() and show its usage in this example
+import os
+
+import classy_blocks as cb
+
+mesh = cb.Mesh()
+
+start = cb.Box([0, 0, 0], [1, 1, 0.1])
+
+start.chop(0, start_size=0.1)
+start.chop(1, length_ratio=0.5, start_size=0.01, c2c_expansion=1.2, preserve="start_size")
+start.chop(1, length_ratio=0.5, end_size=0.01, c2c_expansion=1 / 1.2, preserve="end_size")
+start.chop(2, count=1)
+mesh.add(start)
+
+expand_start = start.get_face("right")
+expand = cb.Loft(expand_start, expand_start.copy().translate([1, 0, 0]).scale(2))
+expand.chop(2, start_size=0.1)
+mesh.add(expand)
+
+contract_start = expand.get_face("top")
+contract = cb.Loft(contract_start, contract_start.copy().translate([1, 0, 0]).scale(0.25))
+contract.chop(2, start_size=0.1)
+mesh.add(contract)
+
+end = cb.Extrude(contract.get_face("top"), 1)
+end.chop(2, start_size=0.1)
+mesh.add(end)
+
+mesh.set_default_patch("walls", "wall")
+
+mesh.write(os.path.join("..", "case", "system", "blockMeshDict"), debug_path="debug.vtk")

examples/advanced/smooth_grader.py

@@ -0,0 +1,35 @@
+# A terrible blocking of a rectangle for displaying SmoothGrader capabilities
+
+import os
+
+import numpy as np
+
+import classy_blocks as cb
+
+mesh = cb.Mesh()
+
+base = cb.Grid([0, 0, 0], [3, 2, 0], 3, 2)
+
+shape = cb.ExtrudedShape(base, 1)
+
+# turn one block around to test grader's skillz
+shape.grid[1][0].rotate(np.pi, [0, 0, 1])
+
+mesh.add(shape)
+
+# move some points to get a mesh with uneven blocks
+mesh.assemble()
+finder = cb.GeometricFinder(mesh)
+
+move_points = [[0, 1, 1], [2, 1, 1], [3, 1, 1]]
+
+for point in move_points:
+    vertex = list(finder.find_in_sphere(point))[0]
+    vertex.translate([0, 0.8, 0])
+
+mesh.set_default_patch("walls", "wall")
+mesh.block_list.update()
+grader = cb.SmoothGrader(mesh, 0.05)
+grader.grade()
+
+mesh.write(os.path.join("..", "case", "system", "blockMeshDict"), debug_path="debug.vtk")

examples/chaining/labyrinth.py

@@ -14,7 +14,7 @@
 
 face = cb.Face([[0, 0, 0], [1, 0, 0], [1, 1, 0], [0, 1, 0]])
 extrude = cb.Extrude(face, 1)
-extrudes.append(extrude)
+mesh.add(extrude)
 
 for side in ("top", "right", "top", "top", "left", "top"):
     face = extrude.get_face(side)
@@ -29,14 +29,11 @@
     # the operations to keep them consistent - 'top' faces
     # facing upwards.
     orienter.reorient(extrude)
-
-    extrudes.append(extrude)
-
-for extrude in extrudes:
-    for i in range(3):
-        extrude.chop(i, count=10)
-
     mesh.add(extrude)
 
 mesh.set_default_patch("walls", "wall")
+
+grader = cb.FixedCountGrader(mesh, 5)
+grader.grade()
+
 mesh.write(os.path.join("..", "case", "system", "blockMeshDict"), debug_path="debug.vtk")

examples/chaining/tank.py

@@ -6,30 +6,25 @@
 diameter = 0.5
 length = 0.5  # including end caps
 
-# refer to other examples for a proper-ish grading setup
-h = 0.05
-
 mesh = cb.Mesh()
 
 cylinder = cb.Cylinder([0, 0, 0], [length, 0, 0], [0, diameter / 2, 0])
 
 wall_name = "tank_wall"
 
-cylinder.chop_axial(start_size=h)
-cylinder.chop_radial(start_size=h)
-cylinder.chop_tangential(start_size=h)
 cylinder.set_outer_patch(wall_name)
 
 start_cap = cb.Hemisphere.chain(cylinder, start_face=True)
-start_cap.chop_axial(start_size=h)
 start_cap.set_outer_patch(wall_name)
 
 end_cap = cb.Hemisphere.chain(cylinder, start_face=False)
-end_cap.chop_axial(start_size=h)
 end_cap.set_outer_patch(wall_name)
 
 mesh.add(cylinder)
 mesh.add(start_cap)
 mesh.add(end_cap)
 
+grader = cb.SimpleGrader(mesh, 0.05)
+grader.grade()
+
 mesh.write(os.path.join("..", "case", "system", "blockMeshDict"), debug_path="debug.vtk")

examples/complex/airfoil/airfoil.py

@@ -135,7 +135,8 @@ def get_loft(indexes):
 # Keep in mind that not all blocks need exact specification as
 # chopping will propagate automatically through blocking
 lofts[0].chop(2, count=1)  # 1 cell in the 3rd dimension
-lofts[1].chop(1, start_size=BL_THICKNESS, c2c_expansion=C2C_EXPANSION, take="max")
+# keep consistent first cell thickness by using edge grading
+lofts[1].chop(1, start_size=BL_THICKNESS, c2c_expansion=C2C_EXPANSION, take="max", preserve="start_size")
 lofts[8].chop(1, start_size=CELL_SIZE, take="max")
 
 for i in (0, 1, 2, 3, 4, 5, 6):
@@ -195,7 +196,9 @@ def optimize_along_line(point_index, line_index_1, line_index_2):
 optimize_along_line(5, 3, 6)
 
 if OPTIMIZE:
-    optimizer.optimize(tolerance=1e-7, method="SLSQP")
+    optimizer.optimize(tolerance=1e-3, method="SLSQP")
+    mesh.backport()
+    mesh.clear()
 
 ### Write the mesh
 mesh.modify_patch("topAndBottom", "empty")