modify docu
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: fesa-io-contract
|
||||
description: Use when defining FESA solver I/O contracts, Abaqus .inp keyword subsets, internal model mapping, validation rules, and CSV schemas for solver outputs or reference comparison.
|
||||
description: Use when defining FESA solver I/O contracts, Abaqus .inp keyword subsets, internal model mapping, validation rules, HDF5 result schemas, and deterministic CSV view schemas for reference comparison.
|
||||
---
|
||||
|
||||
# FESA I/O Contract
|
||||
@@ -25,9 +25,10 @@ Read these first:
|
||||
3. Separate Model Data Mapping from History Data Mapping.
|
||||
4. Define supported keywords such as `*NODE`, `*ELEMENT`, `*MATERIAL`, `*ELASTIC`, `*BOUNDARY`, `*CLOAD`, `*STEP`, `*OUTPUT`, `*NODE OUTPUT`, and `*ELEMENT OUTPUT` only when required.
|
||||
5. Define Internal Model Contract at a semantic level without C++ APIs.
|
||||
6. Define Output and CSV Schemas for `displacements.csv`, `reactions.csv`, `element_forces.csv`, `stresses.csv`, and optional result files.
|
||||
7. Define units, coordinate system, component naming, output location, step/frame identity, and ID matching rules.
|
||||
8. Define validation rules and open issues.
|
||||
6. Define Output HDF5 Schema for authoritative solver output `results.h5`.
|
||||
7. Define Deterministic CSV View Schemas for `csv/displacements.csv`, `csv/reactions.csv`, `csv/element_forces.csv`, `csv/stresses.csv`, and optional view files.
|
||||
8. Define units, coordinate system, component naming, output location, step/frame identity, and ID matching rules.
|
||||
9. Define validation rules and open issues.
|
||||
|
||||
## Output Contract
|
||||
|
||||
@@ -38,7 +39,8 @@ Produce or revise `docs/io-definitions/<feature-id>-io.md` with:
|
||||
- Model Data Mapping
|
||||
- History Data Mapping
|
||||
- Internal Model Contract
|
||||
- Output and CSV Schemas
|
||||
- Output HDF5 Schema
|
||||
- Deterministic CSV View Schemas
|
||||
- Validation Rules
|
||||
- Downstream Handoff
|
||||
|
||||
@@ -48,16 +50,17 @@ Produce or revise `docs/io-definitions/<feature-id>-io.md` with:
|
||||
- Do not design C++ APIs.
|
||||
- Do not claim full Abaqus compatibility.
|
||||
- Do not run Abaqus, Nastran, or any reference solver.
|
||||
- Do not generate reference CSVs.
|
||||
- Do not generate reference HDF5 files or deterministic CSV views.
|
||||
- Do not approve release readiness.
|
||||
|
||||
## Quality Gate
|
||||
|
||||
- Every supported keyword has a documented purpose, required data, and unsupported-case behavior.
|
||||
- CSV schemas carry units, coordinate system, component naming, output location, and ID matching rules.
|
||||
- HDF5 schema is the authoritative solver output contract and must carry schema version, step/frame identity, units, coordinate system, output location, and component naming.
|
||||
- Deterministic CSV view schemas are comparison views derived from HDF5 datasets and must define stable row ordering, ID fields, and component ordering.
|
||||
- Unsupported Abaqus input is explicit: unsupported, ignored-with-warning, or requires user decision.
|
||||
- The I/O contract is compatible with requirements, formulation, and reference comparison needs.
|
||||
|
||||
## Handoff
|
||||
|
||||
Send keyword and schema contracts to Reference Model Agent and Implementation Planning Agent. Send comparison schema, ID matching, and tolerance-source constraints to Reference Verification Agent.
|
||||
Send keyword and schema contracts to Reference Model Agent and Implementation Planning Agent. Send HDF5 dataset paths, deterministic CSV view schemas, ID matching, and tolerance-source constraints to Reference Verification Agent.
|
||||
|
||||
Reference in New Issue
Block a user