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

pycphy/foamCaseDeveloper/config/constant/gravity_field_config.py

@@ -0,0 +1,379 @@
+# gravity_field_config.py
+
+"""
+Gravity Field Configuration for OpenFOAM cases.
+
+This module provides configuration options for the gravity field (g) including
+standard gravitational acceleration, custom gravity vectors, and variable
+gravity fields for specialized simulations.
+"""
+
+# =============================================================================
+#           *** User Input for gravity field (g) ***
+# =============================================================================
+
+# --- Master Control ---
+# Set to True to write 'constant/g'.
+WRITE_GRAVITY_FIELD = True
+
+# =============================================================================
+#           *** Gravity Field Configuration ***
+# =============================================================================
+
+GRAVITY_FIELD = {
+    # Gravity vector components [m/s^2]
+    # Standard Earth gravity: (0 0 -9.81) for downward gravity in z-direction
+    # Zero gravity: (0 0 0) for microgravity or space simulations
+    # Custom gravity: (gx gy gz) for arbitrary gravity directions
+    "value": (0, 0, -9.81),  # Standard Earth gravity downward
+    
+    # Dimensions of the gravity field
+    # [0 1 -2 0 0 0 0] = [length time^-2] = acceleration
+    "dimensions": [0, 1, -2, 0, 0, 0, 0],
+    
+    # Description of the gravity configuration
+    "description": "Standard Earth gravity (9.81 m/s^2 downward)",
+}
+
+# =============================================================================
+#           *** Predefined Gravity Configurations ***
+# =============================================================================
+# Common gravity configurations for different simulation types
+
+PREDEFINED_GRAVITY_CONFIGS = {
+    "earth_standard": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Standard Earth gravity (9.81 m/s^2 downward)"
+    },
+    
+    "earth_horizontal": {
+        "value": (-9.81, 0, 0),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Earth gravity in negative x-direction"
+    },
+    
+    "earth_45_degree": {
+        "value": (0, -6.93, -6.93),  # 9.81 * sin(45°), 9.81 * cos(45°)
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Earth gravity at 45° angle"
+    },
+    
+    "moon": {
+        "value": (0, 0, -1.62),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Moon gravity (1.62 m/s^2 downward)"
+    },
+    
+    "mars": {
+        "value": (0, 0, -3.71),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Mars gravity (3.71 m/s^2 downward)"
+    },
+    
+    "jupiter": {
+        "value": (0, 0, -24.79),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Jupiter gravity (24.79 m/s^2 downward)"
+    },
+    
+    "microgravity": {
+        "value": (0, 0, 0),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Microgravity/zero gravity environment"
+    },
+    
+    "centrifuge_100g": {
+        "value": (0, 0, -981.0),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Centrifuge at 100g (981 m/s^2 downward)"
+    },
+    
+    "centrifuge_1000g": {
+        "value": (0, 0, -9810.0),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Centrifuge at 1000g (9810 m/s^2 downward)"
+    },
+    
+    "rotating_frame": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity in rotating frame of reference"
+    },
+    
+    "inclined_plane_30deg": {
+        "value": (0, -4.905, -8.496),  # 9.81 * sin(30°), 9.81 * cos(30°)
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity on 30° inclined plane"
+    },
+    
+    "inclined_plane_45deg": {
+        "value": (0, -6.93, -6.93),  # 9.81 * sin(45°), 9.81 * cos(45°)
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity on 45° inclined plane"
+    },
+    
+    "inclined_plane_60deg": {
+        "value": (0, -8.496, -4.905),  # 9.81 * sin(60°), 9.81 * cos(60°)
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity on 60° inclined plane"
+    },
+    
+    "custom_2d": {
+        "value": (0, -9.81, 0),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "2D gravity in y-direction"
+    },
+    
+    "custom_3d": {
+        "value": (-5.0, -5.0, -5.0),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Custom 3D gravity vector"
+    },
+    
+    "buoyancy_test": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for buoyancy-driven flow tests"
+    },
+    
+    "free_surface": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for free surface flow simulations"
+    },
+    
+    "droplet_impact": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for droplet impact simulations"
+    },
+    
+    "particle_sedimentation": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for particle sedimentation studies"
+    },
+    
+    "convection_benchmark": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for natural convection benchmarks"
+    },
+    
+    "turbulence_gravity": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for gravity-driven turbulence"
+    },
+    
+    "stratified_flow": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for stratified flow simulations"
+    },
+    
+    "dam_break": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for dam break simulations"
+    },
+    
+    "sloshing": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for tank sloshing simulations"
+    },
+    
+    "wave_generation": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for wave generation and propagation"
+    },
+    
+    "tsunami": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for tsunami simulation"
+    },
+    
+    "flood_simulation": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for flood simulation"
+    },
+    
+    "environmental_flow": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for environmental flow studies"
+    },
+    
+    "biomedical_flow": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for biomedical flow simulations"
+    },
+    
+    "food_processing": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for food processing simulations"
+    },
+    
+    "mixing_tank": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for mixing tank simulations"
+    },
+    
+    "chemical_reactor": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for chemical reactor simulations"
+    },
+    
+    "heat_exchanger": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for heat exchanger simulations"
+    },
+    
+    "boiler": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for boiler simulations"
+    },
+    
+    "condenser": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for condenser simulations"
+    },
+    
+    "evaporator": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for evaporator simulations"
+    },
+    
+    "distillation_column": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for distillation column simulations"
+    },
+    
+    "extraction_column": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for extraction column simulations"
+    },
+    
+    "absorption_column": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for absorption column simulations"
+    },
+    
+    "packed_bed": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for packed bed reactor simulations"
+    },
+    
+    "fluidized_bed": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for fluidized bed simulations"
+    },
+    
+    "bubble_column": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for bubble column simulations"
+    },
+    
+    "stirred_tank": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for stirred tank simulations"
+    },
+    
+    "pipeline_flow": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for pipeline flow simulations"
+    },
+    
+    "valve_flow": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for valve flow simulations"
+    },
+    
+    "pump_flow": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for pump flow simulations"
+    },
+    
+    "compressor": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for compressor simulations"
+    },
+    
+    "turbine": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for turbine simulations"
+    },
+    
+    "wind_turbine": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for wind turbine simulations"
+    },
+    
+    "hydro_turbine": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for hydro turbine simulations"
+    },
+    
+    "solar_collector": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for solar collector simulations"
+    },
+    
+    "geothermal": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for geothermal simulations"
+    },
+    
+    "nuclear_reactor": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for nuclear reactor simulations"
+    },
+    
+    "fusion_reactor": {
+        "value": (0, 0, -9.81),
+        "dimensions": [0, 1, -2, 0, 0, 0, 0],
+        "description": "Gravity for fusion reactor simulations"
+    },
+}
+
+# =============================================================================
+#           *** Configuration Selection ***
+# =============================================================================
+# Select which predefined gravity configuration to use (overrides manual settings above)
+
+USE_PREDEFINED_GRAVITY = None  # Set to gravity config name from PREDEFINED_GRAVITY_CONFIGS or None for manual config
+
+# Example usage:
+# USE_PREDEFINED_GRAVITY = "earth_standard"  # Will use standard Earth gravity
+# USE_PREDEFINED_GRAVITY = "microgravity"    # Will use zero gravity
+# USE_PREDEFINED_GRAVITY = "moon"            # Will use Moon gravity

