cfdpre 0.2.4__tar.gz → 0.3.0__tar.gz

cfdpre-0.3.0/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.1
+Name: cfdpre
+Version: 0.3.0
+Summary: CFD PreProcessing Library
+Author: Pushkar Sheth
+Author-email: siglyserdev@gmail.com
+Description-Content-Type: text/markdown
+Requires-Dist: numpy
+Requires-Dist: CoolProp
+
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/phsheth/cfdpre/refs/heads/main/cfdprelogo.png" width="300">
+</h1><br>
+
+
+What is CFDPre?
+----------------------
+
+CFDPre is an open-source collection of object-oriented software tools for
+calculating boundary layer mesh dimensions for Computational Fluid Dynamics simulations.
+Among other things, it can be used to:
+
+* Calculate First Layer Thickness, Growth Ratio and Final Layer Thickess
+
+
+Installation
+----------------------
+
+[![Install](https://img.shields.io/pypi/v/cfdpre?label=CFDPre)](
+https://pypi.org/project/cfdpre/) [![PyPI Downloads](https://img.shields.io/pypi/dm/cfdpre?label=PyPI%20Downloads)](
+https://pypistats.org/packages/cfdpre)
+
+In your command line, within Python environment:
+```pythom
+    pip install cfdpre
+```
+- The Python module can also be installed using pip on Windows, macOS, and Linux.
+
+
+Usage
+----------------------
+
+`yhgrcalc` supports two flow types:
+
+- **`flow_type='internal'`** (default) — fully-developed pipe/duct flow. `massflow_kgpersec`
+  and `hydraulicdia_mm` are used to derive velocity and Reynolds number. Skin friction uses
+  the laminar (`Re < 2300`, `16/Re`) or the **Haaland (1983)** explicit turbulent correlation,
+  valid across the full turbulent range for smooth and rough pipes (`roughness_mm`) — unlike
+  Blasius, which is only accurate below `Re ≈ 1e5`. The prism-stack thickness defaults to the
+  pipe radius, but you can set it explicitly with `bl_thickness_mm` or as a fraction of the
+  radius with `bl_thickness_fraction` (filling the entire radius with prisms is rarely what
+  you actually mesh).
+- **`flow_type='external'`** — flow over a flat plate / aerodynamic surface.
+  `hydraulicdia_mm` is interpreted as a characteristic length (e.g. chord length), and
+  `flow_velocity_mpersec` is **required** (the mass-flow/area velocity is meaningless for
+  external flow). Skin friction and boundary layer thickness use the laminar (Blasius) or
+  turbulent (Schlichting) flat-plate correlations; `bl_thickness_mm` can override the
+  correlation-based thickness.
+
+If the computed growth ratio exceeds ~1.3 (or the boundary layer is too thin to resolve
+with the requested `target_yplus`/`num_layers`), a `UserWarning` is raised so you can
+adjust your inputs.
+
+```python
+from cfdpre import yhgrcalc
+yhgrcalc('Air', 50, 10, 2.5, 125, 1, 8)
+```
+
+Output:
+```python
+{'fluid': 'Air',
+ 'temperature [C]': 50,
+ 'pressure [bar]': 10,
+ 'massflow [kg/sec]': 2.5,
+ 'hydraulicdia [mm]': 125,
+ 'target yplus': 1,
+ 'number of layers': 8,
+ 'flow type': 'internal',
+ 'roughness [mm]': 0.0,
+ 'dynvisc [N-sec/m^2]': 1.9762497305390764e-05,
+ 'thermal conductivity [W/m-k]': 0.028357331300649127,
+ 'specific heat [cp] [J/kg-k]': 1019.3146170790077,
+ 'density [kg/m^3]': 10.792698589669245,
+ 'kinematic viscosity [m^2/s]': 1.8310987878701066e-06,
+ 'flow velocity [m/sec]': 18.875569021507275,
+ 'reynolds number': 1288541.1444310248,
+ 'prandtl number': 0.7103701741111368,
+ 'skin friction coefficient [cf]': 0.002776948990231969,
+ 'wall shear stress [tau_wall]': 5.339100066909961,
+ 'boundary layer thickness [delta99] [m]': 0.0625,
+ 'height of cell centroid from wall [yp] [m]': 2.6034112015544278e-06,
+ 'first layer height [yh] [m]': 5.2068224031088555e-06,
+ 'Growth Ratio': 3.6553638704281375,
+ 'Final Layer Thickness [m]': 0.04540326342524223}
+```
+
+> Note: with `target_yplus=1` and only 8 layers at this high Reynolds number (~1.29e6),
+> the growth ratio comes out to ~3.66, well above the recommended ~1.3 maximum — this
+> example raises a `UserWarning` accordingly. In practice you'd either use far more layers
+> (20-40+) or restrict the prism stack to part of the radius. For example, spanning only
+> 30% of the radius:
+>
+> ```python
+> yhgrcalc('Air', 50, 10, 2.5, 125, 1, 8, bl_thickness_fraction=0.3)  # GR ~3.04
+> ```
+
+External flow example (`flow_velocity_mpersec` is required):
+```python
+yhgrcalc('Air', 25, 1.01325, 2.5, 1000, 1, 15, flow_type='external', flow_velocity_mpersec=30)
+```
+
+Documentation
+----------------------
+
+In progress - not yet made!
+
+- **Project Home Page:** https://cfdpre.github.io/ [under construction]
+- **Users Group:** https://groups.google.com/g/cfdpre
+- **Source code:** https://github.com/phsheth/cfdpre
+- **PyPI Page:** https://pypi.org/project/cfdpre/
+
+
+
+Call for Contributors
+----------------------
+
+The CFDPre project welcomes your expertise and enthusiasm! Better to discuss on the users group before starting to contribute!
+
+
+Project Log
+----------------------
+January 2025:
+1. Created Library
+
+June 2026:
+1. Added `flow_type` ('internal'/'external') support. Internal flow uses laminar `16/Re`
+   and the Haaland (1983) turbulent correlation (valid to high Re, smooth/rough via
+   `roughness_mm`); external flow uses Blasius/Schlichting flat-plate correlations and now
+   requires `flow_velocity_mpersec`. Prism-stack thickness is selectable via `bl_thickness_mm`
+   or `bl_thickness_fraction`. Added growth-ratio (>1.3) and boundary-layer sanity warnings.
+
+
+Project RoadMap:
+----------------------
+
+1. Documentation for existing functionality.
+2. Include example data within library.
+3. Object-oriented API refactor + input validation.
+4. Generate `snappyHexMeshDict`-ready `addLayersControls` snippets.
+5. Bundled examples, unit tests, CI, and docs site.
+6. Parametric/batch sweeps.
+
+
+
+
+
+

cfdpre-0.3.0/README.md

@@ -0,0 +1,147 @@
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/phsheth/cfdpre/refs/heads/main/cfdprelogo.png" width="300">
+</h1><br>
+
+
+What is CFDPre?
+----------------------
+
+CFDPre is an open-source collection of object-oriented software tools for
+calculating boundary layer mesh dimensions for Computational Fluid Dynamics simulations.
+Among other things, it can be used to:
+
+* Calculate First Layer Thickness, Growth Ratio and Final Layer Thickess
+
+
+Installation
+----------------------
+
+[![Install](https://img.shields.io/pypi/v/cfdpre?label=CFDPre)](
+https://pypi.org/project/cfdpre/) [![PyPI Downloads](https://img.shields.io/pypi/dm/cfdpre?label=PyPI%20Downloads)](
+https://pypistats.org/packages/cfdpre)
+
+In your command line, within Python environment:
+```pythom
+    pip install cfdpre
+```
+- The Python module can also be installed using pip on Windows, macOS, and Linux.
+
+
+Usage
+----------------------
+
+`yhgrcalc` supports two flow types:
+
+- **`flow_type='internal'`** (default) — fully-developed pipe/duct flow. `massflow_kgpersec`
+  and `hydraulicdia_mm` are used to derive velocity and Reynolds number. Skin friction uses
+  the laminar (`Re < 2300`, `16/Re`) or the **Haaland (1983)** explicit turbulent correlation,
+  valid across the full turbulent range for smooth and rough pipes (`roughness_mm`) — unlike
+  Blasius, which is only accurate below `Re ≈ 1e5`. The prism-stack thickness defaults to the
+  pipe radius, but you can set it explicitly with `bl_thickness_mm` or as a fraction of the
+  radius with `bl_thickness_fraction` (filling the entire radius with prisms is rarely what
+  you actually mesh).
+- **`flow_type='external'`** — flow over a flat plate / aerodynamic surface.
+  `hydraulicdia_mm` is interpreted as a characteristic length (e.g. chord length), and
+  `flow_velocity_mpersec` is **required** (the mass-flow/area velocity is meaningless for
+  external flow). Skin friction and boundary layer thickness use the laminar (Blasius) or
+  turbulent (Schlichting) flat-plate correlations; `bl_thickness_mm` can override the
+  correlation-based thickness.
+
+If the computed growth ratio exceeds ~1.3 (or the boundary layer is too thin to resolve
+with the requested `target_yplus`/`num_layers`), a `UserWarning` is raised so you can
+adjust your inputs.
+
+```python
+from cfdpre import yhgrcalc
+yhgrcalc('Air', 50, 10, 2.5, 125, 1, 8)
+```
+
+Output:
+```python
+{'fluid': 'Air',
+ 'temperature [C]': 50,
+ 'pressure [bar]': 10,
+ 'massflow [kg/sec]': 2.5,
+ 'hydraulicdia [mm]': 125,
+ 'target yplus': 1,
+ 'number of layers': 8,
+ 'flow type': 'internal',
+ 'roughness [mm]': 0.0,
+ 'dynvisc [N-sec/m^2]': 1.9762497305390764e-05,
+ 'thermal conductivity [W/m-k]': 0.028357331300649127,
+ 'specific heat [cp] [J/kg-k]': 1019.3146170790077,
+ 'density [kg/m^3]': 10.792698589669245,
+ 'kinematic viscosity [m^2/s]': 1.8310987878701066e-06,
+ 'flow velocity [m/sec]': 18.875569021507275,
+ 'reynolds number': 1288541.1444310248,
+ 'prandtl number': 0.7103701741111368,
+ 'skin friction coefficient [cf]': 0.002776948990231969,
+ 'wall shear stress [tau_wall]': 5.339100066909961,
+ 'boundary layer thickness [delta99] [m]': 0.0625,
+ 'height of cell centroid from wall [yp] [m]': 2.6034112015544278e-06,
+ 'first layer height [yh] [m]': 5.2068224031088555e-06,
+ 'Growth Ratio': 3.6553638704281375,
+ 'Final Layer Thickness [m]': 0.04540326342524223}
+```
+
+> Note: with `target_yplus=1` and only 8 layers at this high Reynolds number (~1.29e6),
+> the growth ratio comes out to ~3.66, well above the recommended ~1.3 maximum — this
+> example raises a `UserWarning` accordingly. In practice you'd either use far more layers
+> (20-40+) or restrict the prism stack to part of the radius. For example, spanning only
+> 30% of the radius:
+>
+> ```python
+> yhgrcalc('Air', 50, 10, 2.5, 125, 1, 8, bl_thickness_fraction=0.3)  # GR ~3.04
+> ```
+
+External flow example (`flow_velocity_mpersec` is required):
+```python
+yhgrcalc('Air', 25, 1.01325, 2.5, 1000, 1, 15, flow_type='external', flow_velocity_mpersec=30)
+```
+
+Documentation
+----------------------
+
+In progress - not yet made!
+
+- **Project Home Page:** https://cfdpre.github.io/ [under construction]
+- **Users Group:** https://groups.google.com/g/cfdpre
+- **Source code:** https://github.com/phsheth/cfdpre
+- **PyPI Page:** https://pypi.org/project/cfdpre/
+
+
+
+Call for Contributors
+----------------------
+
+The CFDPre project welcomes your expertise and enthusiasm! Better to discuss on the users group before starting to contribute!
+
+
+Project Log
+----------------------
+January 2025:
+1. Created Library
+
+June 2026:
+1. Added `flow_type` ('internal'/'external') support. Internal flow uses laminar `16/Re`
+   and the Haaland (1983) turbulent correlation (valid to high Re, smooth/rough via
+   `roughness_mm`); external flow uses Blasius/Schlichting flat-plate correlations and now
+   requires `flow_velocity_mpersec`. Prism-stack thickness is selectable via `bl_thickness_mm`
+   or `bl_thickness_fraction`. Added growth-ratio (>1.3) and boundary-layer sanity warnings.
+
+
+Project RoadMap:
+----------------------
+
+1. Documentation for existing functionality.
+2. Include example data within library.
+3. Object-oriented API refactor + input validation.
+4. Generate `snappyHexMeshDict`-ready `addLayersControls` snippets.
+5. Bundled examples, unit tests, CI, and docs site.
+6. Parametric/batch sweeps.
+
+
+
+
+
+

cfdpre-0.3.0/cfdpre/__init__.py

@@ -0,0 +1,3 @@
+# __init__.py
+
+from .main import yhgrcalc

cfdpre-0.3.0/cfdpre/main.py

@@ -0,0 +1,234 @@
+# main.py
+
+
+import warnings
+
+import numpy as np
+import CoolProp.CoolProp as CP
+
+
+
+def calculate_f(r, N, delta99, yH):
+
+    """Calculates the function f(r) for root finding."""
+
+    return r**N - r * (delta99 / yH) + (delta99 / yH - 1)
+
+
+
+def calculate_df_dr(r, N, delta99, yH):
+
+    """Calculates the derivative of f(r) with respect to r."""
+
+    return N * r**(N-1) - (delta99 / yH)
+
+
+
+def newton_raphson(N, delta99, yH, initial_guess=5, tolerance=1e-12, max_iterations=1000):
+
+    """Finds the growth ratio using the Newton-Raphson method."""
+
+    r = initial_guess
+
+    for _ in range(max_iterations):
+
+        f_r = calculate_f(r, N, delta99, yH)
+
+        df_dr = calculate_df_dr(r, N, delta99, yH)
+
+        r_new = r - f_r / df_dr
+       
+
+        if np.abs(r_new - r) < tolerance:
+
+            return r_new
+
+        r = r_new
+
+    return r
+
+
+
+
+def yhgrcalc(fluid, temperature_c, pressure_bar, massflow_kgpersec, hydraulicdia_mm,
+             target_yplus, num_layers, flow_type='internal', flow_velocity_mpersec=None,
+             bl_thickness_mm=None, bl_thickness_fraction=None, roughness_mm=0.0):
+
+    """Calculate boundary layer mesh sizing (first layer height, growth ratio, final layer thickness).
+
+    Two flow types are supported:
+
+    - ``'internal'`` (default): fully-developed pipe/duct flow. ``massflow_kgpersec`` and
+      ``hydraulicdia_mm`` are used to derive the flow velocity and Reynolds number. The skin
+      friction coefficient uses the laminar (``Re < 2300``, ``16/Re``) or the Haaland (1983)
+      explicit turbulent correlation, which is valid across the full turbulent range for both
+      smooth and rough pipes (unlike the Blasius ``0.079*Re^-0.25`` form, which is only valid
+      for ``Re < ~1e5``). The prism-stack thickness to be spanned defaults to the pipe radius,
+      but can be set explicitly with ``bl_thickness_mm`` or as a fraction of the radius with
+      ``bl_thickness_fraction`` (filling the whole radius is rarely what you mesh in practice).
+    - ``'external'``: flow over a flat plate / aerodynamic surface. ``hydraulicdia_mm`` is
+      interpreted as the characteristic length (e.g. chord or plate length) along the flow
+      direction. ``flow_velocity_mpersec`` is **required** (the mass-flow/area velocity is
+      meaningless for external flow). The skin friction coefficient and boundary layer
+      thickness use the laminar (``Re < 5e5``, Blasius flat plate) or turbulent (Schlichting)
+      flat-plate correlations; ``bl_thickness_mm`` can override the correlation-based thickness.
+
+    Args:
+        fluid (str): CoolProp fluid name (e.g. ``'Air'``, ``'Water'``).
+        temperature_c (float): Static temperature in degrees Celsius.
+        pressure_bar (float): Static pressure in bar (absolute).
+        massflow_kgpersec (float): Mass flow rate in kg/s (used for internal flow).
+        hydraulicdia_mm (float): Hydraulic diameter (internal flow) or characteristic
+            length (external flow) in mm.
+        target_yplus (float): Target y+ value at the first cell centroid.
+        num_layers (int): Number of inflation/prism layers.
+        flow_type (str): ``'internal'`` (default) or ``'external'``.
+        flow_velocity_mpersec (float, optional): Free-stream velocity in m/s. Required for
+            ``flow_type='external'``; ignored for internal flow (derived from mass flow).
+        bl_thickness_mm (float, optional): Explicit total prism-stack thickness in mm to be
+            spanned by the layers. Overrides the default (pipe radius for internal,
+            correlation BL thickness for external).
+        bl_thickness_fraction (float, optional): Internal flow only. Prism-stack thickness as
+            a fraction of the pipe radius (0 < f <= 1), e.g. 0.3 for 30% of the radius.
+            Ignored if ``bl_thickness_mm`` is given.
+        roughness_mm (float): Absolute wall roughness in mm for the Haaland turbulent
+            internal correlation. Default 0.0 (hydraulically smooth).
+
+    Returns:
+        dict: Fluid properties, flow conditions, and boundary layer mesh sizing results,
+        including ``'Growth Ratio'`` and ``'Final Layer Thickness [m]'``.
+
+    Warns:
+        UserWarning: If the boundary layer thickness is not larger than the first layer
+            height (mesh sizing inputs are inconsistent), or if the resulting growth ratio
+            exceeds the commonly recommended maximum of ~1.3.
+
+    Raises:
+        ValueError: If ``flow_type`` is invalid, if ``flow_type='external'`` is requested
+            without ``flow_velocity_mpersec``, or if ``bl_thickness_fraction`` is outside (0, 1].
+
+    Example:
+        >>> from cfdpre import yhgrcalc
+        >>> yhgrcalc('Air', 50, 10, 2.5, 125, 1, 8)
+    """
+
+    if flow_type not in ('internal', 'external'):
+        raise ValueError("flow_type must be 'internal' or 'external', got %r" % (flow_type,))
+
+    if flow_type == 'external' and flow_velocity_mpersec is None:
+        raise ValueError(
+            "flow_type='external' requires flow_velocity_mpersec (free-stream velocity in "
+            "m/s); deriving velocity from mass flow and a pipe-area assumption is meaningless "
+            "for external flow."
+        )
+
+    if bl_thickness_fraction is not None and not (0 < bl_thickness_fraction <= 1):
+        raise ValueError(
+            "bl_thickness_fraction must be in the interval (0, 1], got %r" % (bl_thickness_fraction,)
+        )
+
+    pressure_pa = pressure_bar * 1e5
+    hydraulicdia_m = hydraulicdia_mm/1000
+    temperature_k = temperature_c + 273.15
+
+    dynvisc_pas = CP.PropsSI('V', 'T', temperature_k, 'P', pressure_pa, fluid)
+    dynvisc_nsm2 = dynvisc_pas
+
+    thermal_conductivity_wpermk = CP.PropsSI('L', 'T', temperature_k, 'P', pressure_pa, fluid)
+    specific_heat_cp_jperkgk = CP.PropsSI('C', 'T', temperature_k, 'P', pressure_pa, fluid)
+    density_kgperm3 =  CP.PropsSI('D', 'T', temperature_k, 'P', pressure_pa, fluid)
+    kinevisc_m2s = dynvisc_nsm2 / density_kgperm3
+    volflowrate_m3persec = massflow_kgpersec / density_kgperm3
+
+    if flow_type == 'external':
+        flowvelocity_mpersec = flow_velocity_mpersec
+    else:
+        flowvelocity_mpersec = volflowrate_m3persec / ((np.pi/4) * np.power(hydraulicdia_m, 2))
+
+    reynolds = flowvelocity_mpersec * hydraulicdia_m / kinevisc_m2s
+    prandtl = specific_heat_cp_jperkgk * dynvisc_nsm2 / thermal_conductivity_wpermk
+
+    if flow_type == 'internal':
+        radius_m = hydraulicdia_m / 2
+        if reynolds < 2300:
+            cf = 16 / reynolds  # laminar pipe flow, Fanning friction factor (= Hagen-Poiseuille)
+        else:
+            # Haaland (1983) explicit approximation to Colebrook. Valid across the full
+            # turbulent range for smooth and rough pipes, avoiding Blasius's ~Re<1e5 ceiling.
+            rough_ratio = (roughness_mm / 1000) / hydraulicdia_m
+            f_darcy = (1.0 / (-1.8 * np.log10((6.9 / reynolds) + (rough_ratio / 3.7) ** 1.11))) ** 2
+            cf = f_darcy / 4.0  # convert Darcy -> Fanning (skin friction coefficient)
+        # prism-stack thickness to span: explicit > fraction-of-radius > full radius
+        if bl_thickness_mm is not None:
+            delta99 = bl_thickness_mm / 1000
+        elif bl_thickness_fraction is not None:
+            delta99 = bl_thickness_fraction * radius_m
+        else:
+            delta99 = radius_m
+    else:
+        if reynolds < 5e5:
+            cf = 0.664 / np.sqrt(reynolds)  # Blasius laminar flat plate
+            delta99 = 4.91 * hydraulicdia_m / np.sqrt(reynolds)
+        else:
+            cf = np.power(((2 * np.log10(reynolds) - 0.65)), (-2.3))  # Schlichting turbulent flat plate
+            delta99 = 0.38 * hydraulicdia_m * reynolds**(-1/5)
+        if bl_thickness_mm is not None:
+            delta99 = bl_thickness_mm / 1000
+
+    tau_wall = 0.5 * density_kgperm3 * np.square(flowvelocity_mpersec) * cf # wall shear stress
+    u_tau = np.sqrt(tau_wall/density_kgperm3) #friction velocity
+    yp_m = (target_yplus * dynvisc_nsm2)  /(u_tau * density_kgperm3)
+    yh_m = yp_m * 2
+
+    if delta99 <= yh_m:
+        warnings.warn(
+            "Boundary layer thickness (%.3e m) is not larger than the first layer height "
+            "(%.3e m). Reduce target_yplus/num_layers or check the input flow conditions "
+            "and geometry." % (delta99, yh_m),
+            UserWarning,
+        )
+        growth_ratio = float('nan')
+        final_layer_thickness_m = float('nan')
+    else:
+        growth_ratio = newton_raphson(num_layers, delta99, yh_m)
+        final_layer_thickness_m = yh_m * growth_ratio**(num_layers - 1)
+        if growth_ratio > 1.3:
+            warnings.warn(
+                "Computed growth ratio (%.3f) exceeds the commonly recommended maximum of "
+                "~1.3 for boundary layer mesh quality. Consider increasing num_layers or "
+                "revisiting target_yplus." % growth_ratio,
+                UserWarning,
+            )
+
+    result = {
+        'fluid' : fluid,
+        'temperature [C]' : temperature_c,
+        'pressure [bar]' : pressure_bar,
+        'massflow [kg/sec]' : massflow_kgpersec,
+        'hydraulicdia [mm]' : hydraulicdia_mm,
+        'target yplus' : target_yplus,
+        'number of layers' : num_layers,
+        'flow type' : flow_type,
+        'roughness [mm]' : roughness_mm,
+        'dynvisc [N-sec/m^2]' : dynvisc_nsm2,
+        'thermal conductivity [W/m-k]' : thermal_conductivity_wpermk,
+        'specific heat [cp] [J/kg-k]' : specific_heat_cp_jperkgk,
+        'density [kg/m^3]' : density_kgperm3,
+        'kinematic viscosity [m^2/s]' : kinevisc_m2s,
+        'flow velocity [m/sec]' : flowvelocity_mpersec,
+        'reynolds number' : reynolds,
+        'prandtl number' : prandtl,
+        'skin friction coefficient [cf]' : cf,
+        'wall shear stress [tau_wall]' : tau_wall,
+        'boundary layer thickness [delta99] [m]' : delta99,
+        'height of cell centroid from wall [yp] [m]' : yp_m,
+        'first layer height [yh] [m]' : yh_m,
+        'Growth Ratio' : growth_ratio,
+        'Final Layer Thickness [m]' : final_layer_thickness_m
+    }
+
+    return result
+
+
+
+    

cfdpre-0.3.0/cfdpre.egg-info/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.1
+Name: cfdpre
+Version: 0.3.0
+Summary: CFD PreProcessing Library
+Author: Pushkar Sheth
+Author-email: siglyserdev@gmail.com
+Description-Content-Type: text/markdown
+Requires-Dist: numpy
+Requires-Dist: CoolProp
+
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/phsheth/cfdpre/refs/heads/main/cfdprelogo.png" width="300">
+</h1><br>
+
+
+What is CFDPre?
+----------------------
+
+CFDPre is an open-source collection of object-oriented software tools for
+calculating boundary layer mesh dimensions for Computational Fluid Dynamics simulations.
+Among other things, it can be used to:
+
+* Calculate First Layer Thickness, Growth Ratio and Final Layer Thickess
+
+
+Installation
+----------------------
+
+[![Install](https://img.shields.io/pypi/v/cfdpre?label=CFDPre)](
+https://pypi.org/project/cfdpre/) [![PyPI Downloads](https://img.shields.io/pypi/dm/cfdpre?label=PyPI%20Downloads)](
+https://pypistats.org/packages/cfdpre)
+
+In your command line, within Python environment:
+```pythom
+    pip install cfdpre
+```
+- The Python module can also be installed using pip on Windows, macOS, and Linux.
+
+
+Usage
+----------------------
+
+`yhgrcalc` supports two flow types:
+
+- **`flow_type='internal'`** (default) — fully-developed pipe/duct flow. `massflow_kgpersec`
+  and `hydraulicdia_mm` are used to derive velocity and Reynolds number. Skin friction uses
+  the laminar (`Re < 2300`, `16/Re`) or the **Haaland (1983)** explicit turbulent correlation,
+  valid across the full turbulent range for smooth and rough pipes (`roughness_mm`) — unlike
+  Blasius, which is only accurate below `Re ≈ 1e5`. The prism-stack thickness defaults to the
+  pipe radius, but you can set it explicitly with `bl_thickness_mm` or as a fraction of the
+  radius with `bl_thickness_fraction` (filling the entire radius with prisms is rarely what
+  you actually mesh).
+- **`flow_type='external'`** — flow over a flat plate / aerodynamic surface.
+  `hydraulicdia_mm` is interpreted as a characteristic length (e.g. chord length), and
+  `flow_velocity_mpersec` is **required** (the mass-flow/area velocity is meaningless for
+  external flow). Skin friction and boundary layer thickness use the laminar (Blasius) or
+  turbulent (Schlichting) flat-plate correlations; `bl_thickness_mm` can override the
+  correlation-based thickness.
+
+If the computed growth ratio exceeds ~1.3 (or the boundary layer is too thin to resolve
+with the requested `target_yplus`/`num_layers`), a `UserWarning` is raised so you can
+adjust your inputs.
+
+```python
+from cfdpre import yhgrcalc
+yhgrcalc('Air', 50, 10, 2.5, 125, 1, 8)
+```
+
+Output:
+```python
+{'fluid': 'Air',
+ 'temperature [C]': 50,
+ 'pressure [bar]': 10,
+ 'massflow [kg/sec]': 2.5,
+ 'hydraulicdia [mm]': 125,
+ 'target yplus': 1,
+ 'number of layers': 8,
+ 'flow type': 'internal',
+ 'roughness [mm]': 0.0,
+ 'dynvisc [N-sec/m^2]': 1.9762497305390764e-05,
+ 'thermal conductivity [W/m-k]': 0.028357331300649127,
+ 'specific heat [cp] [J/kg-k]': 1019.3146170790077,
+ 'density [kg/m^3]': 10.792698589669245,
+ 'kinematic viscosity [m^2/s]': 1.8310987878701066e-06,
+ 'flow velocity [m/sec]': 18.875569021507275,
+ 'reynolds number': 1288541.1444310248,
+ 'prandtl number': 0.7103701741111368,
+ 'skin friction coefficient [cf]': 0.002776948990231969,
+ 'wall shear stress [tau_wall]': 5.339100066909961,
+ 'boundary layer thickness [delta99] [m]': 0.0625,
+ 'height of cell centroid from wall [yp] [m]': 2.6034112015544278e-06,
+ 'first layer height [yh] [m]': 5.2068224031088555e-06,
+ 'Growth Ratio': 3.6553638704281375,
+ 'Final Layer Thickness [m]': 0.04540326342524223}
+```
+
+> Note: with `target_yplus=1` and only 8 layers at this high Reynolds number (~1.29e6),
+> the growth ratio comes out to ~3.66, well above the recommended ~1.3 maximum — this
+> example raises a `UserWarning` accordingly. In practice you'd either use far more layers
+> (20-40+) or restrict the prism stack to part of the radius. For example, spanning only
+> 30% of the radius:
+>
+> ```python
+> yhgrcalc('Air', 50, 10, 2.5, 125, 1, 8, bl_thickness_fraction=0.3)  # GR ~3.04
+> ```
+
+External flow example (`flow_velocity_mpersec` is required):
+```python
+yhgrcalc('Air', 25, 1.01325, 2.5, 1000, 1, 15, flow_type='external', flow_velocity_mpersec=30)
+```
+
+Documentation
+----------------------
+
+In progress - not yet made!
+
+- **Project Home Page:** https://cfdpre.github.io/ [under construction]
+- **Users Group:** https://groups.google.com/g/cfdpre
+- **Source code:** https://github.com/phsheth/cfdpre
+- **PyPI Page:** https://pypi.org/project/cfdpre/
+
+
+
+Call for Contributors
+----------------------
+
+The CFDPre project welcomes your expertise and enthusiasm! Better to discuss on the users group before starting to contribute!
+
+
+Project Log
+----------------------
+January 2025:
+1. Created Library
+
+June 2026:
+1. Added `flow_type` ('internal'/'external') support. Internal flow uses laminar `16/Re`
+   and the Haaland (1983) turbulent correlation (valid to high Re, smooth/rough via
+   `roughness_mm`); external flow uses Blasius/Schlichting flat-plate correlations and now
+   requires `flow_velocity_mpersec`. Prism-stack thickness is selectable via `bl_thickness_mm`
+   or `bl_thickness_fraction`. Added growth-ratio (>1.3) and boundary-layer sanity warnings.
+
+
+Project RoadMap:
+----------------------
+
+1. Documentation for existing functionality.
+2. Include example data within library.
+3. Object-oriented API refactor + input validation.
+4. Generate `snappyHexMeshDict`-ready `addLayersControls` snippets.
+5. Bundled examples, unit tests, CI, and docs site.
+6. Parametric/batch sweeps.
+
+
+
+
+
+

{cfdpre-0.2.4 → cfdpre-0.3.0}/setup.py

@@ -1,25 +1,25 @@
-# setup.py
-
-from setuptools import setup, find_packages
-
-with open("README.md", "r") as f:
-    description = f.read()
-
-
-setup(
-    name='cfdpre',
-    version='0.2.4',
-    description='CFD PreProcessing Library',
-    author='Pushkar Sheth',
-    author_email='siglyserdev@gmail.com',
-    packages=find_packages(),
-    install_requires=[
-        'numpy',
-        'CoolProp'
-
-        
-    ],
-
-    long_description=description,
-    long_description_content_type="text/markdown",
+# setup.py
+
+from setuptools import setup, find_packages
+
+with open("README.md", "r") as f:
+    description = f.read()
+
+
+setup(
+    name='cfdpre',
+    version='0.3.0',
+    description='CFD PreProcessing Library',
+    author='Pushkar Sheth',
+    author_email='siglyserdev@gmail.com',
+    packages=find_packages(),
+    install_requires=[
+        'numpy',
+        'CoolProp'
+
+        
+    ],
+
+    long_description=description,
+    long_description_content_type="text/markdown",
 )

cfdpre-0.2.4/PKG-INFO

@@ -1,107 +0,0 @@
-Metadata-Version: 2.1
-Name: cfdpre
-Version: 0.2.4
-Summary: CFD PreProcessing Library
-Author: Pushkar Sheth
-Author-email: siglyserdev@gmail.com
-Description-Content-Type: text/markdown
-Requires-Dist: numpy
-Requires-Dist: CoolProp
-
-<h1 align="center">
-<img src="https://raw.githubusercontent.com/phsheth/cfdpre/refs/heads/main/cfdprelogo.png" width="300">
-</h1><br>
-
-
-What is CFDPre?
-----------------------
-
-CFDPre is an open-source collection of object-oriented software tools for
-calculating boundary layer mesh dimensions for Computational Fluid Dynamics simulations.
-Among other things, it can be used to:
-
-* Calculate First Layer Thickness, Growth Ratio and Final Layer Thickess
-
-
-Installation
-----------------------
-
-[![Install](https://img.shields.io/pypi/v/cfdpre?label=CFDPre)](
-https://pypi.org/project/cfdpre/) [![PyPI Downloads](https://img.shields.io/pypi/dm/cfdpre?label=PyPI%20Downloads)](
-https://pypistats.org/packages/cfdpre)
-
-In your command line, within Python environment:
-```pythom
-    pip install cfdpre
-```
-- The Python module can also be installed using pip on Windows, macOS, and Linux.
-
-
-Usage
-----------------------
-
-```python
-from cfdpre import yhgrcalc
-yhgrcalc('Air', 50, 10, 2.5, 125, 1, 8)
-```
-
-Output:
-```python
-{'fluid': 'Air',
- 'temperature [C]': 50,
- 'pressure [bar]': 10,
- 'massflow [kg/sec]': 2.5,
- 'hydraulicdia [mm]': 125,
- 'target yplus': 1,
- 'number of layers': 8,
- 'dynvisc [N-sec/m^2]': 1.9762497305390764e-05,
- 'thermal conductivity [W/m-k]': 0.028357331300649127,
- 'specific heat [cp] [J/kg-k]': 1019.3146170790077,
- 'density [kg/m^3]': 10.792698589669245,
- 'kinematic viscosity [m^2/s]': 1.8310987878701066e-06,
- 'flow velocity [m/sec]': 18.875569021507275,
- 'reynolds number': 1288541.1444310248,
- 'prandtl number': 0.7103701741111368,
- 'skin friction coefficient [cf]': 0.003583573389858024,
- 'wall shear stress [tau_wall]': 6.889956204766108,
- 'height of cell centroid from wall [yp] [m]': 2.2917570116263883e-06,
- 'first layer height [yh] [m]': 4.583514023252777e-06,
- 'Growth Ratio': 2.3120331242085856,
- 'Final Layer Thickness [m]': 0.0016186648187374523}
-```
-
-Documentation
-----------------------
-
-In progress - not yet made!
-
-- **Project Home Page:** https://cfdpre.github.io/ [under construction]
-- **Users Group:** https://groups.google.com/g/cfdpre
-- **Source code:** https://github.com/phsheth/cfdpre
-- **PyPI Page:** https://pypi.org/project/cfdpre/
-
-
-
-Call for Contributors
-----------------------
-
-The CFDPre project welcomes your expertise and enthusiasm! Better to discuss on the users group before starting to contribute!
-
-
-Project Log
-----------------------
-January 2025:
-1. Created Library
-
-
-Project RoadMap:
-----------------------
-
-1. Documentation for existing functionality.
-2. Include example data within library.
-
-
-
-
-
-

cfdpre-0.2.4/README.md

@@ -1,97 +0,0 @@
-<h1 align="center">
-<img src="https://raw.githubusercontent.com/phsheth/cfdpre/refs/heads/main/cfdprelogo.png" width="300">
-</h1><br>
-
-
-What is CFDPre?
-----------------------
-
-CFDPre is an open-source collection of object-oriented software tools for
-calculating boundary layer mesh dimensions for Computational Fluid Dynamics simulations.
-Among other things, it can be used to:
-
-* Calculate First Layer Thickness, Growth Ratio and Final Layer Thickess
-
-
-Installation
-----------------------
-
-[![Install](https://img.shields.io/pypi/v/cfdpre?label=CFDPre)](
-https://pypi.org/project/cfdpre/) [![PyPI Downloads](https://img.shields.io/pypi/dm/cfdpre?label=PyPI%20Downloads)](
-https://pypistats.org/packages/cfdpre)
-
-In your command line, within Python environment:
-```pythom
-    pip install cfdpre
-```
-- The Python module can also be installed using pip on Windows, macOS, and Linux.
-
-
-Usage
-----------------------
-
-```python
-from cfdpre import yhgrcalc
-yhgrcalc('Air', 50, 10, 2.5, 125, 1, 8)
-```
-
-Output:
-```python
-{'fluid': 'Air',
- 'temperature [C]': 50,
- 'pressure [bar]': 10,
- 'massflow [kg/sec]': 2.5,
- 'hydraulicdia [mm]': 125,
- 'target yplus': 1,
- 'number of layers': 8,
- 'dynvisc [N-sec/m^2]': 1.9762497305390764e-05,
- 'thermal conductivity [W/m-k]': 0.028357331300649127,
- 'specific heat [cp] [J/kg-k]': 1019.3146170790077,
- 'density [kg/m^3]': 10.792698589669245,
- 'kinematic viscosity [m^2/s]': 1.8310987878701066e-06,
- 'flow velocity [m/sec]': 18.875569021507275,
- 'reynolds number': 1288541.1444310248,
- 'prandtl number': 0.7103701741111368,
- 'skin friction coefficient [cf]': 0.003583573389858024,
- 'wall shear stress [tau_wall]': 6.889956204766108,
- 'height of cell centroid from wall [yp] [m]': 2.2917570116263883e-06,
- 'first layer height [yh] [m]': 4.583514023252777e-06,
- 'Growth Ratio': 2.3120331242085856,
- 'Final Layer Thickness [m]': 0.0016186648187374523}
-```
-
-Documentation
-----------------------
-
-In progress - not yet made!
-
-- **Project Home Page:** https://cfdpre.github.io/ [under construction]
-- **Users Group:** https://groups.google.com/g/cfdpre
-- **Source code:** https://github.com/phsheth/cfdpre
-- **PyPI Page:** https://pypi.org/project/cfdpre/
-
-
-
-Call for Contributors
-----------------------
-
-The CFDPre project welcomes your expertise and enthusiasm! Better to discuss on the users group before starting to contribute!
-
-
-Project Log
-----------------------
-January 2025:
-1. Created Library
-
-
-Project RoadMap:
-----------------------
-
-1. Documentation for existing functionality.
-2. Include example data within library.
-
-
-
-
-
-

cfdpre-0.2.4/cfdpre/__init__.py

@@ -1,3 +0,0 @@
-# __init__.py
-
-from .main import yhgrcalc

cfdpre-0.2.4/cfdpre/main.py

@@ -1,111 +0,0 @@
-# main.py
-
-
-import numpy as np
-import CoolProp.CoolProp as CP
-
-
-
-def calculate_f(r, N, delta99, yH):
-
-    """Calculates the function f(r) for root finding."""
-
-    return r**N - r * (delta99 / yH) + (delta99 / yH - 1)
-
-
-
-def calculate_df_dr(r, N, delta99, yH):
-
-    """Calculates the derivative of f(r) with respect to r."""
-
-    return N * r**(N-1) - (delta99 / yH)
-
-
-
-def newton_raphson(N, delta99, yH, initial_guess=5, tolerance=1e-12, max_iterations=1000):
-
-    """Finds the growth ratio using the Newton-Raphson method."""
-
-    r = initial_guess
-
-    for _ in range(max_iterations):
-
-        f_r = calculate_f(r, N, delta99, yH)
-
-        df_dr = calculate_df_dr(r, N, delta99, yH)
-
-        r_new = r - f_r / df_dr
-       
-
-        if np.abs(r_new - r) < tolerance:
-
-            return r_new
-
-        r = r_new
-
-    return r
-
-
-
-
-def yhgrcalc(fluid, temperature_c, pressure_bar, massflow_kgpersec, hydraulicdia_mm, target_yplus, num_layers):
-    
-    pressure_pa = pressure_bar * 1e5
-    hydraulicdia_m = hydraulicdia_mm/1000
-    temperature_k = temperature_c + 273.15
-    
-    dynvisc_pas = CP.PropsSI('V', 'T', temperature_k, 'P', pressure_pa, fluid)
-    dynvisc_nsm2 = dynvisc_pas
-    
-    thermal_conductivity_wpermk = CP.PropsSI('L', 'T', temperature_k, 'P', pressure_pa, fluid)
-    specific_heat_cp_jperkgk = CP.PropsSI('C', 'T', temperature_k, 'P', pressure_pa, fluid)
-    density_kgperm3 =  CP.PropsSI('D', 'T', temperature_k, 'P', pressure_pa, fluid)
-    kinevisc_m2s = dynvisc_nsm2 / density_kgperm3
-    volflowrate_m3persec = massflow_kgpersec / density_kgperm3
-    flowvelocity_mpersec = volflowrate_m3persec / ((np.pi/4) * np.power(hydraulicdia_m, 2))
-    reynolds = flowvelocity_mpersec * hydraulicdia_m / kinevisc_m2s
-    prandtl = specific_heat_cp_jperkgk * dynvisc_nsm2 / thermal_conductivity_wpermk
-    cf = np.power(((2 * np.log10(reynolds)- 0.65)), (-2.3)) # skin friction coefficient
-    tau_wall = 0.5 * density_kgperm3 * np.square(flowvelocity_mpersec) * cf # wall shear stress
-    u_tau = np.sqrt(tau_wall/density_kgperm3) #friction velocity
-    yp_m = (target_yplus * dynvisc_nsm2)  /(u_tau * density_kgperm3)
-    yh_m = yp_m * 2   
-
-    if reynolds < 5e5:
-        delta99 = 4.91 * hydraulicdia_m / np.sqrt(reynolds)
-    else:
-        delta99 = 0.38 * hydraulicdia_m * reynolds**(-1/5)
-
-    growth_ratio = newton_raphson(num_layers, delta99, yh_m)
-    final_layer_thickness_m = yh_m * growth_ratio**(num_layers - 1)
-    
-
-    result = {
-        'fluid' : fluid,
-        'temperature [C]' : temperature_c,
-        'pressure [bar]' : pressure_bar,
-        'massflow [kg/sec]' : massflow_kgpersec,
-        'hydraulicdia [mm]' : hydraulicdia_mm,
-        'target yplus' : target_yplus,
-        'number of layers' : num_layers,
-        'dynvisc [N-sec/m^2]' : dynvisc_nsm2,
-        'thermal conductivity [W/m-k]' : thermal_conductivity_wpermk,
-        'specific heat [cp] [J/kg-k]' : specific_heat_cp_jperkgk,
-        'density [kg/m^3]' : density_kgperm3,
-        'kinematic viscosity [m^2/s]' : kinevisc_m2s,
-        'flow velocity [m/sec]' : flowvelocity_mpersec,
-        'reynolds number' : reynolds,
-        'prandtl number' : prandtl,
-        'skin friction coefficient [cf]' : cf,
-        'wall shear stress [tau_wall]' : tau_wall,
-        'height of cell centroid from wall [yp] [m]' : yp_m,
-        'first layer height [yh] [m]' : yh_m,
-        'Growth Ratio' : growth_ratio,
-        'Final Layer Thickness [m]' : final_layer_thickness_m
-    }
-    
-    return result
-
-
-
-    

cfdpre-0.2.4/cfdpre.egg-info/PKG-INFO

@@ -1,107 +0,0 @@
-Metadata-Version: 2.1
-Name: cfdpre
-Version: 0.2.4
-Summary: CFD PreProcessing Library
-Author: Pushkar Sheth
-Author-email: siglyserdev@gmail.com
-Description-Content-Type: text/markdown
-Requires-Dist: numpy
-Requires-Dist: CoolProp
-
-<h1 align="center">
-<img src="https://raw.githubusercontent.com/phsheth/cfdpre/refs/heads/main/cfdprelogo.png" width="300">
-</h1><br>
-
-
-What is CFDPre?
-----------------------
-
-CFDPre is an open-source collection of object-oriented software tools for
-calculating boundary layer mesh dimensions for Computational Fluid Dynamics simulations.
-Among other things, it can be used to:
-
-* Calculate First Layer Thickness, Growth Ratio and Final Layer Thickess
-
-
-Installation
-----------------------
-
-[![Install](https://img.shields.io/pypi/v/cfdpre?label=CFDPre)](
-https://pypi.org/project/cfdpre/) [![PyPI Downloads](https://img.shields.io/pypi/dm/cfdpre?label=PyPI%20Downloads)](
-https://pypistats.org/packages/cfdpre)
-
-In your command line, within Python environment:
-```pythom
-    pip install cfdpre
-```
-- The Python module can also be installed using pip on Windows, macOS, and Linux.
-
-
-Usage
-----------------------
-
-```python
-from cfdpre import yhgrcalc
-yhgrcalc('Air', 50, 10, 2.5, 125, 1, 8)
-```
-
-Output:
-```python
-{'fluid': 'Air',
- 'temperature [C]': 50,
- 'pressure [bar]': 10,
- 'massflow [kg/sec]': 2.5,
- 'hydraulicdia [mm]': 125,
- 'target yplus': 1,
- 'number of layers': 8,
- 'dynvisc [N-sec/m^2]': 1.9762497305390764e-05,
- 'thermal conductivity [W/m-k]': 0.028357331300649127,
- 'specific heat [cp] [J/kg-k]': 1019.3146170790077,
- 'density [kg/m^3]': 10.792698589669245,
- 'kinematic viscosity [m^2/s]': 1.8310987878701066e-06,
- 'flow velocity [m/sec]': 18.875569021507275,
- 'reynolds number': 1288541.1444310248,
- 'prandtl number': 0.7103701741111368,
- 'skin friction coefficient [cf]': 0.003583573389858024,
- 'wall shear stress [tau_wall]': 6.889956204766108,
- 'height of cell centroid from wall [yp] [m]': 2.2917570116263883e-06,
- 'first layer height [yh] [m]': 4.583514023252777e-06,
- 'Growth Ratio': 2.3120331242085856,
- 'Final Layer Thickness [m]': 0.0016186648187374523}
-```
-
-Documentation
-----------------------
-
-In progress - not yet made!
-
-- **Project Home Page:** https://cfdpre.github.io/ [under construction]
-- **Users Group:** https://groups.google.com/g/cfdpre
-- **Source code:** https://github.com/phsheth/cfdpre
-- **PyPI Page:** https://pypi.org/project/cfdpre/
-
-
-
-Call for Contributors
-----------------------
-
-The CFDPre project welcomes your expertise and enthusiasm! Better to discuss on the users group before starting to contribute!
-
-
-Project Log
-----------------------
-January 2025:
-1. Created Library
-
-
-Project RoadMap:
-----------------------
-
-1. Documentation for existing functionality.
-2. Include example data within library.
-
-
-
-
-
-