cffview 0.3.0__tar.gz → 0.3.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cffview
-Version: 0.3.0
+Version: 0.3.2
 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

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "cffview"
-version = "0.3.0"
+version = "0.3.2"
 description = "A Python CLI tool to inspect Ansys Fluent .cas.h5/.msh.h5 files without opening Fluent"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -31,3 +31,6 @@ Repository = "https://github.com/preamer/cffview"
 
 [tool.setuptools.packages.find]
 where = ["src"]
+
+[tool.autopep8]
+max_line_length = 120

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

@@ -1,6 +1,61 @@
 from dataclasses import dataclass
 
 
+class BoundaryConsts:
+    VELOCITY_SPEC = {
+        '0': 'Magnitude and Direction',
+        '1': 'Components',
+        '2': 'Magnitude, Normal to Boundary',
+    }
+
+    FRAME_OF_REFERENCE = {
+        '0': 'Absolute',
+        '1': 'Ralative to Adjacent Cell Zone',
+    }
+
+    COORDINATE_SYSTEM = {
+        '0': 'Cartesian(X, Y, Z)',
+        '1': 'Cylindrical(Radial, Tangential, Axial)',
+        '2': 'Local Cylindrical(Radial, Tangential, Axial)',
+        '3': 'Local Cylindrical Swirl',
+    }
+
+    KE_SPEC = {
+        '1': 'Intensity and Length Scale',
+        '2': 'Intensity and Viscosity Ratio',
+        '3': 'Intensity and Hydraulic Diameter',
+    }
+
+    DIRECTION_SPEC = {
+        '0': 'Direction Vector',
+        '1': 'Normal to Boundary',
+    }
+
+    THERMAL_BC = {
+        '0': 'Heat Flux',
+        '1': 'Temperature',
+        '2': 'Convection',
+        '3': 'Coupled',
+        '4': 'Radiation',
+        '5': 'Mixed',
+        '8': 'via System Coupling',
+    }
+
+    MOTION_BC = {
+        '0': 'Stationary Wall',
+        '1': 'Moving Wall',
+    }
+
+    SHEAR_BC = {
+        '0': 'No Slip',
+        '1': 'Specified Shear',
+        '2': 'Specularity Coefficient',
+        '3': 'Marangoni Stress',
+    }
+
+    ROUGH_BC = {}
+
+
 class BoundaryFactory:
     _REGISTRY = {}
 
@@ -71,34 +126,27 @@ class VelocityInlet:
     frame_of_reference: str = ''
     vmag: str = ''
     t: str = ''
+
     ke_spec: str = ''
     turb_intensity: str = ''
     turb_hydraulic_diam: str = ''
     turb_viscosity_ratio: str = ''
 
-    _VELOCITY_SPEC = {
-        '1': 'Magnitude and Direction',
-        '2': 'Magnitude, Normal to Boundary',
-        '3': 'Components',
-    }
-
-    _FRAME_OF_REFERENCE = {
-        '0': 'Absolute',
-        '1': 'Ralative to Adjacent Cell Zone',
-    }
-
-    _KE_SPEC = {
-        '1': 'Intensity and Length Scale',
-        '2': 'Intensity and Viscosity Ratio',
-        '3': 'Intensity and Hydraulic Diameter',
-    }
+    coordinate_system: str = ''
+    ni: str = ''
+    nj: str = ''
+    nk: str = ''
+    u: str = ''
+    v: str = ''
+    w: str = ''
 
     def to_dict(self) -> dict[str, str]:
         data = self.__dict__.copy()
 
-        data['velocity_spec'] = self._VELOCITY_SPEC.get(self.velocity_spec, 'unknown')
-        data['frame_of_reference'] = self._FRAME_OF_REFERENCE.get(self.frame_of_reference, 'unknown')
-        data['ke_spec'] = self._KE_SPEC.get(self.ke_spec, 'unknown')
+        data['velocity_spec'] = BoundaryConsts.VELOCITY_SPEC.get(self.velocity_spec, 'unknown')
+        data['frame_of_reference'] = BoundaryConsts.FRAME_OF_REFERENCE.get(self.frame_of_reference, 'unknown')
+        data['coordinate_system'] = BoundaryConsts.COORDINATE_SYSTEM.get(self.coordinate_system, 'unknown')
+        data['ke_spec'] = BoundaryConsts.KE_SPEC.get(self.ke_spec, 'unknown')
 
         match data['ke_spec']:
             case 'Intensity and Length Scale':
