Skip to content

docs(openfoam): SUPPORTED-INPUTS.md - what the pool runs and refuses, held to the rules - #22

Merged
dmitrat merged 1 commit into
mainfrom
docs/openfoam-supported-inputs
Sep 29, 2026
Merged

dmitrat merged 1 commit into
mainfrom
docs/openfoam-supported-inputs

Conversation

@dmitrat

@dmitrat dmitrat commented Sep 29, 2026

Copy link
Copy Markdown
Contributor

What

OpenFOAM/SUPPORTED-INPUTS.md - one page that says what the pool runs and what it refuses:

  • the build (OpenFOAM v2606, kit openfoam-v2606-3) and its platforms;
  • what a case may carry: paths, content rules (run-time code, includes outside the case, decomposed-only trees, libraries outside the kit), size limits;
  • the recipe: the allow-list with its parallel column, the built-in step restore0Dir -processor, the forbidden flags, the step limit;
  • the response kinds, the solver classes, what comes back, the two study forms (a case with tokens, a case set);
  • the trademark statement and the GPL note.

Both OpenFOAM READMEs link to it; WitSweep links to it from the case and the set stages.

Held to the code

FoamSupportedInputsDocumentTests (8 tests) hold the document's tables to FoamAllowList (utilities, parallel-capable utilities, built-in steps, forbidden flags), FoamRecipeRules.MAX_STEPS, FoamDecomposition.MAX_DEFAULT_RANKS, FoamCaseContentRules.MAX_SCANNED_BYTES, FoamResponseKind, FoamSolverClasses, and the document and both READMEs to the trademark statement word for word. A rule that changes without the page fails the build.

Documents and tests only: no package is republished.

🤖 Generated with Claude Code

…held to the rules

The build and its platforms, the case and the paths and constructs it
may not carry, the recipe with the allow-list, the built-in step and the
forbidden flags, the responses, the solver classes, what comes back, the
two study forms, the trademark statement and the GPL note. Guard tests
hold the document's tables to FoamAllowList, FoamRecipeRules,
FoamResponseKind, FoamSolverClasses and the controller's limits, and the
document and both READMEs to the trademark statement word for word; the
READMEs link to it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dmitrat
dmitrat merged commit 3bbc345 into main Sep 29, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant