cffview 0.2.4__tar.gz → 0.3.0__tar.gz

{cffview-0.2.4/src/cffview.egg-info → cffview-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cffview
-Version: 0.2.4
+Version: 0.3.0
 Summary: A Python CLI tool to inspect Ansys Fluent .cas.h5/.msh.h5 files without opening Fluent
 Author-email: preamer <1524477126@qq.com>
 License-Expression: BSD-3-Clause
@@ -57,6 +57,9 @@ pip install .
 
 ## Usage
 
+> [!IMPORTANT]
+> Only tested with Ansys Fluent 25R2!
+
 ```
 cffview <file> [options]
 ```
@@ -69,13 +72,14 @@ cffview <file> [options]
 | `--extract` | Dump raw Scheme settings to `general.scm` and `boundary.scm` |
 | `--showmesh` | Visualise the mesh interactively with PyVista |
 | `--solver` | Solver type, time, dimension, precision, turbulence model, energy, radiation, gravity |
-| `--mat` | Material properties |
-| `--bd` | Boundary condition settings |
-| `--ne` | Named expressions |
+| `--mat`, `--materials` | Material properties |
+| `--bd`, `--boundary` | Boundary condition settings |
+| `--ne`, `--named-expressions` | Named expressions |
 | `--disc` | Discretisation schemes and relaxation factors |
-| `--rd` | Report definitions |
+| `--rd`, `--report-definitions` | Report definitions |
 | `--plotsets` | Plot sets |
 | `--monitorsets` | Monitor sets |
+| `--residuals` | Residual settings |
 | `--iter` | Iteration / time-step settings |
 | `--contours` | Graphics contours settings |
 | `--vectors` | Graphics vectors settings |
@@ -103,6 +107,10 @@ cffview case.cas.h5 --version
 cffview case.cas.h5 --extract
 ```
 
+### Demo
+
+[demo.webm](https://github.com/user-attachments/assets/9047a354-b5cb-475e-b030-97609e2a1274)
+
 ---
 
 ## License

{cffview-0.2.4 → cffview-0.3.0}/README.md

@@ -33,6 +33,9 @@ pip install .
 
 ## Usage
 
+> [!IMPORTANT]
+> Only tested with Ansys Fluent 25R2!
+
 ```
 cffview <file> [options]
 ```
@@ -45,13 +48,14 @@ cffview <file> [options]
 | `--extract` | Dump raw Scheme settings to `general.scm` and `boundary.scm` |
 | `--showmesh` | Visualise the mesh interactively with PyVista |
 | `--solver` | Solver type, time, dimension, precision, turbulence model, energy, radiation, gravity |
-| `--mat` | Material properties |
-| `--bd` | Boundary condition settings |
-| `--ne` | Named expressions |
+| `--mat`, `--materials` | Material properties |
+| `--bd`, `--boundary` | Boundary condition settings |
+| `--ne`, `--named-expressions` | Named expressions |
 | `--disc` | Discretisation schemes and relaxation factors |
-| `--rd` | Report definitions |
+| `--rd`, `--report-definitions` | Report definitions |
 | `--plotsets` | Plot sets |
 | `--monitorsets` | Monitor sets |
+| `--residuals` | Residual settings |
 | `--iter` | Iteration / time-step settings |
 | `--contours` | Graphics contours settings |
 | `--vectors` | Graphics vectors settings |
@@ -79,6 +83,10 @@ cffview case.cas.h5 --version
 cffview case.cas.h5 --extract
 ```
 
+### Demo
+
+[demo.webm](https://github.com/user-attachments/assets/9047a354-b5cb-475e-b030-97609e2a1274)
+
 ---
 
 ## License

{cffview-0.2.4 → cffview-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "cffview"
-version = "0.2.4"
+version = "0.3.0"
 description = "A Python CLI tool to inspect Ansys Fluent .cas.h5/.msh.h5 files without opening Fluent"
 readme = "README.md"
 requires-python = ">=3.10"

{cffview-0.2.4 → cffview-0.3.0}/src/cffview/boundary.py

@@ -24,6 +24,7 @@ class Fluid:
     id_: str
     material: str = ''
     sources: str = ''
+    sources_terms: str = ''
     fixed: str = ''
     mrf_motion: str = ''
     mgrid_motion: str = ''
@@ -32,6 +33,14 @@ class Fluid:
     porous: str = ''
     fanzone: str = ''
 
+    def to_dict(self) -> dict[str, str]:
+        data = self.__dict__.copy()
+
+        if data['sources'] == '#f':
+            data.pop('sources_terms', None)
+
+        return data
+
 
 @dataclass
 @BoundaryFactory.register('solid')
@@ -40,6 +49,17 @@ class Solid:
     id_: str
     material: str = ''
     sources: str = ''
+    sources_terms: str = ''
+    fixed: str = ''
+    solid_motion: str = ''
+
+    def to_dict(self) -> dict[str, str]:
+        data = self.__dict__.copy()
+
+        if data['sources'] == '#f':
+            data.pop('sources_terms', None)
+
+        return data
 
 
 @dataclass
@@ -210,6 +230,13 @@ class PressureOutlet:
         return data
 
 
+@dataclass
+@BoundaryFactory.register('outflow')
+class Outflow:
+    name: str
+    id_: str
+
+
 @dataclass
 @BoundaryFactory.register('wall')
 class Wall:
@@ -300,6 +327,13 @@ class Symmetry:
     id_: str
 
 
+@dataclass
+@BoundaryFactory.register('axis')
+class Axis:
+    name: str
+    id_: str
+
+
 @dataclass
 class NotImplementedBoundary:
     name: str

{cffview-0.2.4 → cffview-0.3.0}/src/cffview/main.py

@@ -21,8 +21,11 @@ def print_version(file_path: str) -> str:
 
 
 def read_case(file_path: str, **kwargs) -> dict[
-    Literal['solver', 'materials', 'boundary', 'named-expressions',
-            'disc-scheme', 'report-definitions', 'plotsets', 'monitorsets', 'iter'],
+    Literal[
+        'solver', 'materials', 'boundary', 'named-expressions',
+        'disc-scheme', 'report-definitions', 'plotsets', 'monitorsets',
+        'residuals', 'iter', 'contours', 'vectors'
+    ],
     dict[str]
 ]:
     """Read the cas.h5 file
@@ -185,10 +188,11 @@ def read_case(file_path: str, **kwargs) -> dict[
             for property_ in boundary_info[2]:
                 property_name = str(property_[0]).replace('-', '_').replace('?', '').replace('/', '_')
                 if hasattr(new_boundary, property_name):
-                    if property_[1] == sexpdata.Symbol('.'):
-                        setattr(new_boundary, property_name, str(property_[2]))
-                    elif isinstance(property_[1], list):
-                        setattr(new_boundary, property_name, f'{property_[1][0]}/{property_[1][2]}')
+                    if len(property_) > 1:
+                        if property_[1] == sexpdata.Symbol('.'):
+                            setattr(new_boundary, property_name, str(property_[2]))
+                        elif isinstance(property_[1], list):
+                            setattr(new_boundary, property_name, f'{property_[1][0]}/{property_[1][2]}')
 
             b_list.append(new_boundary.to_dict() if hasattr(new_boundary, 'to_dict') else new_boundary.__dict__)
             data['boundary'][type_] = b_list
@@ -311,6 +315,49 @@ def read_case(file_path: str, **kwargs) -> dict[
             monitorset_dict['report-defs'] = monitorset[-4][1:]
             data['monitorsets'][monitorset_dict['name']] = monitorset_dict
 
+    if kwargs['residuals']:
+        import sexpdata
+
+        data['residuals'] = {}
+
+        for setting in [
+            r'advanced-options\?', r'normalize\?', r'compute-local\?',
+            r'scale\?', 'convergence-criterion-type', 'n-display',
+            'n-save', r'plot\?', r'print\?', 'n-maximize-norms',
+        ]:
+            value = re.search(
+                fr'\(residuals/{setting}\s+(#[tf]|[\d.]+)\)',
+                general_info,
+            ).group(1)
+            data['residuals'][setting.removesuffix(r'\?')] = value
+        cct = data['residuals']['convergence-criterion-type']
+        data['residuals']['convergence-criterion-type'] = 'absolute' if cct == '0' else 'none'
+
+        if not (solver_time := data.get('solver', {}).get('time', None)):
+            case_config = re.search(
+                r'^\(case-config.*',
+                general_info,
+                re.M
+            ).group()
+            is_unsteady = re.search(
+                r"\(rp-unsteady\?\s+\.\s+([^()\s]+)\)",
+                case_config
+            ).group(1)
+            solver_time = "transient" if is_unsteady == "#t" else "steady"
+        residuals = 'residuals/settings-transient' if solver_time == 'transient' else 'residuals/settings'
+        res = re.search(
+            fr'(\({residuals}.*)',
+            general_info,
+            re.M
+        ).group(1)
+        res: list = sexpdata.loads(res, true=None)[1]
+        for eq in res:
+            data['residuals'][str(eq[0])] = {
+                'monitor': str(eq[1]),
+                'check-convergence': str(eq[3]),
+                'absolute-criteria': str(eq[4]),
+            }
+
     if kwargs['iter']:
         data['iter'] = {}
 
@@ -449,14 +496,7 @@ def show_mesh(file_path: str) -> None:
     """
     import pyvista as pv
     if file_path.endswith('cas.h5'):
-        pv.plot(
-            pv.read(file_path),
-            show_edges=True,
-            show_axes=True,
-            anti_aliasing='ssaa',
-            smooth_shading=True,
-            split_sharp_edges=True,
-        )
+        mesh = pv.read(file_path)
     elif file_path.endswith('msh.h5'):
         import numpy as np
         from h5py import File, Group, Dataset
@@ -502,21 +542,79 @@ def show_mesh(file_path: str) -> None:
             faces=pv_faces if dimension == 3 else None,
             lines=pv_faces if dimension == 2 else None
         )
-        plotter = pv.Plotter()
-        plotter.enable_anti_aliasing()
-        plotter.add_mesh(
-            mesh,
-            show_edges=True,
-        )
-        plotter.add_axes()
-        plotter.show()
+
+    pl = pv.Plotter()
+    pl.enable_anti_aliasing()
+
+    mesh = mesh.combine() if mesh.n_blocks > 1 else mesh
+    mesh_actor = pl.add_mesh(mesh, show_edges=True)
+
+    def toggle_opacity(value):
+        mesh_actor.prop.opacity = value
+
+    opacity_slider_widget = pl.add_slider_widget(
+        toggle_opacity,
+        rng=(0.1, 1.0),
+        value=1.0,
+        title="Opacity",
+        style="modern",
+    )
+
+    # Monkey patch to fix clip plane error
+    if isinstance(mesh, pv.UnstructuredGrid):
+        from pyvista import _vtk
+        _vtk._CORE_MODULES['vtkFiltersGeneral'] = (*_vtk._CORE_MODULES['vtkFiltersGeneral'], 'vtkClipDataSet')
+        _vtk._VTK_CLASS_TO_MODULE = {
+            cls: module
+            for module, classes in (_vtk._CORE_MODULES | _vtk._PLOTTING_MODULES | _vtk._OPENGL_MODULES).items()
+            for cls in classes
+        }
+        _vtk.vtkTableBasedClipDataSet = _vtk.vtkClipDataSet
+
+    mesh_clip_plane_actor = pl.add_mesh_clip_plane(mesh, show_edges=True)
+    mesh_clip_plane_actor.visibility = False
+    clip_plane = pl.widgets.plane_widgets[-1]
+    clip_plane.Off()
+
+    def toggle_slice(state):
+        if state:
+            mesh_actor.visibility = False
+            opacity_slider_widget.Off()
+            mesh_clip_plane_actor.visibility = True
+            clip_plane.On()
+        else:
+            mesh_actor.visibility = True
+            opacity_slider_widget.On()
+            mesh_clip_plane_actor.visibility = False
+            clip_plane.Off()
+
+    pl.add_checkbox_button_widget(
+        callback=toggle_slice,
+        value=False,
+    )
+
+    pl.add_axes()
+    pl.show()
 
 
 def main() -> None:
     import argparse
 
-    desc = "A Python CLI tool to inspect Ansys Fluent .cas.h5/.msh.h5 files without opening Fluent"
-    parser = argparse.ArgumentParser(description=desc)
+    BANNER = r"""
+        ________      _
+  _____/ __/ __/   __(_)__ _      __
+ / ___/ /_/ /_| | / / / _ \ | /| / /
+/ /__/ __/ __/| |/ / /  __/ |/ |/ /
+\___/_/ /_/   |___/_/\___/|__/|__/
+
+A Python CLI tool to inspect Ansys Fluent .cas.h5/.msh.h5 files without opening Fluent
+"""
+
+    parser = argparse.ArgumentParser(
+        prog='cffview',
+        description=BANNER,
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
 
     parser.add_argument(
         "file_path",
@@ -535,6 +633,7 @@ def main() -> None:
         (("--rd", "--report-definitions"), "show report-definitions settings"),
         (("--plotsets",), "show report-definitions plotsets settings"),
         (("--monitorsets",), "show report-definitions monitorsets settings"),
+        (("--residuals",), "show residuals settings"),
         (("--iter",), "show iteration settings"),
         (("--contours",), "show graphics contours settings"),
         (("--vectors",), "show graphics vectors settings"),
@@ -558,19 +657,11 @@ def main() -> None:
             show_mesh(args.file_path)
         else:
             from .utils import print_colored_dict
-            kwargs = {
-                'solver': args.solver,
-                'mat': args.mat,
-                'bd': args.bd,
-                'ne': args.ne,
-                'disc': args.disc,
-                'rd': args.rd,
-                'plotsets': args.plotsets,
-                'monitorsets': args.monitorsets,
-                'contours': args.contours,
-                'vectors': args.vectors,
-                'iter': args.iter
-            }
+            keys = [
+                'solver', 'mat', 'bd', 'ne', 'disc', 'rd',
+                'plotsets', 'monitorsets', 'residuals', 'iter', 'contours', 'vectors',
+            ]
+            kwargs = {k: getattr(args, k) for k in keys}
             output = read_case(args.file_path, **kwargs)
             print_colored_dict(output)
 

{cffview-0.2.4 → cffview-0.3.0/src/cffview.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cffview
-Version: 0.2.4
+Version: 0.3.0
 Summary: A Python CLI tool to inspect Ansys Fluent .cas.h5/.msh.h5 files without opening Fluent
 Author-email: preamer <1524477126@qq.com>
 License-Expression: BSD-3-Clause
@@ -57,6 +57,9 @@ pip install .
 
 ## Usage
 
+> [!IMPORTANT]
+> Only tested with Ansys Fluent 25R2!
+
 ```
 cffview <file> [options]
 ```
@@ -69,13 +72,14 @@ cffview <file> [options]
 | `--extract` | Dump raw Scheme settings to `general.scm` and `boundary.scm` |
 | `--showmesh` | Visualise the mesh interactively with PyVista |
 | `--solver` | Solver type, time, dimension, precision, turbulence model, energy, radiation, gravity |
-| `--mat` | Material properties |
-| `--bd` | Boundary condition settings |
-| `--ne` | Named expressions |
+| `--mat`, `--materials` | Material properties |
+| `--bd`, `--boundary` | Boundary condition settings |
+| `--ne`, `--named-expressions` | Named expressions |
 | `--disc` | Discretisation schemes and relaxation factors |
-| `--rd` | Report definitions |
+| `--rd`, `--report-definitions` | Report definitions |
 | `--plotsets` | Plot sets |
 | `--monitorsets` | Monitor sets |
+| `--residuals` | Residual settings |
 | `--iter` | Iteration / time-step settings |
 | `--contours` | Graphics contours settings |
 | `--vectors` | Graphics vectors settings |
@@ -103,6 +107,10 @@ cffview case.cas.h5 --version
 cffview case.cas.h5 --extract
 ```
 
+### Demo
+
+[demo.webm](https://github.com/user-attachments/assets/9047a354-b5cb-475e-b030-97609e2a1274)
+
 ---
 
 ## License