pycphy 0.1.0__py3-none-any.whl

pycphy/__init__.py

@@ -0,0 +1,24 @@
+"""
+pycphy - Python: Computational Physics
+
+A Python package for computational physics simulations and tools.
+
+Author: Sanjeev Bashyal
+Location: https://github.com/SanjeevBashyal/pycphy
+"""
+
+__version__ = "0.1.0"
+__author__ = "Sanjeev Bashyal"
+__email__ = "sanjeev.bashyal@example.com"
+__url__ = "https://github.com/SanjeevBashyal/pycphy"
+
+# Import main modules for easy access
+from . import foamCaseDeveloper
+
+__all__ = [
+    "__version__",
+    "__author__", 
+    "__email__",
+    "__url__",
+    "foamCaseDeveloper",
+]

pycphy/foamCaseDeveloper/__init__.py

@@ -0,0 +1,41 @@
+"""
+foamCaseDeveloper - OpenFOAM Case Development Tools
+
+This module provides tools for creating and managing OpenFOAM simulation cases,
+including mesh generation, control dictionary setup, and turbulence properties
+configuration.
+
+Author: Sanjeev Bashyal
+"""
+
+from .core import (
+    BlockMeshDeveloper,
+    ControlDictWriter,
+    TurbulencePropertiesWriter,
+    FoamCaseManager
+)
+from .writers import (
+    BlockMeshWriter,
+    FoamWriter
+)
+from .config import (
+    global_config,
+    block_mesh_config,
+    control_config,
+    turbulence_config
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "BlockMeshDeveloper",
+    "ControlDictWriter", 
+    "TurbulencePropertiesWriter",
+    "FoamCaseManager",
+    "BlockMeshWriter",
+    "FoamWriter",
+    "global_config",
+    "block_mesh_config",
+    "control_config", 
+    "turbulence_config",
+]

pycphy/foamCaseDeveloper/config/__init__.py

@@ -0,0 +1,26 @@
+"""
+Configuration files for OpenFOAM case setup.
+
+This module provides configuration files for different aspects of
+OpenFOAM case setup, including geometry, control, and turbulence settings.
+Each config file contains detailed comments explaining all parameters.
+
+Usage:
+    from pycphy.foamCaseDeveloper.config import global_config
+    from pycphy.foamCaseDeveloper.config import block_mesh_config
+    from pycphy.foamCaseDeveloper.config import control_config
+    from pycphy.foamCaseDeveloper.config import turbulence_config
+"""
+
+# Import all config modules
+from . import global_config
+from . import block_mesh_config
+from . import control_config
+from . import turbulence_config
+
+__all__ = [
+    "global_config",
+    "block_mesh_config", 
+    "control_config",
+    "turbulence_config",
+]

pycphy/foamCaseDeveloper/config/block_mesh_config.py

@@ -0,0 +1,90 @@
+# block_mesh_config.py
+
+# =============================================================================
+#           *** User Input Configuration for blockMeshDict Generation ***
+# =============================================================================
+#
+#   Modify the values in this file to define the desired geometry,
+#   mesh resolution, and boundary patch names.
+#
+
+# --- 1. Geometry Definition ---
+
+# `p0`: The minimum corner of the computational domain (x_min, y_min, z_min).
+# This defines the bottom-left-front corner of the geometry.
+# Example: (0.0, 0.0, 0.0) for a domain starting at the origin
+p0 = (0.0, 0.0, 0.0)
+
+# `p1`: The maximum corner of the computational domain (x_max, y_max, z_max).
+# This defines the top-right-back corner of the geometry.
+# Example: (0.5, 0.2, 0.1) for a channel 0.5m long, 0.2m wide, 0.1m high
+p1 = (0.5, 0.2, 0.1)
+
+# --- 2. Meshing Parameters ---
+
+# `cells`: Number of cells in each direction (nx, ny, nz).
+# This determines the mesh resolution. Higher numbers = finer mesh = longer computation time.
+# Example: (50, 20, 50) means 50 cells in x-direction, 20 in y-direction, 50 in z-direction
+# Total cells = nx * ny * nz = 50 * 20 * 50 = 50,000 cells
+cells = (50, 20, 50)
+
+# `scale`: Scaling factor for the mesh coordinates.
+# Usually set to 1.0 for actual dimensions. Use other values to scale the entire geometry.
+# Example: 1.0 for meters, 0.001 for millimeters, 1000 for kilometers
+scale = 1.0
+
+# --- 3. Boundary Patch Names ---
+
+# `patch_names`: Dictionary mapping geometric faces to boundary patch names.
+# These names will be used in boundary condition files and OpenFOAM dictionaries.
+# 
+# Face identifiers:
+#   'minX': Face at minimum X (x = p0[0])
+#   'maxX': Face at maximum X (x = p1[0])
+#   'minY': Face at minimum Y (y = p0[1])
+#   'maxY': Face at maximum Y (y = p1[1])
+#   'minZ': Face at minimum Z (z = p0[2])
+#   'maxZ': Face at maximum Z (z = p1[2])
+#
+# Common patch types in OpenFOAM:
+#   - 'patch': General boundary patch
+#   - 'wall': Solid wall boundary
+#   - 'symmetryPlane': Symmetry boundary
+#   - 'empty': 2D simulation (front/back faces)
+#
+# Example for channel flow:
+patch_names = {
+    'minX': 'inlet',        # Inlet face (flow enters here)
+    'maxX': 'outlet',       # Outlet face (flow exits here)
+    'minY': 'frontWall',    # Front wall (solid boundary)
+    'maxY': 'backWall',     # Back wall (solid boundary)
+    'minZ': 'floor',        # Floor (solid boundary)
+    'maxZ': 'ceiling'       # Ceiling (solid boundary)
+}
+
+# --- 4. Advanced Meshing Options ---
+
+# `grading`: Cell size grading for each direction.
+# Controls how cell sizes change across the domain.
+# Example: (1, 1, 1) for uniform cells, (2, 1, 0.5) for graded cells
+# Note: These are used in the blockMeshDict but not currently exposed in the simple interface
+grading = (1, 1, 1)
+
+# `merge_patch_pairs`: List of patch pairs to merge (for periodic boundaries).
+# Example: [('leftWall', 'rightWall')] to create a periodic boundary
+# Currently not implemented in the simple interface
+merge_patch_pairs = []
+
+# --- 5. Validation Settings ---
+
+# `min_cell_size`: Minimum allowed cell size (for validation).
+# Used to prevent extremely small cells that could cause numerical issues.
+min_cell_size = 1e-6
+
+# `max_cell_size`: Maximum allowed cell size (for validation).
+# Used to prevent extremely large cells that could cause accuracy issues.
+max_cell_size = 1.0
+
+# `max_total_cells`: Maximum allowed total number of cells (for validation).
+# Used to prevent creating meshes that are too large for available computational resources.
+max_total_cells = 1000000

pycphy/foamCaseDeveloper/config/control_config.py