@@ -111,6 +159,24 @@ class VelocityInlet:
                 data.pop('turb_length_scale', None)
                 data.pop('turb_viscosity_ratio', None)
 
+        match data['velocity_spec']:
+            case 'Magnitude and Direction':
+                data.pop('u', None)
+                data.pop('v', None)
+                data.pop('w', None)
+            case 'Components':
+                data.pop('ni', None)
+                data.pop('nj', None)
+                data.pop('nk', None)
+            case 'Magnitude, Normal to Boundary':
+                data.pop('coordinate_system', None)
+                data.pop('ni', None)
+                data.pop('nj', None)
+                data.pop('nk', None)
+                data.pop('u', None)
+                data.pop('v', None)
+                data.pop('w', None)
+
         return data
 
 
@@ -147,6 +213,13 @@ class PressureInlet:
     p0: str = ''
     p: str = ''
     t0: str = ''
+
+    direction_spec: str = ''
+    coordinate_system: str = ''
+    ni: str = ''
+    nj: str = ''
+    nk: str = ''
+
     ke_spec: str = ''
     prevent_reverse_flow: str = ''
     turb_intensity: str = ''
@@ -154,22 +227,22 @@ class PressureInlet:
     turb_hydraulic_diam: str = ''
     turb_viscosity_ratio: str = ''
 
-    _FRAME_OF_REFERENCE = {
-        '0': 'Absolute',
-        '1': 'Ralative to Adjacent Cell Zone',
-    }
-
-    _KE_SPEC = {
-        '1': 'Intensity and Length Scale',
-        '2': 'Intensity and Viscosity Ratio',
-        '3': 'Intensity and Hydraulic Diameter',
-    }
-
     def to_dict(self) -> dict[str, str]:
         data = self.__dict__.copy()
 
-        data['frame_of_reference'] = self._FRAME_OF_REFERENCE.get(self.frame_of_reference, 'unknown')
-        data['ke_spec'] = self._KE_SPEC.get(self.ke_spec, 'unknown')
+        data['frame_of_reference'] = BoundaryConsts.FRAME_OF_REFERENCE.get(self.frame_of_reference, 'unknown')
+        data['direction_spec'] = BoundaryConsts.DIRECTION_SPEC.get(self.direction_spec, 'unknown')
+        data['coordinate_system'] = BoundaryConsts.COORDINATE_SYSTEM.get(self.coordinate_system, 'unknown')
+        data['ke_spec'] = BoundaryConsts.KE_SPEC.get(self.ke_spec, 'unknown')
+
+        match data['direction_spec']:
+            case 'Direction Vector':
+                pass
+            case 'Normal to Boundary':
+                data.pop('coordinate_system', None)
+                data.pop('ni', None)
+                data.pop('nj', None)
+                data.pop('nk', None)
 
         match data['ke_spec']:
             case 'Intensity and Length Scale':
@@ -202,20 +275,17 @@ class PressureOutlet:
     turb_hydraulic_diam: str = ''
     turb_viscosity_ratio: str = ''
 
-    _KE_SPEC = {
-        '1': 'Intensity and Length Scale',
-        '2': 'Intensity and Viscosity Ratio',
-        '3': 'Intensity and Hydraulic Diameter',
-    }
-
     def to_dict(self) -> dict[str, str]:
         data = self.__dict__.copy()
 
         if self.prevent_reverse_flow == '#t':