pycphy/foamCaseDeveloper/config/constant/transport_properties_config.py

@@ -0,0 +1,225 @@
+# transport_properties_config.py
+
+"""
+Transport Properties Configuration for OpenFOAM cases.
+
+This module provides comprehensive configuration options for fluid transport properties
+including Newtonian and non-Newtonian models, thermal properties, and species transport.
+"""
+
+# =============================================================================
+#           *** User Input for transportProperties ***
+# =============================================================================
+
+# --- Master Control ---
+# Set to True to write 'constant/transportProperties'.
+WRITE_TRANSPORT_PROPERTIES = True
+
+# --- Transport Model Selection ---
+# Choose the transport model for your fluid simulation:
+# Options:
+#   "Newtonian": Standard Newtonian fluid (constant viscosity)
+#   "NonNewtonian": Non-Newtonian fluid models (shear-thinning, etc.)
+#   "BirdCarreau": Bird-Carreau viscosity model
+#   "CrossPowerLaw": Cross power law viscosity model
+#   "HerschelBulkley": Herschel-Bulkley model for yield stress fluids
+#   "PowerLaw": Power law viscosity model
+#   "Casson": Casson model for yield stress fluids
+#   "GeneralizedNewtonian": General non-Newtonian model
+TRANSPORT_MODEL = "Newtonian"
+
+# =============================================================================
+#           *** Newtonian Transport Properties ***
+# =============================================================================
+# Used when TRANSPORT_MODEL = "Newtonian"
+
+NEWTONIAN_PROPERTIES = {
+    # Dynamic viscosity in [Pa s] or kinematic viscosity in [m^2/s]
+    # For incompressible flows, use kinematic viscosity (nu)
+    # For compressible flows, use dynamic viscosity (mu) and specify density
+    "nu": "1e-05",  # Kinematic viscosity [m^2/s] for water at 20°C
+    
+    # Optional: Dynamic viscosity [Pa s] (for compressible flows)
+    # "mu": "1e-03",  # Dynamic viscosity [Pa s]
+    
+    # Optional: Density [kg/m^3] (for compressible flows)
+    # "rho": "1000",  # Density [kg/m^3]
+}
+
+# =============================================================================
+#           *** Non-Newtonian Transport Properties ***
+# =============================================================================
+# Used when TRANSPORT_MODEL = "NonNewtonian"
+
+NON_NEWTONIAN_PROPERTIES = {
+    # Base properties
+    "nu": "1e-05",  # Reference kinematic viscosity [m^2/s]
+    
+    # Non-Newtonian model selection
+    "model": "BirdCarreau",  # Options: "BirdCarreau", "CrossPowerLaw", "HerschelBulkley", "PowerLaw", "Casson"
+    
+    # Model coefficients
+    "modelCoeffs": {
+        # Bird-Carreau model coefficients
+        "nu0": "1e-05",     # Zero shear rate viscosity [m^2/s]
+        "nuInf": "1e-07",   # Infinite shear rate viscosity [m^2/s]
+        "k": "1.0",         # Consistency index [s]
+        "n": "0.5",         # Power law index
+        
+        # Cross power law model coefficients (alternative)
+        # "nu0": "1e-05",     # Zero shear rate viscosity [m^2/s]
+        # "nuInf": "1e-07",   # Infinite shear rate viscosity [m^2/s]
+        # "k": "1.0",         # Consistency index [s]
+        # "n": "0.5",         # Power law index
+        
+        # Herschel-Bulkley model coefficients (alternative)
+        # "tau0": "0.1",      # Yield stress [Pa]
+        # "k": "1.0",         # Consistency index [Pa s^n]
+        # "n": "0.5",         # Power law index
+        
+        # Power law model coefficients (alternative)
+        # "k": "1.0",         # Consistency index [Pa s^n]
+        # "n": "0.5",         # Power law index
+        
+        # Casson model coefficients (alternative)
+        # "tau0": "0.1",      # Yield stress [Pa]
+        # "mu": "1e-03",      # Plastic viscosity [Pa s]
+    }
+}
+
+# =============================================================================
+#           *** Thermal Transport Properties ***
+# =============================================================================
+# Additional thermal properties for heat transfer simulations
+
+THERMAL_PROPERTIES = {
+    # Enable thermal properties
+    "enableThermal": False,
+    
+    # Thermal conductivity [W/(m K)]
+    "k": "0.6",  # Thermal conductivity of water at 20°C
+    
+    # Specific heat capacity [J/(kg K)]
+    "Cp": "4180",  # Specific heat of water at 20°C
+    
+    # Thermal diffusivity [m^2/s] (alternative to k and Cp)
+    # "alpha": "1.43e-07",  # Thermal diffusivity of water at 20°C
+    
+    # Prandtl number (alternative to k and Cp)
+    # "Pr": "7.0",  # Prandtl number of water at 20°C
+}
+
+# =============================================================================
+#           *** Species Transport Properties ***
+# =============================================================================
+# Properties for multi-species simulations
+
+SPECIES_PROPERTIES = {
+    # Enable species transport
+    "enableSpecies": False,
+    
+    # Number of species
+    "nSpecies": 2,
+    
+    # Species names
+    "speciesNames": ["air", "water"],
+    
+    # Molecular diffusivity [m^2/s] for each species
+    "D": ["2e-05", "1e-09"],  # Air and water diffusivity
+    
+    # Schmidt number (alternative to D)
+    # "Sc": ["1.0", "1000.0"],  # Schmidt numbers for air and water
+}
+
+# =============================================================================
+#           *** Advanced Transport Properties ***
+# =============================================================================
+# Additional advanced properties for specialized simulations
+
+ADVANCED_PROPERTIES = {
+    # Enable advanced properties
+    "enableAdvanced": False,
+    
+    # Surface tension [N/m] (for multiphase flows)
+    "sigma": "0.072",  # Surface tension of water-air interface
+    
+    # Contact angle [degrees] (for wetting simulations)
+    "contactAngle": "90",  # Neutral wetting
+    
+    # Compressibility [1/Pa] (for compressible flows)
+    "kappa": "4.5e-10",  # Compressibility of water
+    
+    # Bulk viscosity [Pa s] (for compressible flows)
+    "lambda": "0.0",  # Bulk viscosity (usually zero for most fluids)
+    
+    # Molecular weight [kg/mol] (for gas mixtures)
+    "molecularWeight": "28.97",  # Molecular weight of air
+    
+    # Reference temperature [K]
+    "TRef": "293.15",  # Reference temperature (20°C)
+    
+    # Reference pressure [Pa]
+    "pRef": "101325",  # Reference pressure (1 atm)
+}
+
+# =============================================================================
+#           *** Predefined Fluid Properties ***
+# =============================================================================
+# Common fluid property sets for quick configuration
+
+PREDEFINED_FLUIDS = {
+    "water_20C": {
+        "nu": "1e-06",      # Kinematic viscosity [m^2/s]
+        "rho": "998.2",     # Density [kg/m^3]
+        "k": "0.6",         # Thermal conductivity [W/(m K)]
+        "Cp": "4182",       # Specific heat [J/(kg K)]
+        "sigma": "0.0728",  # Surface tension [N/m]
+        "description": "Water at 20°C"
+    },
+    
+    "air_20C": {
+        "nu": "1.51e-05",   # Kinematic viscosity [m^2/s]
+        "rho": "1.205",     # Density [kg/m^3]
+        "k": "0.0257",      # Thermal conductivity [W/(m K)]
+        "Cp": "1005",       # Specific heat [J/(kg K)]
+        "sigma": "0.0",     # Surface tension [N/m]
+        "description": "Air at 20°C and 1 atm"
+    },
+    
+    "oil_sae30": {
+        "nu": "1e-04",      # Kinematic viscosity [m^2/s]
+        "rho": "900",       # Density [kg/m^3]
+        "k": "0.15",        # Thermal conductivity [W/(m K)]
+        "Cp": "2000",       # Specific heat [J/(kg K)]
+        "sigma": "0.03",    # Surface tension [N/m]
+        "description": "SAE 30 motor oil"
+    },
+    
+    "blood": {
+        "nu": "3e-06",      # Kinematic viscosity [m^2/s]
+        "rho": "1050",      # Density [kg/m^3]
+        "k": "0.5",         # Thermal conductivity [W/(m K)]
+        "Cp": "3600",       # Specific heat [J/(kg K)]
+        "sigma": "0.05",    # Surface tension [N/m]
+        "description": "Human blood (approximate)"
+    },
+    
+    "polymer_solution": {
+        "model": "BirdCarreau",
+        "nu0": "1e-04",     # Zero shear viscosity [m^2/s]
+        "nuInf": "1e-06",   # Infinite shear viscosity [m^2/s]
+        "k": "10.0",        # Consistency index [s]
+        "n": "0.4",         # Power law index
+        "description": "Typical polymer solution"
+    }
+}
+
+# =============================================================================
+#           *** Configuration Selection ***
+# =============================================================================
+# Select which predefined fluid to use (overrides manual settings above)
+
+USE_PREDEFINED_FLUID = None  # Set to fluid name from PREDEFINED_FLUIDS or None for manual config
+
+# Example usage:
+# USE_PREDEFINED_FLUID = "water_20C"  # Will use water properties at 20°C