@@ -0,0 +1,168 @@
+# control_config.py
+
+# =============================================================================
+#           *** User Input for controlDict Parameters ***
+# =============================================================================
+#
+#   This file defines the simulation control settings that will be written
+#   to the controlDict file. Modify the values in the `control_params`
+#   dictionary below.
+#
+
+control_params = {
+    # --- Solver and Time Control ---
+
+    # `application`: The name of the OpenFOAM solver to be used.
+    # This determines which physics equations will be solved.
+    # Common Options:
+    #   'icoFoam': Incompressible, laminar flow solver
+    #   'simpleFoam': Steady-state, incompressible, turbulent flow solver
+    #   'pimpleFoam': Transient, incompressible, turbulent flow solver
+    #   'interFoam': Two-phase flow solver (VOF method)
+    #   'rhoSimpleFoam': Steady-state, compressible flow solver
+    #   'rhoPimpleFoam': Transient, compressible flow solver
+    #   'buoyantFoam': Natural convection solver
+    "application": "interFoam",
+
+    # `startFrom`: Controls how the simulation starts.
+    # This determines the initial time and data source for the simulation.
+    # Options:
+    #   'startTime': Starts from the time specified in 'startTime'. (Most common)
+    #   'firstTime': Starts from the earliest time-step directory found in the case.
+    #   'latestTime': Starts from the latest time-step directory. (For restarting)
+    "startFrom": "startTime",
+
+    # `startTime`: The simulation time to start from. Usually 0 for a new run.
+    # This is the initial time value for the simulation.
+    # Example: 0.0 for starting from t=0, 1.5 for restarting from t=1.5
+    "startTime": 0,
+
+    # `stopAt`: The condition that will end the simulation.
+    # This determines when the solver will stop running.
+    # Options:
+    #   'endTime': Stops when the simulation time reaches 'endTime'. (Most common)
+    #   'writeNow': Writes the current time step and then stops.
+    #   'noWriteNow': Stops immediately without writing.
+    #   'runTime': Stops after a specified wall-clock time (in seconds).
+    "stopAt": "endTime",
+
+    # `endTime`: The simulation time to stop at.
+    # This is the final time value for the simulation.
+    # Example: 1.0 for running until t=1.0 seconds
+    "endTime": 1.0,
+
+    # `deltaT`: The time step (Δt) for the simulation. This is a critical
+    # parameter for numerical stability and accuracy.
+    # Smaller values = more stable but slower computation.
+    # Larger values = faster but potentially unstable.
+    # Typical range: 1e-6 to 1e-2 depending on the problem
+    "deltaT": 0.001,
+
+    # --- Data Output (Write) Control ---
+
+    # `writeControl`: Determines how often results are written to disk.
+    # This controls the frequency of data output during the simulation.
+    # Options:
+    #   'adjustableRunTime': Writes at intervals of simulation time specified by
+    #                        'writeInterval', adjusting to match a multiple of deltaT. (Recommended)
+    #   'runTime': Writes at intervals of simulation time, may not align with deltaT.
+    #   'timeStep': Writes every N time steps, where N is 'writeInterval'.
+    #   'cpuTime': Writes at intervals of CPU time (wall-clock seconds).
+    "writeControl": "adjustableRunTime",
+
+    # `writeInterval`: The frequency of writing data. Its meaning depends on 'writeControl'.
+    # For 'adjustableRunTime' or 'runTime': seconds of simulation time
+    # For 'timeStep': integer number of steps
+    # For 'cpuTime': wall-clock seconds
+    # Example: 0.05 means write every 0.05 seconds of simulation time
+    "writeInterval": 0.05,
+
+    # `purgeWrite`: Cleans up old time-step directories to save disk space.
+    # This prevents the case directory from becoming too large.
+    # Options:
+    #   0: Keep all saved time steps (default, uses more disk space)
+    #   N > 0: Keep only the latest N time-step directories
+    # Example: 5 means keep only the latest 5 time directories
+    "purgeWrite": 0,
+
+    # `writeFormat`: The format for the output data files.
+    # This affects file size and read/write speed.
+    # Options:
+    #   'ascii': Human-readable text format. Good for debugging, larger file sizes.
+    #   'binary': Machine-readable binary format. Smaller files, faster I/O.
+    "writeFormat": "ascii",
+
+    # `writePrecision`: Number of significant figures for data in 'ascii' format.
+    # Higher precision = larger files but more accurate output.
+    # Typical range: 6-12 digits
+    "writePrecision": 6,
+
+    # `writeCompression`: Compresses the output files to save space.
+    # This reduces disk usage but may slow down I/O slightly.
+    # Options: 'on' (or 'compressed'), 'off' (or 'uncompressed')
+    "writeCompression": "off",
+
+    # `timeFormat`: The format used for the names of the time-step directories.
+    # This affects how time directories are named and sorted.
+    # Options: 'general', 'fixed', 'scientific'. 'general' is usually best.
+    "timeFormat": "general",
+
+    # `timePrecision`: Number of significant figures for the time-step directory names.
+    # This affects the precision of time directory names.
+    # Typical range: 6-12 digits
+    "timePrecision": 6,
+
+    # --- Run-Time Modification and Time-Step Adjustment ---
+
+    # `runTimeModifiable`: Allows dictionaries (like this one) to be re-read
+    # and updated while the simulation is running.
+    # This is very useful for adjusting parameters during long simulations.
+    # Options: 'yes' (or 'true'), 'no' (or 'false')
+    "runTimeModifiable": "yes",
+
+    # `adjustTimeStep`: Enables automatic time-step adjustment to meet criteria
+    # like the Courant number (`maxCo`).
+    # This is essential for many simulations to maintain stability.
+    # Options: 'on' (or 'yes'), 'off' (or 'no')
+    "adjustTimeStep": "on",
+
+    # `maxCo`: The maximum allowable Courant number. If 'adjustTimeStep' is on,
+    # the solver will reduce 'deltaT' to ensure the Courant number does not
+    # exceed this value. A value of < 1 is required for many solvers.
+    # Typical range: 0.1 to 1.0 (lower = more stable but slower)
+    "maxCo": 1,
+    
+    # `maxAlphaCo`: Similar to `maxCo`, but specifically for the interface-capturing
+    # part of multiphase solvers like 'interFoam'.
+    # This controls the stability of the volume fraction equation.
+    # Typical range: 0.1 to 1.0
+    "maxAlphaCo": 1,
+
+    # `maxDeltaT`: An absolute maximum limit for the time step, regardless of
+    # the Courant number. Prevents the time step from becoming excessively large.
+    # This is a safety measure to prevent numerical instability.
+    # Example: 1.0 means time step will never exceed 1.0 seconds
+    "maxDeltaT": 1,
+
+    # --- Additional Solver-Specific Parameters ---
+
+    # `nCorrectors`: Number of pressure correction iterations (for PIMPLE algorithm).
+    # Used by pimpleFoam and similar solvers.
+    # Typical range: 1-5 (higher = more accurate but slower)
+    "nCorrectors": 2,
+
+    # `nNonOrthogonalCorrectors`: Number of non-orthogonal correction iterations.
+    # Used to improve accuracy on non-orthogonal meshes.
+    # Typical range: 0-3 (higher = more accurate but slower)
+    "nNonOrthogonalCorrectors": 0,
+
+    # `pRefCell`: Reference pressure cell (for pressure field).
+    # Used to set the reference pressure in the pressure field.
+    # Example: 0 (uses cell 0 as reference)
+    "pRefCell": 0,
+
+    # `pRefValue`: Reference pressure value (for pressure field).
+    # The pressure value at the reference cell.
+    # Example: 0.0 (atmospheric pressure reference)
+    "pRefValue": 0.0
+}

