Merge branch 'main' into release/0.5

RobPasMue · RobPasMue · commit 7a1cc794d8c1 · 2024-05-15T15:36:08.000+02:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -7,15 +7,15 @@ exclude: "tests/integration/files"
 repos:
 
 - repo: https://github.com/psf/black
-  rev: 24.4.0  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
+  rev: 24.4.2  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
   hooks:
   - id: black
 
 - repo: https://github.com/adamchainz/blacken-docs
   rev: 1.16.0
   hooks:
   - id: blacken-docs
-    additional_dependencies: [black==24.4.0]
+    additional_dependencies: [black==24.4.2]
 
 - repo: https://github.com/pycqa/isort
   rev: 5.13.2
@@ -64,7 +64,7 @@ repos:
 
 # this validates our github workflow files
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.28.2
+  rev: 0.28.3
   hooks:
     - id: check-github-workflows
 
diff --git a/doc/changelog.d/1177.changed.md b/doc/changelog.d/1177.changed.md
@@ -0,0 +1 @@
+chore: update CHANGELOG for v0.5.3
diff --git a/doc/changelog.d/1178.dependencies.md b/doc/changelog.d/1178.dependencies.md
@@ -0,0 +1 @@
+build: bump the docs-deps group with 4 updates
diff --git a/doc/changelog.d/1179.dependencies.md b/doc/changelog.d/1179.dependencies.md
@@ -0,0 +1 @@
+build: bump pytest from 8.1.1 to 8.2.0
diff --git a/doc/changelog.d/1180.miscellaneous.md b/doc/changelog.d/1180.miscellaneous.md
@@ -0,0 +1 @@
+chore: pre-commit automatic update
diff --git a/doc/changelog.d/1182.added.md b/doc/changelog.d/1182.added.md
@@ -0,0 +1 @@
+feat: allow for ``product_version`` on geometry service launcher function
diff --git a/doc/changelog.d/1183.miscellaneous.md b/doc/changelog.d/1183.miscellaneous.md
@@ -0,0 +1 @@
+docs: add geometry preparation for Fluent simulation
diff --git a/doc/changelog.d/1186.dependencies.md b/doc/changelog.d/1186.dependencies.md
@@ -0,0 +1 @@
+build: bump grpcio from 1.62.2 to 1.63.0 in the grpc-deps group
diff --git a/doc/changelog.d/1187.dependencies.md b/doc/changelog.d/1187.dependencies.md
@@ -0,0 +1 @@
+build: bump the docs-deps group with 2 updates
diff --git a/doc/changelog.d/1188.dependencies.md b/doc/changelog.d/1188.dependencies.md
@@ -0,0 +1 @@
+build: bump trame-vtk from 2.8.6 to 2.8.7
diff --git a/doc/changelog.d/1189.dependencies.md b/doc/changelog.d/1189.dependencies.md
@@ -0,0 +1 @@
+build: bump nbsphinx from 0.9.3 to 0.9.4 in the docs-deps group
diff --git a/doc/changelog.d/1190.dependencies.md b/doc/changelog.d/1190.dependencies.md
@@ -0,0 +1 @@
+build: bump trame-vtk from 2.8.7 to 2.8.8
diff --git a/doc/changelog.d/1193.miscellaneous.md b/doc/changelog.d/1193.miscellaneous.md
@@ -0,0 +1 @@
+chore: pre-commit automatic update
diff --git a/doc/source/_static/thumbnails/naca_fluent.png b/doc/source/_static/thumbnails/naca_fluent.png
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -278,6 +278,7 @@ def intersphinx_pyansys_geometry(switcher_version: str):
     "examples/03_modeling/sweep_chain_profile": "_static/thumbnails/sweep_chain_profile.png",
     "examples/03_modeling/export_design": "_static/thumbnails/export_design.png",
     "examples/04_applied/01_naca_airfoils": "_static/thumbnails/naca_airfoils.png",
