Post processing with pyVista

.flake8

@@ -1,5 +1,7 @@
 [flake8]
 exclude = venv, tui.py, ansys/api/fluent
+per-file-ignores =
+    ansys/fluent/postprocessing/pyvista/graphics.py:N801
 select = W191, W291, W293, W391, E115, E117, E122, E124, E125, E225, E231, E301, E303, E501, F401, F403, N801, N802, N803, N804, N805, N806
 count = True
 max-complexity = 10

.github/workflows/ci.yml

@@ -32,7 +32,7 @@ jobs:
         run: |
           make flake8
 
-  testimport:
+  test-import:
     name: Smoke Tests
     runs-on: ${{ matrix.os }}
     strategy:
@@ -67,16 +67,54 @@ jobs:
             Python-${{ runner.os }}-${{ matrix.python-version }}
 
       - name: Install pyfluent
-        run: |
-          make install
+        run: make install
 
       - name: Test import
-        run: |
-          make test-import
+        run: make test-import
+
+  test-post-import:
+    name: Post Import
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [windows-latest]
+        python-version: ['3.7', '3.8', '3.9', '3.10'] 
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Linux pip cache
+        uses: actions/cache@v2
+        if: ${{ runner.os == 'Linux' }}
+        with:
+          path: ~/.cache/pip
+          key: Python-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('setup.py') }}-${{ hashFiles('requirements_*.txt') }}
+          restore-keys: |
+            Python-${{ runner.os }}-${{ matrix.python-version }}
+
+      - name: Window pip cache
+        uses: actions/cache@v2
+        if: ${{ runner.os == 'Windows' }}
+        with:
+          path: ~\AppData\Local\pip\Cache
+          key: Python-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('setup.py') }}-${{ hashFiles('requirements_*.txt') }}
+          restore-keys: |
+            Python-${{ runner.os }}-${{ matrix.python-version }}
+
+      - name: Install pyfluent
+        run: make install
+
+      - name: Test post import
+        run: make test-post-import        
 
   build_test:
     name: Build and Unit Testing
-    needs: testimport
+    needs: test-import
     runs-on: ubuntu-latest
 
     steps:
@@ -96,12 +134,10 @@ jobs:
             Python-${{ runner.os }}-${{ matrix.python-version }}
 
       - name: Install pyfluent
-        run: |
-          make install
+        run: make install
 
       - name: Unit Testing
-        run: |
-          make unittest
+        run: make unittest
 
       - name: Check package
         run: |

Makefile

@@ -11,6 +11,9 @@ install:
 test-import:
 	@python -c "import ansys.fluent.solver as pyfluent"
 
+test-post-import:
+	@python -c "import ansys.fluent.postprocessing.pyvista as pv"
+
 unittest:
 	@echo "Running unittest"
 	@pip install -r requirements_test.txt

README.rst

@@ -25,17 +25,8 @@ Usage
   session.check_health()
   session.tui.solver.file.read_case(case_file_name='elbow.cas.gz')
   session.tui.solver.define.models.unsteady_2nd_order("yes")
-  session.tui.solver.solve.initialize.initialize_flow()
+  session.tui.solver.solve.initialize.initialize_flow()  
   session.tui.solver.solve.dual_time_iterate(number_of_time_steps=2, maximum_number_of_iterations_per_time_step=3)
-  session.tui.solver.display.objects.contour['contour-1'] = {'boundary_values': True, 'color_map': {'color': 'field-velocity', 'font_automatic': True, 'font_name': 'Helvetica', 'font_size': 0.032, 'format': '%0.2e', 'length': 0.54, 'log_scale': False, 'position': 1, 'show_all': True, 'size': 100, 'user_skip': 9, 'visible': True, 'width': 6.0}, 'coloring': {'smooth': False}, 'contour_lines': False, 'display_state_name': 'None', 'draw_mesh': False, 'field': 'pressure', 'filled': True, 'mesh_object': '', 'node_values': True, 'range_option': {'auto_range_on': {'global_range': True}}, 'surfaces_list': [2, 5]}
-  session.tui.solver.display.objects.contour['contour-1']()
-  session.tui.solver.display.objects.contour['contour-1'].field.set_state('velocity-magnitude')
-  session.tui.solver.display.objects.contour['contour-1'].field()
-  session.tui.solver.display.objects.contour['contour-1'].color_map.size.set_state(80.0)
-  session.tui.solver.display.objects.contour['contour-1'].color_map.size()
-  session.tui.solver.display.objects.contour['contour-1'].rename('my-contour')
-  del session.tui.solver.display.objects.contour['my-contour']
-
 
 Settings objects
 ****************