-            for key in ['t', 'ke_spec', 'turb_intensity', 'turb_length_scale', 'targeted_mf_boundary', 'turb_hydraulic_diam', 'turb_viscosity_ratio']:
+            for key in [
+                't', 'ke_spec', 'turb_intensity', 'turb_length_scale',
+                'targeted_mf_boundary', 'turb_hydraulic_diam', 'turb_viscosity_ratio',
+            ]:
                 data.pop(key, None)
         else:
-            data['ke_spec'] = self._KE_SPEC.get(self.ke_spec, 'unknown')
+            data['ke_spec'] = BoundaryConsts.KE_SPEC.get(self.ke_spec, 'unknown')
             match data['ke_spec']:
                 case 'Intensity and Length Scale':
                     data.pop('turb_viscosity_ratio', None)
@@ -235,6 +305,7 @@ class PressureOutlet:
 class Outflow:
     name: str
     id_: str
+    flowrate_frac: str = ''
 
 
 @dataclass
@@ -245,10 +316,12 @@ class Wall:
     d: str = ''
     q_dot: str = ''
     material: str = ''
+
     thermal_bc: str = ''
     t: str = ''
     q: str = ''
     h: str = ''
+
     motion_bc: str = ''
     shear_bc: str = ''
     rough_bc: str = ''
@@ -257,21 +330,12 @@ class Wall:
     roughness_height: str = ''
     roughness_const: str = ''
 
-    _THERMAL_BC = {
-        '1': 'Heat Flux',
-        '2': 'Temperature',
-        '3': 'Coupled',
-    }
-
-    _MOTION_BC = {}
-
-    _SHEAR_BC = {}
-
-    _ROUGH_BC = {}
+    planar_conduction: str = ''
+    shell_conduction: str = ''
 
     _THERMAL_BC_WHITELIST = {
-        '1': {'q_dot'},  # Heat Flux
-        '2': {'t'},  # Temperature
+        '0': {'q_dot'},  # Heat Flux
+        '1': {'t'},  # Temperature
         '3': set(),  # Coupled
     }
 
@@ -284,7 +348,12 @@ class Wall:
         for attr in attrs_to_remove:
             data.pop(attr, None)
 
-        data['thermal_bc'] = self._THERMAL_BC.get(self.thermal_bc, 'unknown')
+        data['thermal_bc'] = BoundaryConsts.THERMAL_BC.get(self.thermal_bc, 'unknown')
+        data['motion_bc'] = BoundaryConsts.MOTION_BC.get(self.motion_bc, 'unknown')
+        data['shear_bc'] = BoundaryConsts.SHEAR_BC.get(self.shear_bc, 'unknown')
+
+        if data['planar_conduction'] == '#f':
+            data.pop('shell_conduction', None)
 
         return data
 

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

@@ -1,4 +1,4 @@
-from typing import Literal
+from typing import Literal, TypeAlias, Union
 
 
 def print_version(file_path: str) -> str:
@@ -42,6 +42,9 @@ def read_case(file_path: str, **kwargs) -> dict[
     """
     import re
     import h5py
+    import sexpdata
+
+    SexpdataList: TypeAlias = list[Union[sexpdata.Symbol, 'SexpdataList']]
 
     with h5py.File(file_path) as f:
         settings: h5py.Group = f['/settings']
@@ -150,36 +153,53 @@ def read_case(file_path: str, **kwargs) -> dict[
         }
 
     if kwargs['mat']:
-        import sexpdata
-
         data['materials'] = {}
         materials = re.search(
             r'(\(materials.*)',
             general_info,
             re.M
         ).group(1)
-        materials: list = sexpdata.loads(materials)
+        materials: SexpdataList = sexpdata.loads(materials)
         for material in materials[1]:
             name = str(material[0])
             data['materials'][name] = {}
             data['materials'][name]['type'] = str(material[1])
-            for i in range(2, len(material)):
-                property_ = material[i]
+            for property_ in material[2:]:
+                property_name = str(property_[0])
                 if property_[1] == sexpdata.Symbol('.'):
-                    data['materials'][name][str(property_[0])] = str(property_[2])
-                elif isinstance(p1 := property_[1], list):
-                    if p1[1] == sexpdata.Symbol('.'):
-                        data['materials'][name][str(property_[0])] = f'{p1[0]}/{p1[2]}'
+                    data['materials'][name][property_name] = str(property_[2])
+                elif isinstance(property_value_list := property_[1], list):
+                    if property_value_list[1] == sexpdata.Symbol('.'):
+                        data['materials'][name][property_name] = f'{property_value_list[0]}/{property_value_list[2]}'
+                    elif str(property_value_list[1]) == 'piecewise-linear':
+                        value = [f'{p[0]}, {p[2]}' for p in property_value_list[2:]]
+                        data['materials'][name][property_name] = {
+                            f'{property_value_list[0]}/{property_value_list[1]}': value
+                        }
+                    elif str(property_value_list[1]) in ['piecewise-polynomial', 'nasa-9-piecewise-polynomial']:
+                        value = [str(p).strip('[]') for p in property_value_list[2:]]
+                        data['materials'][name][property_name] = {
+                            f'{property_value_list[0]}/{property_value_list[1]}': value
+                        }
+                    elif str(property_value_list[0]) == 'orthotropic':
+                        value = {}
+                        for p in property_value_list[1:]:
+                            orth_property_name = str(p[0])
+                            if orth_property_name in ['direction-0', 'direction-1', 'direction-2']:
+                                value[orth_property_name] = str(p[1:]).strip('[]')
+                                value[orth_property_name] = sexpdata.cdr(p)
+                            elif orth_property_name in ['k0', 'k1', 'k2']:
+                                value[orth_property_name] = f'{sexpdata.car(p[1])}/{sexpdata.cdr(p[1])}'
+                        data['materials'][name][property_name] = {f'{property_value_list[0]}': value}
                     else:
-                        value = ' '.join(str(p) for p in p1[1:])
-                        data['materials'][name][str(property_[0])] = f'{p1[0]}/{value}'
+                        value = ' '.join(str(p) for p in property_value_list[1:])
+                        data['materials'][name][property_name] = f'{property_value_list[0]}/{value}'
 
     if kwargs['bd']:
-        import sexpdata
         from .boundary import BoundaryFactory
 
         data['boundary'] = {}
-        boundaries: list[list] = sexpdata.parse(boundary_info, true=None)
+        boundaries: list[SexpdataList] = sexpdata.parse(boundary_info, true=None)
         for boundary_info in boundaries:
             id_, type_, name, _ = [str(_) for _ in boundary_info[1]]
             new_boundary = BoundaryFactory.create(name, id_, type_)
@@ -198,15 +218,13 @@ def read_case(file_path: str, **kwargs) -> dict[
             data['boundary'][type_] = b_list
 
     if kwargs['ne']:
-        import sexpdata
-
         data['named-expressions'] = {}
         nes = re.search(
             r'(\(named-expressions.*)',
             general_info,
             re.M
         ).group(1)
-        nes: list = sexpdata.loads(nes, true=None)[1]
+        nes: SexpdataList = sexpdata.loads(nes, true=None)[1]
         for ne in nes:
             ne_dict = {
                 str(property_[0]): str(property_[2])
@@ -252,15 +270,13 @@ def read_case(file_path: str, **kwargs) -> dict[
                 data['relax-factor'][eq] = relax_factor.get(eq, '')
 
     if kwargs['rd']:
-        import sexpdata
-
         data['report-definitions'] = {}
         rds = re.search(
             r'(\(monitor/report-definitions.*)',
             general_info,
             re.M
         ).group(1)
-        rds: list = sexpdata.loads(rds, true=None)[1]
+        rds: SexpdataList = sexpdata.loads(rds, true=None)[1]
         for rd in rds:
             name = str(rd[0][2])
             type_ = str(rd[1][1])
@@ -278,15 +294,13 @@ def read_case(file_path: str, **kwargs) -> dict[
                 data['report-definitions'][name]['per-zone?'] = str(rd[1][-5][2])
 
     if kwargs['plotsets']:
-        import sexpdata
-
         data['plotsets'] = {}
         plotsets = re.search(
             r'(\(monitor/plotsets.*)',
             general_info,
             re.M
         ).group(1)
-        plotsets: list = sexpdata.loads(plotsets, true=None)[1]
+        plotsets: SexpdataList = sexpdata.loads(plotsets, true=None)[1]
         for plotset in plotsets:
             plotset_dict = {
                 str(property_[0]): str(property_[2])
@@ -297,15 +311,13 @@ def read_case(file_path: str, **kwargs) -> dict[
             data['plotsets'][plotset_dict['name']] = plotset_dict
 
     if kwargs['monitorsets']:
-        import sexpdata
-
         data['monitorsets'] = {}
         monitorsets = re.search(
             r'(\(monitor/monitorsets.*)',
             general_info,
             re.M
         ).group(1)
-        monitorsets: list = sexpdata.loads(monitorsets, true=None)[1]
+        monitorsets: SexpdataList = sexpdata.loads(monitorsets, true=None)[1]
         for monitorset in monitorsets:
             monitorset_dict = {
                 str(property_[0]): str(property_[2])
@@ -316,8 +328,6 @@ def read_case(file_path: str, **kwargs) -> dict[
             data['monitorsets'][monitorset_dict['name']] = monitorset_dict
 
     if kwargs['residuals']:
-        import sexpdata
-
         data['residuals'] = {}
 
         for setting in [
@@ -350,7 +360,7 @@ def read_case(file_path: str, **kwargs) -> dict[
             general_info,
             re.M
         ).group(1)
-        res: list = sexpdata.loads(res, true=None)[1]
+        res: SexpdataList = sexpdata.loads(res, true=None)[1]
         for eq in res:
             data['residuals'][str(eq[0])] = {
                 'monitor': str(eq[1]),
@@ -395,15 +405,13 @@ def read_case(file_path: str, **kwargs) -> dict[
                 ).group(1)
 
     if kwargs['contours']:
-        import sexpdata
-
         data['contours'] = {}
         contours = re.search(
             r'(\(graphics/contours.*)',
             general_info,
             re.M
         ).group(1)
-        contours: list = sexpdata.loads(contours, true=None)[1]
+        contours: SexpdataList = sexpdata.loads(contours, true=None)[1]
         for contour in contours:
             contour_dict = {
                 str(property_[0]): str(property_[2])
@@ -426,15 +434,13 @@ def read_case(file_path: str, **kwargs) -> dict[
             data['contours'][contour_dict['name']] = contour_dict
 
     if kwargs['vectors']:
-        import sexpdata
-
         data['vectors'] = {}
         vectors = re.search(
             r'(\(graphics/vectors\s.*)',
             general_info,
             re.M
         ).group(1)
-        vectors: list = sexpdata.loads(vectors, true=None)[1]
+        vectors: SexpdataList = sexpdata.loads(vectors, true=None)[1]
         for vector in vectors:
             vector_dict = {
                 str(property_[0]): str(property_[2])
@@ -495,6 +501,8 @@ def show_mesh(file_path: str) -> None:
         Path to the .h5 file
     """
     import pyvista as pv
+    from .utils import KEYBOARD_SHORTCUTS, print_colored_dict
+
     if file_path.endswith('cas.h5'):
         mesh = pv.read(file_path)
     elif file_path.endswith('msh.h5'):
@@ -546,14 +554,11 @@ def show_mesh(file_path: str) -> None:
     pl = pv.Plotter()
     pl.enable_anti_aliasing()
 
-    mesh = mesh.combine() if mesh.n_blocks > 1 else mesh
+    mesh = mesh.combine() if isinstance(mesh, pv.MultiBlock) 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,
+        lambda value: setattr(mesh_actor.prop, 'opacity', value),
         rng=(0.1, 1.0),
         value=1.0,
         title="Opacity",
@@ -591,13 +596,18 @@ def show_mesh(file_path: str) -> None:
     pl.add_checkbox_button_widget(
         callback=toggle_slice,
         value=False,
+        position=(10, 10),
+        size=40,
     )
+    pl.add_text("Clip Plane", position=(60, 20), font_size=10)
 
-    pl.add_axes()
+    pl.add_axes(viewport=(0.8, 0.0, 1.0, 0.2))
+    print_colored_dict(KEYBOARD_SHORTCUTS)
     pl.show()
 
 
 def main() -> None:
+    import os
     import argparse
 
     BANNER = r"""
@@ -623,8 +633,9 @@ A Python CLI tool to inspect Ansys Fluent .cas.h5/.msh.h5 files without opening
     )
 
     ARGUMENTS = [
-        (("--extract",), "extract cas.h5 general and boundary string to files"),
         (("--version",), "show the version of the .h5 file"),
+        (("--extract",), "extract cas.h5 general and boundary string to files"),
+        (("--showmesh",), "show mesh using pyvista"),
         (("--solver",), "show solver settings"),
         (("--mat", "--materials"), "show materials settings"),
         (("--bd", "--boundary"), "show boundary settings"),
@@ -638,7 +649,6 @@ A Python CLI tool to inspect Ansys Fluent .cas.h5/.msh.h5 files without opening
         (("--contours",), "show graphics contours settings"),
         (("--vectors",), "show graphics vectors settings"),
         (("--save",), "save output to file"),
-        (("--showmesh",), "show mesh using pyvista"),
     ]
 
     for flags, help_text in ARGUMENTS:
@@ -646,6 +656,10 @@ A Python CLI tool to inspect Ansys Fluent .cas.h5/.msh.h5 files without opening
 
     args = parser.parse_args()
 
+    if not args.file_path.endswith((".cas.h5", ".msh.h5")):
+        print("Invalid file path. Please provide a .cas.h5 or .msh.h5 file.")
+        return
+
     if args.version:
         print_version(args.file_path)
     elif args.extract:

{cffview-0.3.0 → cffview-0.3.2}/src/cffview/utils.py

@@ -1,3 +1,5 @@
+import sys
+
 # From context.scm
 FLUENT_ENUM = {
     "0": "First Order Upwind",
@@ -64,6 +66,43 @@ CELL_TYPES = {
     7: "Polyhedron",
 }
 
+KEYBOARD_SHORTCUTS = {
+    'q': 'Close the rendering window',
+    'f': 'Focus and zoom in on a point',
+    'v': 'Isometric camera view',
+    'w': 'Switch all datasets to a wireframe representation',
+    'r': 'Reset the camera to view all datasets',
+    's': 'Switch all datasets to a surface representation',
+    'shift+click or middle-click' if not sys.platform.startswith('darwin') else 'shift+click': 'Pan the rendering scene',
+    'left-click' if not sys.platform.startswith('darwin') else 'cmd+click': 'Rotate the rendering scene in 3D',
+    'ctrl+click': 'Rotate the rendering scene in 2D(view-plane)',
+    'mouse-wheel or right-click' if not sys.platform.startswith('darwin') else 'ctl+click': 'Continuously zoom the rendering scene',
+    'shift+s': 'Save a screenshot(only on BackgroundPlotter)',
+    'shift+c': 'Enable interactive cell selection/picking',
+    'up/down': 'Zoom in and out',
+    '+ /-': 'Increase/decrease the point size and line widths',
+}
+
+DATA_KEYS = (
+    'SV_BF_V',
+    'SV_DENSITY',
+    'SV_DENSITY_RG_AUX',
+    'SV_DISCONT',
+    'SV_H',
+    'SV_H_RG_AUX',
+    'SV_MU_LAM',
+    'SV_NORMAL_MACH',
+    'SV_P',
+    'SV_P_RG_AUX',
+    'SV_T',
+    'SV_U',
+    'SV_U_RG_AUX',
+    'SV_V',
+    'SV_V_RG_AUX',
+    'SV_W',
+    'SV_W_RG_AUX',
+)
+
 
 def print_colored_dict(data) -> None:
     """Print nested data in 4-space JSON format.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cffview
-Version: 0.3.0
+Version: 0.3.2
 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