How ganeshkumar-v/propellant-regression-framework works
Project Type and Purpose
• This is a domain-specific, open-source CFD framework built on OpenFOAM.
• Core application: “rocketMotor” simulates propellant regression and two-phase flows.
• Supplementary modules: libraries for boundary conditions, interfacial/turbulence models, functionObjects, and utilities for post-processing.
High-Level Components
• External Dependency:
• OpenFOAM v2112 (C++ toolchain, wmake)
• Build System:
• bashrc + Allwmake/Allwclean + per-module Makefiles under Make/ and platforms/
• Applications (applications/):
• rocketMotor – main solver executable
• (future) other custom apps
• Core Libraries (src/):
• PhaseSystems (multiphase reaction/combustion systems)
• interfacialModels (drag models, heat transfer models)
• multiphaseCompressibleTurbulenceModels
• phaseModel (single-phase/particle models)
• fvPatchFields (custom boundary conditions)
• functionObjects (thrust, vorticity, stream function)
• interfaceTrackingModels
• sharpInterfaceHeatTransferModels
• multiphaseSystem (overall solver orchestrator)
• Utilities (utilities/):
• postProcessRocket, mapVolFields, ReynoldsNumber, etc., for field manipulation and performance metrics
• Tutorials/Validation (tutorials/, future validation/):
• Case directories containing mesh (constant/polyMesh), fields (0/), solver settings (system/)
Relationships and Data Flow
• Build Phase:
OpenFOAM environment → wmake (via Allwmake) → compiles core libraries + applications + utilities
• Runtime Phase:
Case definition (tutorials/…: mesh, initial & boundary files, controlDict)
↓
rocketMotor (links to core libs: PhaseSystems, fvPatchFields, interfacialModels, etc.)
↓
Simulation outputs (field data in time directories)
↓
Utilities & functionObjects (calculateThrust, vorticityStreamFunction) → post-process results → performance metrics, visualization data
Architectural Patterns & Design Principles
• Plugin-like modularity: each model or boundary condition resides in its own folder with C/H files and Make options
• Separation of concerns:
• Core solver logic (multiphaseSystem, PhaseSystems)
• Physics models (interfacialModels, phaseModel, turbulenceModels)
• Boundary conditions (fvPatchFields)
• Post-processing (utilities, functionObjects)
• Build-time extensibility via per-module Makefiles, runtime extensibility via functionObject API
Essential Details to Capture
• Build dependencies: Makefiles → wmake → module compilation
• Runtime linkage: rocketMotor + core libraries + OpenFOAM libs
• Data I/O: case directory structure → solver → output directories
• Extensibility: where new code slots in (e.g., add new functionObject under src/functionObjects)