How edocipriano/basilisk-sandbox-ecipriano works
Project type and purpose
• This is a scientific simulation library and sandbox built on top of the Basilisk CFD framework. It provides core modules for fluid dynamics (Navier–Stokes solvers, evaporation, two-phase flows), chemical kinetics (OpenSMOKE integration), and a collection of example “run” programs to study droplet combustion, boiling, and related phenomena.
File structure
• Top‐level directories:
• src – the core header-only library modules (flow solvers, physics kernels, property models)
• dev – parallel copy of src used for active development or experimental patches
• run & run_dev – collections of stand-alone C example programs + Makefiles + input/data files
• test – automated regression tests verifying individual modules
• doc – high-level documentation and tutorials
• Build scripts: Makefiles in src/, run/, run_dev/, dev/
• Data directories: example datasets under run/data and run_dev/data
README
• Confirms that this is a personal sandbox of Basilisk modules at http://basilisk.fr/sandbox/ecipriano/
a. Main components
• Core Library (src) – contains physics headers: navier-stokes, evaporation, multicomponent, thermodynamics, radiation, chemistry interfaces.
• Development Layer (dev) – experimental forks of the same modules for patch testing.
• Build System – Makefiles orchestrating compilation of src/dev into object code and linking of examples.
• Example Executables (run & run_dev) – C programs that #include library headers to set up specific simulation cases.
• Data Inputs – CSV or .exp files providing boundary conditions, initial profiles, or reference data.
• Test Suite (test) – small harness programs that include individual modules to verify correctness.
• Documentation (doc) – explanatory guides, but not part of runtime.
b. Relationships and interactions
1. The Build System reads Makefiles in src and dev → compiles headers into static or header-only library artifacts (object files or inline code).
2. Example programs in run/run_dev #include these modules → Link step produces executables.
3. Executables consume Data Inputs → produce simulation outputs.
4. Tests in test/ also #include core headers → compare results against stored .ref files.
5. Optional: dev/ modules can override or extend src/ modules by altering include paths in Makefiles.
c. Architectural patterns and design principles
– Modular, header-only design (no central monolithic binary).
– Plugin pattern for physics modules: include only the needed headers in each C program.
– Clear separation between library code, examples, and test harness.
– Reuse of common Makefile patterns for consistent builds.
d. Key technologies and libraries
– C99 (ANSI C) with heavy use of headers
– Basilisk framework conventions (wavelet adaptivity, VOF, GFM, low-Mach, etc.)
– GSL for nonlinear solves (fsolve-gsl)
– OpenSMOKE for gas-phase chemistry
– Standard Make + Unix toolchain