@@ -56,3 +47,78 @@ Settings objects provide a more natural way to access and modify Fluent settings
 Meshing TUI and workflow
 ************************
 TUI and meshing workflows from Fluent meshing are exposed. Please check `meshing.rst <https://github.com/pyansys/pyfluent/blob/main/doc/meshing.rst>`_ for example usage.
+
+
+Post Processing
+***************
+
+In Fluent (server)
+^^^^^^^^^^^^^^^^^^
+
+.. code:: python
+
+  session.tui.solver.display.objects.contour['contour-1'] = {'boundary_values': True, 'color_map': {'color': 'field-velocity', 'font_automatic': True, 'font_name': 'Helvetica', 'font_size': 0.032, 'format': '%0.2e', 'length': 0.54, 'log_scale': False, 'position': 1, 'show_all': True, 'size': 100, 'user_skip': 9, 'visible': True, 'width': 6.0}, 'coloring': {'smooth': False}, 'contour_lines': False, 'display_state_name': 'None', 'draw_mesh': False, 'field': 'pressure', 'filled': True, 'mesh_object': '', 'node_values': True, 'range_option': {'auto_range_on': {'global_range': True}}, 'surfaces_list': [2, 5]}
+  session.tui.solver.display.objects.contour['contour-1']()
+  session.tui.solver.display.objects.contour['contour-1'].field.set_state('velocity-magnitude')
+  session.tui.solver.display.objects.contour['contour-1'].field()
+  session.tui.solver.display.objects.contour['contour-1'].color_map.size.set_state(80.0)
+  session.tui.solver.display.objects.contour['contour-1'].color_map.size()
+  session.tui.solver.display.objects.contour['contour-1'].rename('my-contour')
+  del session.tui.solver.display.objects.contour['my-contour']
+
+PyVista (client)
+^^^^^^^^^^^^^^^^
+
+.. code:: python
+
+  #import module
+  import ansys.fluent.postprocessing.pyvista as pv
+
+  #get the graphics objects for the session
+
+  graphics_session1 = pv.Graphics(session)
+  mesh1 = graphics_session1.Meshes["mesh-1"]
+  contour1 = graphics_session1.Contours["contour-1"]
+  contour2 = graphics_session1.Contours["contour-2"]
+  surface1 = graphics_session1.Surfaces["surface-1"]
+
+  #set graphics objects properties
+
+  #mesh
+  mesh1.show_edges = True
+  mesh1.surfaces_list = ['symmetry']
+
+  #contour
+  contour1.field = "velocity-magnitude"
+  contour1.surfaces_list = ['symmetry']
+
+  contour2.field = "temperature"
+  contour2.surfaces_list = ['symmetry', 'wall']
+
+  #copy
+  graphics_session1.Contours["contour-3"] = contour2()
+
+  #update
+  contour3 = graphics_session1.Contours["contour-3"]
+  contour3.update(contour1())
+
+  #delete
+  del graphics_session1.Contours["contour-3"] 
+
+  #loop
+  for name, _ in graphics_session1.Contours.items():
+      print(name)
+
+  #iso surface
+  surface1.surface_type.iso_surface.field= "velocity-magnitude"
+  surface1.surface_type.iso_surface.rendering= "contour"
+
+  #display in default plotter
+  contour1.display()
+  mesh1.display()
+  surface1.display()
+
+  #display in seprate plotter e.g. plotter-2
+  contour1.display("plotter-2")
+
+  session.exit()

ansys/fluent/postprocessing/pyvista/__init__.py

@@ -0,0 +1,2 @@
+from ansys.fluent.postprocessing.pyvista.plotter import plotter # noqa: F401
+from ansys.fluent.postprocessing.pyvista.graphics import Graphics # noqa: F401