+    "examples/04_applied/02_naca_fluent": "_static/thumbnails/naca_fluent.png",
 }
 nbsphinx_epilog = """
 ----
diff --git a/doc/source/examples.rst b/doc/source/examples.rst
@@ -51,3 +51,4 @@ applications.
 .. nbgallery::
 
     examples/04_applied/01_naca_airfoils.mystnb
+    examples/04_applied/02_naca_fluent.mystnb
diff --git a/doc/source/examples/04_applied/.gitignore b/doc/source/examples/04_applied/.gitignore
@@ -1 +1,3 @@
-*.fmd
+*.fmd
+*.scdocx
+*.pmdb
diff --git a/doc/source/examples/04_applied/01_naca_airfoils.mystnb b/doc/source/examples/04_applied/01_naca_airfoils.mystnb
@@ -245,8 +245,10 @@ design.plot()
 
 ### Save the design
 
+In this case, the design is saved as an SCDOCX file.
+
 ```{code-cell} ipython3
 # Save the design
-file = design.export_to_fmd()
+file = design.export_to_scdocx()
 print(f"Design saved to {file}")
 ```
diff --git a/doc/source/examples/04_applied/02_naca_fluent.mystnb b/doc/source/examples/04_applied/02_naca_fluent.mystnb
@@ -0,0 +1,149 @@
+---
+jupytext:
+  text_representation:
+    extension: .mystnb
+    format_name: myst
+    format_version: 0.13
+    jupytext_version: 1.14.1
+kernelspec:
+  display_name: Python 3 (ipykernel)
+  language: python
+  name: python3
+---
+# Applied: Prepare a NACA airfoil for a Fluent simulation
+
+Once a NACA airfoil is designed, it is necessary to prepare the geometry for a CFD simulation. This notebook demonstrates
+how to prepare a NACA 6412 airfoil for a Fluent simulation. The starting point of this example is the previously designed
+NACA 6412 airfoil. The airfoil was saved in an SCDOCX file, which is now imported into the notebook. The geometry is then
+prepared for the simulation.
+
+In case you want to run this notebook, make sure that you have run the previous notebook to design the NACA 6412 airfoil.
+
+## Import the NACA 6412 airfoil
+
+The following code starts up the Geometry Service and imports the NACA 6412 airfoil. The airfoil is then displayed in the
+notebook.
+
+```{code-cell} ipython3
+import os
+
+from ansys.geometry.core import launch_modeler
+
+# Launch the modeler
+modeler = launch_modeler()
+
+# Import the NACA 6412 airfoil
+design = modeler.open_file(os.path.join(os.getcwd(), f"NACA_Airfoil_6412.scdocx"))
+
+# Retrieve the airfoil body
+airfoil = design.bodies[0]
+
+# Display the airfoil
+design.plot()
+```
+
+## Prepare the geometry for the simulation
+
+The current design is only composed of the airfoil. To prepare the geometry for the simulation,
+you must define the domain around the airfoil. The following code creates a rectangular
+fluid domain around the airfoil.
+
+The airfoil has the following dimensions:
+
+* Chord length: 1 (X-axis)
+* Thickness: Depends on NACA value (Y-axis)
+
+Define the fluid domain as a large box with these dimensions:
+
+* Length (X-axis) - 10 times the chord length
+* Width (Z-axis) - 5 times the chord length
+* Height (Y-axis) - 4 times the chord length
+
+Place the airfoil at the center of the fluid domain.
+
+```{code-cell} ipython3
+from ansys.geometry.core.math import Point2D, Plane, Point3D
+from ansys.geometry.core.sketch import Sketch
+
+BOX_LENGTH = 10  # X-Axis
+BOX_WIDTH = 5  # Z-Axis
+BOX_HEIGHT = 4  # Y-Axis
+
+# Create the sketch
+fluid_sketch = Sketch(
+    plane=Plane(origin=Point3D([0, 0, 0.5 - (BOX_WIDTH / 2)]))
+)
+fluid_sketch.box(
+    center=Point2D([0.5, 0]),
+    height=BOX_HEIGHT,
+    width=BOX_LENGTH,
+)
+
+# Extrude the fluid domain
+fluid = design.extrude_sketch("Fluid", fluid_sketch, BOX_WIDTH)
+```
+
+## Create named selections
+
+Named selections are used to define boundary conditions in Fluent. The following code creates named selections for the
+inlet, outlet, and walls of the fluid domain. The airfoil is also assigned a named selection.
+
+The airfoil is aligned with the X axis. The inlet is located at the left side of the airfoil, the outlet is located at the
+right side of the airfoil, and the walls are located at the top and bottom of the airfoil. The inlet face has therefore
+a negative X-axis normal vector, and the outlet face has a positive X-axis normal vector. The rest of the faces, therefore,
+constitute the walls.
+
+```{code-cell} ipython3
+# Create named selections in the fluid domain (inlet, outlet, and surrounding faces)
+# Add also the airfoil as a named selection
+fluid_faces = fluid.faces
+surrounding_faces = []
+inlet_faces = []
+outlet_faces = []
+for face in fluid_faces:
+    if face.normal().x == 1:
+        outlet_faces.append(face)
+    elif face.normal().x == -1:
+        inlet_faces.append(face)
+    else:
+        surrounding_faces.append(face)
+
+design.create_named_selection("Outlet Fluid", faces=outlet_faces)
+design.create_named_selection("Inlet Fluid", faces=inlet_faces)
+design.create_named_selection("Surrounding Faces", faces=surrounding_faces)
+design.create_named_selection("Airfoil Faces", faces=airfoil.faces)
+```
+
+## Display the geometry
+
+The geometry is now ready for the simulation. The following code displays the geometry in the notebook.
+This example uses the ``PlotterHelper`` class to display the geometry for
+the airfoil and fluid domain in different colors with a specified opacity level.
+
+The airfoil is displayed in green, and the fluid domain is displayed in blue with an opacity of 0.25.
+
+```{code-cell} ipython3
+from ansys.geometry.core.plotting import PlotterHelper
+
+plotter_helper = PlotterHelper()
+plotter_helper.add(airfoil, color="green")
+plotter_helper.add(fluid, color="blue", opacity=0.15)
+plotter_helper.show_plotter()
+```
+
+## Export the geometry
+
+Export the geometry into a Fluent-compatible format. The following code exports the geometry
+into a PMDB file, which retains the named selections.
+
+```{code-cell} ipython3
+# Save the design
+file = design.export_to_pmdb()
+print(f"Design saved to {file}.")
+```
+
+You can import the exported PMDB file into Fluent to set up the mesh and perform the simulation.
+For an example of how to set up the mesh and boundary conditions in Fluent, see the [Modeling External Compressible Flow](https://fluent.docs.pyansys.com/version/stable/examples/00-fluent/external_compressible_flow.html) example in the Fluent documentation.
+
+The main difference between the Fluent example and this geometry is the coordinate system. The Fluent example
+defines the airfoil in the XY plane, while this geometry defines the airfoil in the XZ plane.
diff --git a/pyproject.toml b/pyproject.toml
@@ -51,24 +51,24 @@ tests = [
     "ansys-tools-path==0.5.2",
     "beartype==0.18.5",
     "docker==7.0.0",
-    "grpcio==1.62.2",
+    "grpcio==1.63.0",
     "grpcio-health-checking==1.60.0",
     "numpy==1.26.4",
     "Pint==0.23",
     "protobuf==5.26.1",
-    "pytest==8.1.1",
+    "pytest==8.2.0",
     "pytest-cov==5.0.0",
     "pytest-pyvista==0.1.9",
     "pytest-xvfb==3.0.0",
-    "pyvista[jupyter]==0.43.5",
+    "pyvista[jupyter]==0.43.7",
     "requests==2.31.0",
     "scipy==1.13.0",
     "semver==3.0.2",
     "six==1.16.0",
     "vtk==9.3.0",
 ]
 tests-minimal = [
-    "pytest==8.1.1",
+    "pytest==8.2.0",
     "pytest-cov==5.0.0",
     "pytest-pyvista==0.1.9",
     "pytest-xvfb==3.0.0",
@@ -79,20 +79,20 @@ doc = [
     "docker==7.0.0",
     "ipyvtklink==0.2.3",
     "jupyter_sphinx==0.5.3",
-    "jupytext==1.16.1",
-    "myst-parser==2.0.0",
-    "nbconvert==7.16.3",
-    "nbsphinx==0.9.3",
+    "jupytext==1.16.2",
+    "myst-parser==3.0.1",
+    "nbconvert==7.16.4",
+    "nbsphinx==0.9.4",
     "notebook==7.1.3",
     "numpydoc==1.7.0",
-    "panel==1.4.1",
-    "pyvista[jupyter]==0.43.5",
+    "panel==1.4.2",
+    "pyvista[jupyter]==0.43.7",
     "requests==2.31.0",
     "sphinx==7.2.6",
     "sphinx-autodoc-typehints==1.24.0",
     "sphinx-copybutton==0.5.2",
     "sphinx-jinja==2.0.2",
-    "trame-vtk==2.8.6",
+    "trame-vtk==2.8.8",
     "vtk==9.3.0",
 ]
 
diff --git a/src/ansys/geometry/core/connection/launcher.py b/src/ansys/geometry/core/connection/launcher.py
diff --git a/tests/integration/test_client.py b/tests/integration/test_client.py
diff --git a/tests/integration/test_launcher_local.py b/tests/integration/test_launcher_local.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+build: bump the docs-deps group with 4 updates`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+feat: allow for ``product_version`` on geometry service launcher function
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+docs: add geometry preparation for Fluent simulation`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+build: bump grpcio from 1.62.2 to 1.63.0 in the grpc-deps group`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+build: bump the docs-deps group with 2 updates`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+build: bump trame-vtk from 2.8.6 to 2.8.7`