pycphy 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

pycphy/foamCaseDeveloper/config/system/snappy_hex_mesh_config.py

@@ -0,0 +1,241 @@
+# snappy_hex_mesh_config.py
+
+# =============================================================================
+#           *** User Input for snappyHexMeshDict ***
+# =============================================================================
+#
+#   This file defines the mesh generation parameters for snappyHexMesh.
+#   snappyHexMesh is used for complex geometry meshing with automatic
+#   boundary layer generation and mesh refinement.
+#
+
+# `WRITE_SNAPPY_HEX_MESH_DICT`: Set to True to enable writing of the snappyHexMeshDict file.
+# If False, this component will be skipped.
+WRITE_SNAPPY_HEX_MESH_DICT = True
+
+# --- Step Control ---
+# Which steps of snappyHexMesh to run
+CASTELLATED_MESH = True  # Initial mesh generation and refinement
+SNAP = True            # Snap mesh to geometry surfaces
+ADD_LAYERS = False     # Add boundary layers (can be computationally expensive)
+
+# --- Geometry Definition ---
+# `GEOMETRY`: Dictionary containing all geometry files and analytical shapes.
+# Each entry maps a geometry name to its definition.
+# Supports both STL/OBJ files and analytical shapes (box, sphere, cylinder, etc.)
+GEOMETRY = {
+    # Surface mesh files (STL, OBJ, etc.)
+    "motorBike": {
+        "type": "triSurfaceMesh",
+        "file": "motorBike.obj"
+    },
+    
+    # Analytical shapes for refinement regions
+    "refinementBox": {
+        "type": "box",
+        "min": [-1.0, -0.7, 0.0],
+        "max": [8.0, 0.7, 2.5]
+    },
+    
+    # Example of cylinder for pipe flows
+    # "pipe": {
+    #     "type": "cylinder",
+    #     "point1": [0, 0, 0],
+    #     "point2": [0, 0, 1],
+    #     "radius": 0.1
+    # },
+    
+    # Example of sphere for bluff body flows
+    # "sphere": {
+    #     "type": "sphere",
+    #     "centre": [0, 0, 0],
+    #     "radius": 0.05
+    # }
+}
+
+# --- Castellated Mesh Controls ---
+# `CASTELLATED_MESH_CONTROLS`: Controls for the initial mesh generation phase.
+CASTELLATED_MESH_CONTROLS = {
+    # Refinement parameters
+    "maxLocalCells": 100000,      # Max cells per processor before balancing
+    "maxGlobalCells": 8000000,    # Total cell limit (approximate)
+    "minRefinementCells": 10,     # Stop if fewer cells selected for refinement
+    "maxLoadUnbalance": 0.10,     # Allow imbalance during refinement (0=perfect balance)
+    "nCellsBetweenLevels": 3,     # Buffer layers between refinement levels
+    
+    # Feature edge refinement (from .eMesh files)
+    "features": [
+        {
+            "file": "motorBike.eMesh",
+            "level": 7  # Refinement level for feature edges
+        }
+    ],
+    
+    # Surface-based refinement
+    "refinementSurfaces": {
+        "motorBike": {
+            "level": (7, 7),  # (minLevel, maxLevel) for surface refinement
+            "patchInfo": {
+                "type": "wall",
+                "inGroups": ["motorBikeGroup"]
+            }
+        }
+    },
+    
+    # Sharp angle resolution
+    "resolveFeatureAngle": 30,  # Degrees - resolve angles sharper than this
+    
+    # Region-wise refinement (distance-based, inside, or outside)
+    "refinementRegions": {
+        "refinementBox": {
+            "mode": "inside",
+            "levels": ((1e15, 4))  # (distance, level) pairs
+        }
+    },
+    
+    # Mesh selection point (must be inside the domain)
+    "locationInMesh": [3.0001, 3.0001, 0.43],
+    
+    # Zone face handling
+    "allowFreeStandingZoneFaces": True
+}
+
+# --- Snap Controls ---
+# `SNAP_CONTROLS`: Controls for the mesh snapping phase to geometry.
+SNAP_CONTROLS = {
+    # Patch smoothing iterations before surface correspondence
+    "nSmoothPatch": 3,
+    
+    # Relative distance for surface feature attraction
+    "tolerance": 2.0,
+    
+    # Mesh displacement relaxation iterations
+    "nSolveIter": 30,
+    
+    # Maximum snapping relaxation iterations
+    "nRelaxIter": 5,
+    
+    # Feature snapping iterations
+    "nFeatureSnapIter": 10,
+    
+    # Feature detection methods
+    "implicitFeatureSnap": False,    # Detect features by surface sampling
+    "explicitFeatureSnap": True,     # Use features from castellatedMeshControls
+    "multiRegionFeatureSnap": False  # Detect points on multiple surfaces
+}
+
+# --- Add Layers Controls ---
+# `ADD_LAYERS_CONTROLS`: Controls for boundary layer generation.
+ADD_LAYERS_CONTROLS = {
+    # Thickness parameters relative to cell size outside layer
+    "relativeSizes": True,
+    
+    # Layer definitions per patch (using regex patterns)
+    "layers": {
+        "(lowerWall|motorBike).*": {
+            "nSurfaceLayers": 1  # Number of boundary layers
+        }
+    },
+    
+    # Layer expansion ratio (thickness growth)
+    "expansionRatio": 1.0,
+    
+    # Final layer thickness (relative to cell size)
+    "finalLayerThickness": 0.3,
+    
+    # Minimum layer thickness
+    "minThickness": 0.1,
+    
+    # Connected face growth for convergence
+    "nGrow": 0,
+    
+    # Advanced settings
+    "featureAngle": 60,                    # Angle threshold for layer termination
+    "nRelaxIter": 5,                      # Relaxation iterations
+    "nSmoothSurfaceNormals": 1,           # Surface normal smoothing
+    "nSmoothNormals": 3,                  # Normal smoothing iterations
+    "nSmoothThickness": 10,               # Thickness smoothing iterations
+    "maxFaceThicknessRatio": 0.5,         # Max face thickness ratio
+    "maxThicknessToMedialRatio": 0.3,     # Max thickness to medial ratio
+    "minMedianAxisAngle": 90,             # Min median axis angle
+    "nBufferCellsNoExtrude": 0,           # Buffer cells without extrusion
+    "nLayerIter": 50,                     # Layer addition iterations
+    "nRelaxedIter": 20                    # Relaxed iterations
+}
+
+# --- Mesh Quality Controls ---
+# `MESH_QUALITY_CONTROLS`: Controls for mesh quality optimization.
+MESH_QUALITY_CONTROLS = {
+    # Orthogonality and skewness
+    "maxNonOrtho": 65,              # Maximum non-orthogonality
+    "maxBoundarySkewness": 20,      # Maximum boundary face skewness
+    "maxInternalSkewness": 4,       # Maximum internal face skewness
+    "maxConcave": 80,               # Maximum concavity
+    
+    # Volume and area constraints
+    "minFlatness": 0.5,             # Minimum face flatness
+    "minVol": 1e-13,                # Minimum cell volume
+    "minTetQuality": 1e-30,         # Minimum tetrahedron quality
+    "minArea": -1,                  # Minimum face area (-1 = no limit)
+    
+    # Twist and determinant
+    "minTwist": 0.02,               # Minimum face twist
+    "minDeterminant": 0.001,        # Minimum determinant
+    "minFaceWeight": 0.02,          # Minimum face weight
+    "minVolRatio": 0.01,            # Minimum volume ratio
+    "minTriangleTwist": -1,         # Minimum triangle twist
+    
+    # Smoothing parameters
+    "nSmoothScale": 4,              # Number of smoothing scale iterations
+    "errorReduction": 0.75,         # Error reduction factor
+    
+    # Relaxed quality criteria (for difficult meshes)
+    "relaxed": {
+        "maxNonOrtho": 75,
+        "maxBoundarySkewness": 30,
+        "maxInternalSkewness": 8,
+        "maxConcave": 85,
+        "minFlatness": 0.3,
+        "minVol": 1e-12,
+        "minTetQuality": 1e-25,
+        "minArea": -1,
+        "minTwist": 0.01,
+        "minDeterminant": 0.0001,
+        "minFaceWeight": 0.01,
+        "minVolRatio": 0.005,
+        "minTriangleTwist": -1
+    }
+}
+
+# --- Advanced Options ---
+# `MERGED_PATCHES`: List of patches to be merged.
+# Used for creating periodic boundaries or connecting patches
+MERGED_PATCHES = []
+
+# `WRITE_FLAGS`: Control what files are written during meshing.
+WRITE_FLAGS = {
+    "writeMesh": True,      # Write final mesh
+    "writeSets": True,      # Write cell/face sets
+    "writeZones": True      # Write cell/face zones
+}
+
+# --- Predefined Templates ---
+# `TEMPLATE`: Select a predefined snappyHexMesh template
+# Options: 'none', 'motorcycle', 'room', 'turbine', 'car', 'airfoil'
+TEMPLATE = "none"
+
+# `TEMPLATE_PARAMETERS`: Parameters for the selected template
+TEMPLATE_PARAMETERS = {
+    "motorcycle": {
+        "geometry_file": "motorBike.obj",
+        "feature_file": "motorBike.eMesh",
+        "refinement_levels": (7, 7),
+        "boundary_layers": False
+    },
+    "room": {
+        "geometry_files": ["room.stl", "desk.stl", "door.stl"],
+        "refinement_levels": (2, 3),
+        "boundary_layers": False
+    }
+}
+