pycphy/foamCaseDeveloper/config/global_config.py

@@ -0,0 +1,83 @@
+# global_config.py
+
+# =============================================================================
+#           *** Global Configuration for pycphy foamCaseDeveloper ***
+# =============================================================================
+#
+#   This file contains global settings and case information that applies
+#   to the entire OpenFOAM case setup process.
+#
+
+# --- Case Information ---
+
+# `case_name`: The name of the OpenFOAM case directory to be created.
+# This will be the main directory containing all case files.
+case_name = "channelFlow"
+
+# `case_description`: A brief description of the simulation case.
+# This is used for documentation and logging purposes.
+case_description = "Channel flow simulation with RAS turbulence model"
+
+# `author_name`: Name of the person creating this case.
+author_name = "Sanjeev Bashyal"
+
+# `author_email`: Email contact for the case author.
+author_email = "sanjeev.bashyal@example.com"
+
+# `creation_date`: Date when the case was created (automatically set).
+# Format: YYYY-MM-DD
+creation_date = "2025-01-09"
+
+# --- Output Configuration ---
+
+# `output_directory`: The base directory where the case will be created.
+# Use "." for current directory, or specify a full path.
+output_directory = "."
+
+# `overwrite_existing`: Whether to overwrite an existing case directory.
+# Options: True (overwrite), False (create with suffix if exists)
+overwrite_existing = True
+
+# `create_backup`: Whether to create a backup of existing case before overwriting.
+# Only applies when overwrite_existing = True
+create_backup = False
+
+# --- Logging and Verbosity ---
+
+# `verbose_output`: Enable detailed output during case creation.
+# Options: True (detailed), False (minimal)
+verbose_output = True
+
+# `log_to_file`: Whether to save case creation log to a file.
+log_to_file = True
+
+# `log_filename`: Name of the log file (if log_to_file = True).
+log_filename = "case_creation.log"
+
+# --- Validation Settings ---
+
+# `validate_geometry`: Enable geometry validation before mesh generation.
+# Checks for valid dimensions, positive cell counts, etc.
+validate_geometry = True
+
+# `validate_control`: Enable control parameter validation.
+# Checks for valid solver names, time parameters, etc.
+validate_control = True
+
+# `validate_turbulence`: Enable turbulence model validation.
+# Checks for valid model names and parameters.
+validate_turbulence = True
+
+# --- Advanced Options ---
+
+# `auto_create_directories`: Automatically create necessary directories.
+# Options: True (auto-create), False (fail if directories don't exist)
+auto_create_directories = True
+
+# `cleanup_on_failure`: Remove partially created case files if setup fails.
+# Options: True (cleanup), False (keep partial files for debugging)
+cleanup_on_failure = True
+
+# `parallel_processing`: Enable parallel processing for large cases.
+# Currently not implemented, reserved for future use.
+parallel_processing = False

