openfoam-skills

Generate, review, debug, and recover OpenFOAM case files for CFD workflows. Use when working with OpenFOAM dictionaries, case structure, turbulence fields, b...

Security Scan

The skill's files, templates, and runtime instructions are coherent with its stated purpose of authoring and debugging OpenFOAM cases and do not request unrelated credentials, installs, or external endpoints.

Purpose & Capability

Name/description match the included material: OpenFOAM playbooks, case templates, and a SLURM run scaffold. All required artifacts (field/dictionary guidance, fvSchemes/fvSolution templates, cluster run script) are directly relevant to generating, validating, and running OpenFOAM cases.

Instruction Scope

SKILL.md directs the agent to read included reference docs and use bundled templates; runtime commands referenced (blockMesh, checkMesh, decomposePar, reconstructPar, srun, solver binaries) are expected for OpenFOAM workflows. The instructions do not instruct reading unrelated host files, environment secrets, or posting data to external endpoints. One reference points to an external helper ('hpc-orchestration' and an external script path), which is a cross-skill integration note rather than an instruction to access unknown secrets.

Install Mechanism

This is instruction-only with no install spec and only one small shell template file. Nothing is downloaded or written by an installer. Lowest-risk installation footprint.

Credentials

The skill declares no required environment variables, no required binaries and no credentials. The SLURM script uses common scheduler environment variables (e.g., SLURM_NTASKS) which is appropriate for cluster runs. No unrelated secrets or config paths are requested.

Persistence & Privilege

always is false and disable-model-invocation is default false (normal). The skill does not request persistent presence or attempt to modify other skills or system-wide settings. It contains templates and docs only; no autonomous privilege escalation indicators.

Assessment

This skill appears to be a coherent OpenFOAM authoring and run-playbook bundle: it contains reference docs, minimal case templates, and a SLURM run scaffold. Before using it, confirm you have OpenFOAM and cluster tooling installed (blockMesh, checkMesh, solvers, and an MPI/SLURM environment) and review the provided templates (especially the SLURM script) to adapt resource counts and module loads to your site. Note the cluster playbook mentions an external 'hpc-orchestration' integration and a log-tracker script not included — if you expect automated staging/monitoring, obtain or verify those tools separately. Because the skill can be invoked by the agent, avoid allowing it to run commands on production systems without explicit human approval; run any suggested commands in a safe sandbox first. Overall, there are no requests for secrets or external endpoints and no obvious incoherence.

HPC OpenFOAM

Follow a progressive loading workflow.

Start

1. Read references/case-setup.md before creating or editing any OpenFOAM case.
2. Read references/solver-selection.md when selecting a solver family or pressure convention.
3. Read references/boundary-condition-playbook.md when mapping physical boundaries to field files.
4. Read references/turbulence-bc-recipes.md when selecting turbulence models, wall treatment, or near-wall fields.
5. Read references/turbulence-and-numerics.md when choosing schemes, algorithm controls, turbulence models, or decomposition.
6. Read references/case-recipes.md when assembling a canonical internal-flow, external-aero, or free-surface case.
7. Read references/function-object-recipes.md when instrumenting a case with forces, probes, or solver diagnostics.
8. Read references/validation-parallel-and-observability.md when validating, instrumenting, or post-processing a case.
9. Read references/cluster-execution-playbook.md when staging an OpenFOAM case for scheduler-backed cluster execution.
10. Read references/error-recovery.md when a log contains crashes, divergence, or bounded-field warnings.

Work sequence

1. Classify the case first: steady or transient, incompressible or compressible, single-phase or multiphase, laminar or turbulent.
2. Generate the minimum consistent file set across 0/, constant/, and system/. Do not edit one layer in isolation if it changes the required fields elsewhere.
3. Match solver family and fields:
   • simpleFoam: steady incompressible RANS; expect U, p, and turbulence fields if RAS.
   • pimpleFoam: transient incompressible; review timestep control and outer correctors.
   • interFoam: multiphase; control both maxCo and maxAlphaCo.
4. Validate mesh and numerics before a long run:
   • run blockMesh or the mesh generator
   • run checkMesh
   • refuse to keep orthogonal-only schemes on poor-quality meshes
5. Keep parallel settings aligned:
   • make numberOfSubdomains match the intended MPI rank count
   • prefer scotch for complex geometries unless the user requests a manual layout

Guardrails

• Do not invent dictionary keys, patch types, or solver names.
• Do not use turbulence fields that do not match the chosen model family.
• Do not keep aggressive second-order convection schemes during first-pass stabilization on a fragile case.
• Do not treat checkMesh warnings as optional if the log is already diverging.

Additional References

Load these on demand:

• references/mesh-and-blockmeshdict-manual.md for mesh generation, vertex ordering, and mesh-quality workflow
• references/heat-transfer-and-compressible-cases.md for thermophysical, buoyant, and compressible setups
• references/fvsolution-and-residual-control.md for algorithm loops, solver blocks, and case termination logic
• references/field-and-dictionary-matrix.md for solver-to-field and file-to-parameter matrices
• references/cluster-execution-playbook.md for decomposition, solver launch, reconstruction, and restart sequencing on clusters

Reusable Templates

Use assets/templates/ when a concrete case skeleton is needed, especially:

• simplefoam-minimal/ for a minimal steady incompressible case
• interfoam-minimal/ for a minimal two-phase transient case
• openfoam-parallel-slurm.sh for a minimal scheduled parallel run scaffold

Outputs

Produce a short case summary that states:

• solver and physics family
• required fields and dictionaries touched
• validation commands run or still needed
• stability risks and the next recovery step if the case is failing