KOKO\Mimi
2.6 KiB
name, description
| name | description |
|---|---|
| fem-io-contract | Use when an approved structural FEM feature needs external syntax, validation, internal mapping, result schema, or comparison identity contracts. |
FEM I/O Contract
Turn approved requirements, mathematics, and logical verification quantities into deterministic interfaces without changing their meaning.
Inputs
- Requirements, formulation, numerical review, and reference-model contracts for one
feature_id - Project architecture and configured input, output, and comparison backends
- Official specifications for any approved compatibility subset
Workflow
- Define the supported external syntax and semantics, defaults, ordering, identifiers, units, coordinates, validation, diagnostics, and unsupported behavior.
- Map validated input to implementation-neutral model entities while preserving source identity.
- Define result schema versioning, analysis step/frame identity, quantities, components, locations, units, coordinates, precision, and deterministic ordering.
- Map logical verification quantities to result and reference identities. Specify missing, extra, duplicate, and nonfinite prechecks before tolerance evaluation.
- Add parser, schema, round-trip, migration, and comparison contract tests.
Use workflow and decision authority when a format choice changes public compatibility. Use evidence and handoff for return data.
Output
Follow Feature document management: read the Coordinator's feature context, keep main reports concise, and link necessary owned details in the same feature folder.
Create or revise docs/<feature-id>/io.md with input scope; grammar/semantic rules; validation matrix; internal mapping; output schema; comparison mapping; compatibility/versioning policy; test obligations; limitations; and handoff.
Evidence
Trace every public field and mapping to a requirement, formulation quantity, numerical-review identity, or authoritative selected-format specification. Include positive and negative examples only where they disambiguate behavior.
Boundary
Do not claim full compatibility from a subset, infer undocumented reference-product behavior, alter the formulation, redefine logical acceptance quantities, change tolerances, implement code, modify reference artifacts, or run an external solver. Input syntax, result containers, and tabular comparison formats are project-selected contracts, not mandatory solver identity.