pycphy/foamCaseDeveloper/config/zero/U_config.py

@@ -0,0 +1,135 @@
+# U_config.py
+"""
+Configuration for velocity field (U) initialization.
+Based on OpenFOAM volVectorField format for velocity boundary conditions.
+"""
+
+# =============================================================================
+#           *** Configuration for velocity field (U) ***
+# =============================================================================
+
+# --- Master Control ---
+# Set to True to write '0/U' field file.
+WRITE_U_FIELD = True
+
+# --- Velocity Field Configuration ---
+# Internal field velocity vector (m/s) [Ux, Uy, Uz]
+INTERNAL_VELOCITY = (0.0, 0.0, 0.0)
+
+# --- Boundary Conditions ---
+# Boundary conditions are now read from patches.csv
+# Available boundary condition types:
+#   "fixedValue": Fixed velocity value
+#   "zeroGradient": Zero gradient (natural outflow)
+#   "inletOutlet": Inlet/outlet condition
+#   "noSlip": No-slip condition (for walls)
+#   "slip": Slip condition (for symmetry)
+#   "cyclic": Cyclic boundary condition
+#   "timeVaryingMappedFixedValue": Time-varying mapped value
+
+# Note: Boundary conditions are automatically loaded from patches.csv
+# The CSV file should have columns: RegionName, PatchName, PatchType, U, U-value
+
+# --- Advanced Configuration ---
+# Velocity dimensions [length time^-1]
+VELOCITY_DIMENSIONS = [0, 1, -1, 0, 0, 0, 0]
+
+# --- Flow Profile Configurations ---
+# Predefined velocity profiles for different inlet conditions
+FLOW_PROFILES = {
+    "uniform": {
+        "type": "fixedValue",
+        "value": (1.0, 0.0, 0.0),
+        "description": "Uniform velocity profile"
+    },
+    "parabolic": {
+        "type": "timeVaryingMappedFixedValue",
+        "description": "Parabolic velocity profile (requires profile data)"
+    },
+    "turbulent": {
+        "type": "fixedValue", 
+        "value": (1.0, 0.0, 0.0),
+        "description": "Turbulent inlet (requires turbulence fields)"
+    },
+    "zero": {
+        "type": "fixedValue",
+        "value": (0.0, 0.0, 0.0),
+        "description": "Zero velocity (resting fluid)"
+    }
+}
+
+# --- Template Configurations ---
+# Predefined configurations for common scenarios
+TEMPLATE_CONFIGS = {
+    "channel_flow": {
+        "internal_velocity": (0.0, 0.0, 0.0),
+        "boundary_conditions": {
+            "inlet": {"type": "fixedValue", "value": (1.0, 0.0, 0.0)},
+            "outlet": {"type": "inletOutlet", "inletValue": (0.0, 0.0, 0.0)},
+            "walls": {"type": "noSlip"}
+        }
+    },
+    "cavity_flow": {
+        "internal_velocity": (0.0, 0.0, 0.0),
+        "boundary_conditions": {
+            "movingWall": {"type": "fixedValue", "value": (1.0, 0.0, 0.0)},
+            "fixedWalls": {"type": "noSlip"}
+        }
+    },
+    "pipe_flow": {
+        "internal_velocity": (0.0, 0.0, 0.0),
+        "boundary_conditions": {
+            "inlet": {"type": "fixedValue", "value": (1.0, 0.0, 0.0)},
+            "outlet": {"type": "inletOutlet", "inletValue": (0.0, 0.0, 0.0)},
+            "wall": {"type": "noSlip"}
+        }
+    },
+    "backward_facing_step": {
+        "internal_velocity": (0.0, 0.0, 0.0),
+        "boundary_conditions": {
+            "inlet": {"type": "fixedValue", "value": (1.0, 0.0, 0.0)},
+            "outlet": {"type": "inletOutlet", "inletValue": (0.0, 0.0, 0.0)},
+            "step": {"type": "noSlip"},
+            "walls": {"type": "noSlip"}
+        }
+    },
+    "lid_driven_cavity": {
+        "internal_velocity": (0.0, 0.0, 0.0),
+        "boundary_conditions": {
+            "movingWall": {"type": "fixedValue", "value": (1.0, 0.0, 0.0)},
+            "fixedWalls": {"type": "noSlip"}
+        }
+    }
+}
+
+# Select template (set to None to use custom configuration above)
+SELECTED_TEMPLATE = None  # Options: None, "channel_flow", "cavity_flow", "pipe_flow", "backward_facing_step", "lid_driven_cavity"
+
+# --- Custom Field Configuration ---
+# Additional field properties
+FIELD_PROPERTIES = {
+    "include_initial_conditions": False,  # Include initial conditions file
+    "include_constraint_types": False,    # Include constraint types
+    "include_environment": False,         # Include environment settings
+    "use_regex_patches": False,          # Use regex for patch matching
+    "version": "v2510"                   # OpenFOAM version for header
+}
+
+# --- Turbulence Inlet Configuration ---
+# For cases with turbulence modeling
+TURBULENCE_INLET = {
+    "enabled": False,
+    "turbulence_intensity": 0.05,  # 5% turbulence intensity
+    "length_scale": 0.01,          # Turbulence length scale
+    "profile_type": "uniform"      # uniform, parabolic, turbulent
+}
+
+# --- Comments and Documentation ---
+FIELD_DESCRIPTION = "Velocity field initialization for CFD simulation"
+FIELD_NOTES = [
+    "Velocity is typically initialized to zero for most cases",
+    "Use fixedValue for specified velocity inlets",
+    "Use inletOutlet for natural outflow boundaries",
+    "Use noSlip for wall boundaries",
+    "Consider turbulence inlet conditions for RANS/LES simulations"
+]

