-
Notifications
You must be signed in to change notification settings - Fork 0
Learning Openfoam Case Review
github-actions[bot] edited this page Jun 23, 2026
·
4 revisions
Beginner to expert.
CFD engineers, CAE reviewers, and developers working with folder-based simulation artefacts.
By the end, you can:
- inspect an OpenFOAM-like case folder;
- identify solver dictionaries, boundary-condition files, material files, and numerical settings when detected;
- interpret inspection flags as review prompts; and
- state what a qualified engineer still needs to verify.
examples/openfoam_cavity_minimal- Architecture: Adapters
- Safe Use Policy
caereflex inspect-openfoam examples/openfoam_cavity_minimal --out openfoam_case.json
caereflex export agent-context openfoam_case.json --out openfoam_agent_context.json
caereflex export markdown openfoam_case.json --out openfoam_report.mdReview the outputs:
python -m json.tool openfoam_agent_context.json | head -80
sed -n '1,160p' openfoam_report.md- CaeReflex reads OpenFOAM-like text files; it does not run OpenFOAM.
- Dictionary and boundary-condition evidence can help structure review.
- Missing or partial evidence should be carried into the final summary.
A representative openfoam_agent_context.json from examples/openfoam_cavity_minimal should show the inspected dictionaries and initial fields:
{
"case_name": "openfoam_cavity_minimal",
"case_type": "openfoam",
"source_files": [
{"relative_path": "system/controlDict", "hash_status": "complete"},
{"relative_path": "system/fvSchemes", "hash_status": "complete"},
{"relative_path": "constant/polyMesh/boundary", "hash_status": "complete"},
{"relative_path": "0/U", "hash_status": "complete"}
],
"result_fields": [
{"name": "p", "association": "volume", "trace": {"source_files": ["0/p"]}},
{"name": "U", "association": "volume", "trace": {"source_files": ["0/U"]}}
],
"inspection_warnings": []
}Interpret the output as follows:
- Extracted evidence: dictionary paths, boundary-file paths, initial field names, hashes, and trace source files are read from
examples/openfoam_cavity_minimal. - Inferred context: the OpenFOAM classification and summary are based on folder structure and recognized file names; CaeReflex has not run a solver.
- Warnings: preserve every
inspection_warningsitem if present. No warnings in this tiny fixture does not imply numerical readiness or case quality. - Provenance: the full JSON includes
openfoam_inspection_started; exported agent context may summarize provenance throughsource_references. - Unsafe claims to avoid: do not claim solver execution, convergence, Courant-number acceptability, mesh adequacy, turbulence-model suitability, physical correctness, certification, or design safety.
List three files from the case folder that CaeReflex inspected or referenced.
Write a review note with three sections: detected evidence, inspection limitations, and human follow-up checks.
Inspect how the OpenFOAM adapter handles bounded scanning and safe text inspection. Propose one additional inspection flag that would improve review quality while staying read-only.
- The learner distinguishes file inspection from solver execution.
- The learner explains at least one detected setting or source file.
- The learner lists follow-up checks without saying CaeReflex validated the simulation.
- Home
- Architecture
- Developer-Guide
- Learning
- Reference
- Releases
- User-Guide
Synced from /wiki/docs in the main CaeReflex repository.