vortex-funnel-gen: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Language

• Reply in the language the user is currently using (Chinese -> Chinese, English -> English).
• Code, code comments, documentation files, and CLAUDE.md must always be written in English.

Project Purpose

Automated agentic optimization loop for designing an FDM 3D-printable fluid funnel (automotive windshield washer fluid). The system generates internal non-linear helical vane topologies that induce annular flow (stable central air core) to eliminate glugging during pouring. The optimization loop iterates: parametric geometry -> CFD simulation -> fitness evaluation -> next parameter set.

Architecture

The pipeline is a sequential three-stage loop orchestrated by optimization/loop.py:

optimization/loop.py  (controller — multi-fidelity Bayesian optimisation)
    |
    +--> geometry/funnel_generator.py   CadQuery: params (JSON) -> STEP + STL
    |
    +--> cfd/runner.py                  Docker OpenFOAM: copies base_case/,
    |       |                           injects STL, runs mesh -> solve,
    |       |                           extracts fitness via pyvista
    |       +-- cfd/base_case/          OpenFOAM template
    |             0/                    (alpha.water, U, p_rgh — uniform templates)
    |             constant/             (transportProperties, turbulenceProperties, g)
    |             system/               (controlDict, fvSchemes, fvSolution,
    |                                    blockMeshDict, snappyHexMeshDict,
    |                                    setFieldsDict, decomposeParDict)
    |
    +--> output/                        Converged STLs + visualization data
    +--> output/best_design/            Final optimised design (STL + STEP + CFD)
    +--> output/optimisation/           Per-iteration results + history.json

Fitness metric: R = 0.50 * norm(air_core_diameter) + 0.30 * norm(throat_velocity) + 0.20 * air_fraction_throat. Extracted at the funnel throat (z=30mm) from interFoam VOF results via pyvista.