pycphy/foamCaseDeveloper/config/zero/__init__.py

@@ -0,0 +1,22 @@
+# 0/__init__.py
+"""
+Zero directory configuration modules.
+
+This package contains configuration modules for OpenFOAM 0 directory field files:
+- p (pressure field)
+- U (velocity field)
+- f (force field)
+- lambda (scalar field)
+"""
+
+from . import p_config
+from . import U_config
+from . import f_config
+from . import lambda_config
+
+__all__ = [
+    'p_config',
+    'U_config',
+    'f_config',
+    'lambda_config'
+]

pycphy/foamCaseDeveloper/config/zero/f_config.py

@@ -0,0 +1,140 @@
+# f_config.py
+"""
+Configuration for force field (f) initialization.
+Based on OpenFOAM volVectorField format for body force boundary conditions.
+"""
+
+# =============================================================================
+#           *** Configuration for force field (f) ***
+# =============================================================================
+
+# --- Master Control ---
+# Set to True to write '0/f' field file.
+WRITE_F_FIELD = True
+
+# --- Force Field Configuration ---
+# Internal field force vector (N/kg or m/s²) [fx, fy, fz]
+INTERNAL_FORCE = (0.0, 0.0, 0.0)
+
+# --- Boundary Conditions ---
+# Boundary conditions are now read from patches.csv
+# Available boundary condition types:
+#   "fixedValue": Fixed force value
+#   "zeroGradient": Zero gradient (natural condition)
+#   "calculated": Calculated value
+#   "symmetry": Symmetry condition
+
+# Note: Boundary conditions are automatically loaded from patches.csv
+# The CSV file should have columns: RegionName, PatchName, PatchType, f, f-value
+
+# --- Advanced Configuration ---
+# Force dimensions [length time^-2] (acceleration units)
+FORCE_DIMENSIONS = [0, 1, -2, 0, 0, 0, 0]
+
+# --- Force Types ---
+# Predefined force configurations for different physics
+FORCE_TYPES = {
+    "none": {
+        "internal_force": (0.0, 0.0, 0.0),
+        "description": "No body forces"
+    },
+    "gravity": {
+        "internal_force": (0.0, 0.0, -9.81),
+        "description": "Gravitational force (downward)"
+    },
+    "buoyancy": {
+        "internal_force": (0.0, 0.0, 9.81),
+        "description": "Buoyancy force (upward)"
+    },
+    "centrifugal": {
+        "internal_force": (1.0, 0.0, 0.0),
+        "description": "Centrifugal force"
+    },
+    "coriolis": {
+        "internal_force": (0.0, 0.0, 0.0),
+        "description": "Coriolis force (requires rotation)"
+    },
+    "electromagnetic": {
+        "internal_force": (0.0, 0.0, 0.0),
+        "description": "Electromagnetic body force"
+    }
+}
+
+# --- Template Configurations ---
+# Predefined configurations for common scenarios
+TEMPLATE_CONFIGS = {
+    "natural_convection": {
+        "internal_force": (0.0, 0.0, -9.81),
+        "boundary_conditions": {
+            "walls": {"type": "zeroGradient"},
+            "inlet": {"type": "zeroGradient"},
+            "outlet": {"type": "zeroGradient"}
+        }
+    },
+    "forced_convection": {
+        "internal_force": (0.0, 0.0, 0.0),
+        "boundary_conditions": {
+            "walls": {"type": "zeroGradient"},
+            "inlet": {"type": "zeroGradient"},
+            "outlet": {"type": "zeroGradient"}
+        }
+    },
+    "rotating_frame": {
+        "internal_force": (1.0, 0.0, 0.0),
+        "boundary_conditions": {
+            "walls": {"type": "zeroGradient"},
+            "inlet": {"type": "zeroGradient"},
+            "outlet": {"type": "zeroGradient"}
+        }
+    },
+    "magnetohydrodynamics": {
+        "internal_force": (0.0, 0.0, 0.0),
+        "boundary_conditions": {
+            "walls": {"type": "zeroGradient"},
+            "inlet": {"type": "zeroGradient"},
+            "outlet": {"type": "zeroGradient"}
+        }
+    },
+    "free_surface": {
+        "internal_force": (0.0, 0.0, -9.81),
+        "boundary_conditions": {
+            "walls": {"type": "zeroGradient"},
+            "inlet": {"type": "zeroGradient"},
+            "outlet": {"type": "zeroGradient"},
+            "atmosphere": {"type": "zeroGradient"}
+        }
+    }
+}
+
+# Select template (set to None to use custom configuration above)
+SELECTED_TEMPLATE = None  # Options: None, "natural_convection", "forced_convection", "rotating_frame", "magnetohydrodynamics", "free_surface"
+
+# --- Custom Field Configuration ---
+# Additional field properties
+FIELD_PROPERTIES = {
+    "include_initial_conditions": False,  # Include initial conditions file
+    "include_constraint_types": False,    # Include constraint types
+    "include_environment": False,         # Include environment settings
+    "use_regex_patches": False,          # Use regex for patch matching
+    "version": "v2510"                   # OpenFOAM version for header
+}
+
+# --- Force Source Configuration ---
+# For spatially varying or time-dependent forces
+FORCE_SOURCES = {
+    "enabled": False,
+    "source_type": "uniform",  # uniform, linear, parabolic, custom
+    "custom_function": None,   # Custom force function
+    "region_based": False,     # Apply forces only to specific regions
+    "regions": []              # List of regions for region-based forces
+}
+
+# --- Comments and Documentation ---
+FIELD_DESCRIPTION = "Body force field initialization for CFD simulation"
+FIELD_NOTES = [
+    "Force field represents body forces per unit mass (acceleration units)",
+    "Common applications: gravity, buoyancy, centrifugal, electromagnetic forces",
+    "Zero gradient is typically used for all boundaries",
+    "Force field is often used with Boussinesq approximation for natural convection",
+    "Consider coordinate system when defining force directions"
+]