pycphy/foamCaseDeveloper/config/turbulence_config.py

@@ -0,0 +1,187 @@
+# turbulence_config.py
+
+# =============================================================================
+#           *** User Input for turbulenceProperties ***
+# =============================================================================
+#
+#   This file defines the turbulence model settings.
+#   1. Set the SIMULATION_TYPE variable to 'RAS', 'LES', or 'laminar'.
+#   2. Edit the corresponding properties dictionary below if needed.
+#
+
+# `SIMULATION_TYPE`: The type of turbulence simulation to perform.
+# This determines which turbulence model will be used.
+# Options:
+#   'RAS': Reynolds-Averaged Simulation (steady or unsteady, computationally efficient)
+#   'LES': Large Eddy Simulation (unsteady, more detailed but computationally expensive)
+#   'laminar': Laminar flow (no turbulence model, for low Reynolds number flows)
+SIMULATION_TYPE = "RAS"
+
+# --- Reynolds-Averaged Simulation (RAS) Properties ---
+# RAS models solve the Reynolds-averaged Navier-Stokes equations and model
+# the effects of turbulence using statistical models. They are computationally
+# less expensive and are suitable for many steady-state industrial flows.
+
+RAS_PROPERTIES = {
+    # `RASModel`: Specifies the turbulence model to use.
+    # This determines how the Reynolds stresses are modeled.
+    # Common Options:
+    #   'kEpsilon': Standard k-epsilon model. Robust but less accurate for separated flows.
+    #                Good for free shear flows, mixing layers, and jets.
+    #   'realizableKE': A variation of k-epsilon with better performance for rotating flows.
+    #                   Improved handling of adverse pressure gradients.
+    #   'kOmegaSST': Menter's Shear Stress Transport model. Very popular, blends k-w
+    #                near walls and k-e in the far-field. Excellent for aerodynamics
+    #                and complex flows with separation.
+    #   'SpalartAllmaras': One-equation model. Good for aerospace applications.
+    #                      Particularly effective for attached flows.
+    "RASModel": "kOmegaSST",
+
+    # `turbulence`: A switch to turn the turbulence calculations on or off.
+    # This allows you to run laminar simulations with RAS setup.
+    # Options: 'on' (turbulence active), 'off' (laminar simulation)
+    "turbulence": "on",
+
+    # `printCoeffs`: Prints the model coefficients to the log file at the start.
+    # This is useful for debugging and verifying model settings.
+    # Options: 'on' (print coefficients), 'off' (don't print)
+    "printCoeffs": "on",
+
+    # Additional RAS model coefficients (advanced users only)
+    # These can be used to modify the default model coefficients if needed.
+    # Most users should not modify these unless they understand the model physics.
+    
+    # `kEpsilonCoeffs`: Coefficients for k-epsilon models (if using kEpsilon or realizableKE)
+    # "kEpsilonCoeffs": {
+    #     "Cmu": 0.09,          # Turbulent viscosity coefficient
+    #     "C1": 1.44,           # Production coefficient
+    #     "C2": 1.92,           # Destruction coefficient
+    #     "C3": -0.33,          # Buoyancy coefficient
+    #     "sigmap": 1.0,        # Prandtl number for pressure
+    #     "sigmak": 1.0,        # Prandtl number for k
+    #     "sigmaEps": 1.3       # Prandtl number for epsilon
+    # },
+
+    # `kOmegaSSTCoeffs`: Coefficients for k-omega SST model (if using kOmegaSST)
+    # "kOmegaSSTCoeffs": {
+    #     "beta1": 0.075,       # Beta coefficient for k equation
+    #     "beta2": 0.0828,      # Beta coefficient for omega equation
+    #     "betaStar": 0.09,     # Beta star coefficient
+    #     "gamma1": 0.5532,     # Gamma coefficient for k equation
+    #     "gamma2": 0.4403,     # Gamma coefficient for omega equation
+    #     "alphaK1": 0.85,      # Alpha coefficient for k equation
+    #     "alphaK2": 1.0,       # Alpha coefficient for k equation
+    #     "alphaOmega1": 0.5,   # Alpha coefficient for omega equation
+    #     "alphaOmega2": 0.856, # Alpha coefficient for omega equation
+    #     "Prt": 0.9            # Turbulent Prandtl number
+    # }
+}
+
+# --- Large Eddy Simulation (LES) Properties ---
+# LES resolves the large, energy-containing eddies directly and models the
+# smaller ones using sub-grid scale (SGS) models. It is more computationally
+# expensive than RAS but provides more detail on transient turbulent structures.
+
+LES_PROPERTIES = {
+    # `LESModel`: Specifies the sub-grid scale (SGS) model for LES.
+    # This determines how the unresolved small-scale turbulence is modeled.
+    # Common Options:
+    #   'Smagorinsky': The classic SGS model. Simple and robust but can be
+    #                  overly dissipative near walls.
+    #   'kEqn': One-equation eddy-viscosity model. Solves an equation for
+    #           sub-grid scale kinetic energy. More accurate than Smagorinsky.
+    #   'WALE': Wall-Adapting Local Eddy-viscosity model. Better near-wall
+    #           behavior than Smagorinsky.
+    #   'dynamicKEqn': Dynamic version of kEqn model. Coefficients are
+    #                  computed dynamically, more accurate but computationally expensive.
+    "LESModel": "kEqn",
+    
+    # `turbulence`: A switch to turn the turbulence calculations on or off.
+    # Options: 'on' (LES active), 'off' (laminar simulation)
+    "turbulence": "on",
+
+    # `printCoeffs`: Prints the model coefficients to the log file at the start.
+    # Options: 'on' (print coefficients), 'off' (don't print)
+    "printCoeffs": "on",
+
+    # `delta`: The model for the LES filter width.
+    # This determines how the characteristic length scale is calculated.
+    # Common Options:
+    #   'cubeRootVol': Based on the cell volume. (Most common and recommended)
+    #   'vanDriest': Wall-damping model. Reduces filter width near walls.
+    #   'smooth': Smoothing for the delta field. Helps with mesh sensitivity.
+    "delta": "smooth",
+
+    # Each delta model and some LES models have their own coefficient sub-dictionaries.
+    # The structure below is an example for the kEqn model with smooth delta.
+
+    # `cubeRootVolCoeffs`: Coefficients for cubeRootVol delta model
+    "cubeRootVolCoeffs": {
+        # `deltaCoeff`: Coefficient for the filter width calculation.
+        # Typical range: 0.5 to 2.0. Higher values = larger filter width.
+        "deltaCoeff": 1
+    },
+    
+    # `smoothCoeffs`: Coefficients for smooth delta model
+    "smoothCoeffs": {
+        # `delta`: The base delta model to use for smoothing.
+        "delta": "cubeRootVol",
+        
+        # `cubeRootVolCoeffs`: Coefficients for the base delta model
+        "cubeRootVolCoeffs": {
+            "deltaCoeff": 1
+        },
+        
+        # `maxDeltaRatio`: Maximum ratio between adjacent delta values.
+        # This prevents large jumps in filter width between cells.
+        # Typical range: 1.1 to 1.5
+        "maxDeltaRatio": 1.1
+    },
+
+    # Additional LES model coefficients (advanced users only)
+    # `kEqnCoeffs`: Coefficients for kEqn LES model (if using kEqn)
+    # "kEqnCoeffs": {
+    #     "Ck": 0.094,          # Model coefficient
+    #     "Ce": 1.048           # Dissipation coefficient
+    # },
+
+    # `SmagorinskyCoeffs`: Coefficients for Smagorinsky model (if using Smagorinsky)
+    # "SmagorinskyCoeffs": {
+    #     "Ck": 0.094           # Smagorinsky constant
+    # },
+
+    # `WALECoeffs`: Coefficients for WALE model (if using WALE)
+    # "WALECoeffs": {
+    #     "Cw": 0.325           # WALE constant
+    # }
+
+    # Add other coefficient dictionaries like 'vanDriestCoeffs' if your model needs them.
+}
+
+# --- Laminar Simulation Properties ---
+# For flows at low Reynolds numbers where turbulence is not present.
+# The dictionary is typically empty as no turbulence modeling is required.
+
+LAMINAR_PROPERTIES = {
+    # For laminar flows, no turbulence model coefficients are needed.
+    # This dictionary is kept for consistency but should remain empty.
+    # If you need to add any laminar-specific parameters in the future,
+    # they would go here.
+}
+
+# --- Additional Turbulence Settings ---
+
+# `turbulenceOn`: Global switch for turbulence calculations.
+# This can be used to quickly disable turbulence for testing.
+# Options: True (turbulence active), False (laminar simulation)
+turbulenceOn = True
+
+# `turbulenceCorrected`: Enable turbulence corrections for better accuracy.
+# This is useful for complex geometries and flow conditions.
+# Options: True (enable corrections), False (disable corrections)
+turbulenceCorrected = True
+
+# `turbulenceDebug`: Enable debug output for turbulence calculations.
+# This provides detailed information about turbulence model behavior.
+# Options: True (debug on), False (debug off)
+turbulenceDebug = False

pycphy/foamCaseDeveloper/core/__init__.py

@@ -0,0 +1,18 @@
+"""
+Core functionality for OpenFOAM case development.
+
+This module contains the main classes for managing OpenFOAM cases,
+including mesh generation, control setup, and case management.
+"""
+
+from .block_mesh_developer import BlockMeshDeveloper
+from .control_dict_writer import ControlDictWriter
+from .turbulence_properties_writer import TurbulencePropertiesWriter
+from .foam_case_manager import FoamCaseManager
+
+__all__ = [
+    "BlockMeshDeveloper",
+    "ControlDictWriter",
+    "TurbulencePropertiesWriter", 
+    "FoamCaseManager",
+]