docs: plan phase1 structure alignment refactor
This commit is contained in:
NINI
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"project": "FESA",
|
||||
"phase": "1-structure-alignment-refactor",
|
||||
"steps": [
|
||||
{ "step": 0, "name": "architecture-drift-audit", "status": "pending" },
|
||||
{ "step": 1, "name": "module-scaffold-and-facade", "status": "pending" },
|
||||
{ "step": 2, "name": "core-domain-dof-extraction", "status": "pending" },
|
||||
{ "step": 3, "name": "math-solver-extraction", "status": "pending" },
|
||||
{ "step": 4, "name": "io-parser-extraction", "status": "pending" },
|
||||
{ "step": 5, "name": "results-reference-extraction", "status": "pending" },
|
||||
{ "step": 6, "name": "mitc4-geometry-strain-extraction", "status": "pending" },
|
||||
{ "step": 7, "name": "mitc4-material-stiffness-extraction", "status": "pending" },
|
||||
{ "step": 8, "name": "assembly-analysis-extraction", "status": "pending" },
|
||||
{ "step": 9, "name": "architecture-evaluator-closeout", "status": "pending" }
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,64 @@
|
||||
# Sprint Contract: Architecture Drift Audit
|
||||
|
||||
## Objective
|
||||
Create a precise migration map from the current monolithic `include/fesa/fesa.hpp` implementation to the module ownership model documented in `docs/ARCHITECTURE.md`, without changing production solver behavior.
|
||||
|
||||
## Required Reading
|
||||
- /AGENTS.md
|
||||
- /PROGRESS.md
|
||||
- /PLAN.md
|
||||
- /docs/README.md
|
||||
- /docs/HARNESS_ENGINEERING.md
|
||||
- /docs/ARCHITECTURE.md
|
||||
- /docs/ADR.md
|
||||
- /docs/NUMERICAL_CONVENTIONS.md
|
||||
- /phases/1-linear-static-mitc4-rebaseline/step15-evaluator-report.md
|
||||
|
||||
## Scope
|
||||
- Audit current symbols, functions, classes, and tests that are concentrated in `include/fesa/fesa.hpp` and `tests/test_main.cpp`.
|
||||
- Assign every Phase 1 production symbol to one target module from `docs/ARCHITECTURE.md`: `Analysis`, `Assembly`, `Boundary`, `Core`, `Element`, `IO`, `Load`, `Math`, `Material`, `Property`, `Results`, or `Util`.
|
||||
- Produce a handoff artifact at `phases/1-structure-alignment-refactor/step0-architecture-map.md`.
|
||||
- Identify public API compatibility rules for keeping `include/fesa/fesa.hpp` as an umbrella facade during the refactor.
|
||||
|
||||
## Allowed Files
|
||||
- `phases/1-structure-alignment-refactor/step0-architecture-map.md`
|
||||
- `phases/1-structure-alignment-refactor/index.json`
|
||||
- `PLAN.md`
|
||||
- `PROGRESS.md`
|
||||
|
||||
## Explicit Non-Goals
|
||||
- Do not move C++ code in this step.
|
||||
- Do not change `CMakeLists.txt`.
|
||||
- Do not change parser support, MITC4 formulas, solver behavior, reference tolerances, or numerical conventions.
|
||||
- Do not create new architecture decisions unless the audit proves `docs/ARCHITECTURE.md` itself must change.
|
||||
|
||||
## Tests To Write First
|
||||
- None. This is an audit and handoff step.
|
||||
- Before writing the audit artifact, run `python scripts/validate_workspace.py` to capture the pre-refactor baseline.
|
||||
|
||||
## Reference Artifacts
|
||||
- `references/quad_02_phase1.inp`
|
||||
- `references/quad_02_displacements.csv`
|
||||
|
||||
These artifacts are baseline evidence only. Do not edit them.
|
||||
|
||||
## Acceptance Commands
|
||||
```bash
|
||||
python scripts/validate_workspace.py
|
||||
```
|
||||
|
||||
## Evaluator Checklist
|
||||
- The map assigns all major Phase 1 production areas from `fesa.hpp` to target modules.
|
||||
- The map calls out dependency direction and extraction order.
|
||||
- The map preserves `include/fesa/fesa.hpp` as an umbrella facade unless an ADR changes the public API.
|
||||
- The map explicitly records that this phase is behavior-preserving.
|
||||
- PLAN/PROGRESS reflect this architecture debt as active work.
|
||||
|
||||
## Handoff Requirements
|
||||
- Update this step status in `phases/1-structure-alignment-refactor/index.json`.
|
||||
- Record changed files, validation output, and any blockers in `PROGRESS.md`.
|
||||
- Keep the next refactor step in `PLAN.md`.
|
||||
|
||||
## Do Not
|
||||
- Do not treat this audit as approval to change formulas or parser scope.
|
||||
- Do not use this phase to close R-010 or R-013.
|
||||
@@ -0,0 +1,63 @@
|
||||
# Sprint Contract: Module Scaffold And Facade
|
||||
|
||||
## Objective
|
||||
Create the target module directory scaffold and public include facade policy so later steps can move code incrementally while preserving existing tests and user includes.
|
||||
|
||||
## Required Reading
|
||||
- /AGENTS.md
|
||||
- /PROGRESS.md
|
||||
- /PLAN.md
|
||||
- /docs/README.md
|
||||
- /docs/HARNESS_ENGINEERING.md
|
||||
- /docs/ARCHITECTURE.md
|
||||
- /docs/ADR.md
|
||||
- /phases/1-structure-alignment-refactor/step0-architecture-map.md
|
||||
|
||||
## Scope
|
||||
- Add the documented module directories under `include/fesa/` and `src/` as needed, including `Analysis`, `Assembly`, `Boundary`, `Core`, `Element`, `IO`, `Load`, `Math`, `Material`, `Property`, `Results`, and `Util`.
|
||||
- Update `CMakeLists.txt` so future `.cpp` files under the module directories are compiled by `fesa_core`.
|
||||
- Keep `include/fesa/fesa.hpp` as the stable umbrella header for current tests and clients.
|
||||
- Add minimal module header smoke coverage proving selected module headers and `fesa/fesa.hpp` can be included together.
|
||||
|
||||
## Allowed Files
|
||||
- `CMakeLists.txt`
|
||||
- `include/fesa/`
|
||||
- `src/`
|
||||
- `tests/`
|
||||
- `phases/1-structure-alignment-refactor/index.json`
|
||||
- `PLAN.md`
|
||||
- `PROGRESS.md`
|
||||
|
||||
## Explicit Non-Goals
|
||||
- Do not move large implementations yet.
|
||||
- Do not change class names, namespaces, DOF order, result labels, parser behavior, or solver outputs.
|
||||
- Do not add MKL, TBB, or HDF5 dependencies.
|
||||
- Do not replace the umbrella header with module-only includes.
|
||||
|
||||
## Tests To Write First
|
||||
- Add or update a compile/include smoke test that includes the new module headers and `fesa/fesa.hpp` together.
|
||||
- The test should fail before the scaffold exists and pass after the scaffold is added.
|
||||
|
||||
## Reference Artifacts
|
||||
- None.
|
||||
|
||||
## Acceptance Commands
|
||||
```bash
|
||||
python scripts/validate_workspace.py
|
||||
```
|
||||
|
||||
## Evaluator Checklist
|
||||
- Module directory names align with `docs/ARCHITECTURE.md`.
|
||||
- `fesa_core` builds with the scaffold on Windows/MSVC.
|
||||
- Existing tests still include `fesa/fesa.hpp` successfully.
|
||||
- New module headers do not expose external MKL, TBB, or HDF5 APIs.
|
||||
- No solver behavior changes are mixed into the scaffold.
|
||||
|
||||
## Handoff Requirements
|
||||
- Update this step status in `phases/1-structure-alignment-refactor/index.json`.
|
||||
- Record validation output and any CMake/source-list decisions in `PROGRESS.md`.
|
||||
- Leave detailed code movement to later steps.
|
||||
|
||||
## Do Not
|
||||
- Do not introduce broad formatting churn in `fesa.hpp`.
|
||||
- Do not change public API semantics while creating empty or thin module boundaries.
|
||||
@@ -0,0 +1,77 @@
|
||||
# Sprint Contract: Core Domain DOF Extraction
|
||||
|
||||
## Objective
|
||||
Move core types, diagnostics, domain data, validation, `AnalysisModel`, `DofManager`, and Phase 1 boundary/load/property model ownership out of the monolithic header into the documented `Core`, `Util`, `Boundary`, `Load`, and `Property` module boundaries.
|
||||
|
||||
## Required Reading
|
||||
- /AGENTS.md
|
||||
- /PROGRESS.md
|
||||
- /PLAN.md
|
||||
- /docs/README.md
|
||||
- /docs/HARNESS_ENGINEERING.md
|
||||
- /docs/ARCHITECTURE.md
|
||||
- /docs/ADR.md
|
||||
- /docs/NUMERICAL_CONVENTIONS.md
|
||||
- /phases/1-structure-alignment-refactor/step0-architecture-map.md
|
||||
- /phases/1-structure-alignment-refactor/step1.md
|
||||
|
||||
## Scope
|
||||
- Extract numeric aliases, diagnostics, DOF enum/mapping, domain entities, domain validation helpers, `AnalysisModel`, and `DofManager`.
|
||||
- Extract Phase 1 `BoundaryCondition`, `NodalLoad`, and `ShellSection` ownership into `Boundary`, `Load`, and `Property` module headers or implementation files while keeping `Domain` as the aggregate input model.
|
||||
- Keep `Node` and `Element` free of equation ids.
|
||||
- Keep `Domain` as input-model ownership and treat it as immutable after parsing.
|
||||
- Preserve existing symbol names and the `fesa` namespace unless a compiler-visible conflict requires a narrow adjustment.
|
||||
|
||||
## Allowed Files
|
||||
- `include/fesa/fesa.hpp`
|
||||
- `include/fesa/Core/`
|
||||
- `include/fesa/Util/`
|
||||
- `include/fesa/Boundary/`
|
||||
- `include/fesa/Load/`
|
||||
- `include/fesa/Property/`
|
||||
- `src/Core/`
|
||||
- `src/Util/`
|
||||
- `src/Boundary/`
|
||||
- `src/Load/`
|
||||
- `src/Property/`
|
||||
- `tests/`
|
||||
- `CMakeLists.txt`
|
||||
- `phases/1-structure-alignment-refactor/index.json`
|
||||
- `PLAN.md`
|
||||
- `PROGRESS.md`
|
||||
|
||||
## Explicit Non-Goals
|
||||
- Do not move parser, MITC4 element, assembly, analysis, solver, material-law, or result writer code in this step except for include dependency repair.
|
||||
- Do not change DOF order or Abaqus DOF mapping.
|
||||
- Do not change reaction recovery formulas.
|
||||
- Do not add runtime polymorphic interfaces that are not needed for this extraction.
|
||||
|
||||
## Tests To Write First
|
||||
- Add or update focused tests proving module includes expose `DofManager`, `Domain`, diagnostics, DOF mapping, Phase 1 boundary/load/property model types, and the umbrella header.
|
||||
- Preserve existing DofManager and domain validation behavioral tests as characterization tests.
|
||||
|
||||
## Reference Artifacts
|
||||
- None.
|
||||
|
||||
## Acceptance Commands
|
||||
```bash
|
||||
python scripts/validate_workspace.py
|
||||
```
|
||||
|
||||
## Evaluator Checklist
|
||||
- Core ownership matches `docs/ARCHITECTURE.md`.
|
||||
- Boundary, Load, and Property Phase 1 model types are no longer hidden only in `fesa.hpp`.
|
||||
- `DofManager` still owns constrained/free mapping, equation numbering, sparse connectivity inputs, and full-vector reconstruction.
|
||||
- Numeric aliases remain `double` and signed int64.
|
||||
- `Node` and `Element` do not store global equation ids.
|
||||
- Existing parser, analysis, and reference tests still pass.
|
||||
|
||||
## Handoff Requirements
|
||||
- Update this step status in `phases/1-structure-alignment-refactor/index.json`.
|
||||
- Record moved files and any remaining Core symbols still left in `fesa.hpp`.
|
||||
- Update `PLAN.md` if the extraction reveals a dependency cycle that requires a later contract change.
|
||||
|
||||
## Do Not
|
||||
- Do not weaken tests to accommodate include-order problems.
|
||||
- Do not let `Core` depend on `IO`, `Element`, `Assembly`, `Analysis`, or `Results`.
|
||||
- Do not create circular dependencies between `Core`, `Boundary`, `Load`, and `Property`.
|
||||
@@ -0,0 +1,66 @@
|
||||
# Sprint Contract: Math Solver Extraction
|
||||
|
||||
## Objective
|
||||
Move math primitives, dense test matrix support, sparse pattern data, and linear solver interfaces into `Math` while keeping future MKL integration behind an adapter boundary.
|
||||
|
||||
## Required Reading
|
||||
- /AGENTS.md
|
||||
- /PROGRESS.md
|
||||
- /PLAN.md
|
||||
- /docs/README.md
|
||||
- /docs/HARNESS_ENGINEERING.md
|
||||
- /docs/ARCHITECTURE.md
|
||||
- /docs/ADR.md
|
||||
- /docs/NUMERICAL_CONVENTIONS.md
|
||||
- /phases/1-structure-alignment-refactor/step0-architecture-map.md
|
||||
- /phases/1-structure-alignment-refactor/step2.md
|
||||
|
||||
## Scope
|
||||
- Extract vector/matrix helpers, `DenseMatrix`, sparse pattern structures, `SolveResult`, `LinearSolver`, and the deterministic test solver.
|
||||
- Keep the production-facing solver dependency expressed through `LinearSolver`.
|
||||
- Preserve int64 sparse index and equation-number boundaries.
|
||||
- Keep MKL/PARDISO as a future adapter, not a Phase 1 dependency.
|
||||
|
||||
## Allowed Files
|
||||
- `include/fesa/fesa.hpp`
|
||||
- `include/fesa/Math/`
|
||||
- `src/Math/`
|
||||
- `include/fesa/Core/`
|
||||
- `src/Core/`
|
||||
- `tests/`
|
||||
- `CMakeLists.txt`
|
||||
- `phases/1-structure-alignment-refactor/index.json`
|
||||
- `PLAN.md`
|
||||
- `PROGRESS.md`
|
||||
|
||||
## Explicit Non-Goals
|
||||
- Do not introduce MKL, TBB, HDF5, or production sparse storage.
|
||||
- Do not change Gaussian solver numerical behavior except for mechanical relocation.
|
||||
- Do not move MITC4, parser, results, assembly, or analysis logic except for include dependency repair.
|
||||
|
||||
## Tests To Write First
|
||||
- Add or update include/link tests for the `Math` module.
|
||||
- Preserve existing small linear algebra, sparse-pattern, solver-injection, and singular-solver diagnostic tests as characterization tests.
|
||||
|
||||
## Reference Artifacts
|
||||
- None.
|
||||
|
||||
## Acceptance Commands
|
||||
```bash
|
||||
python scripts/validate_workspace.py
|
||||
```
|
||||
|
||||
## Evaluator Checklist
|
||||
- `Math` does not depend on `IO`, `Results`, `Element`, `Assembly`, or `Analysis`.
|
||||
- `LinearSolver` remains an adapter boundary.
|
||||
- All ids, equation ids, nonzero counts, and sparse indices remain int64.
|
||||
- Solver failure diagnostics still propagate to analysis tests.
|
||||
- No external library API leaks into solver core.
|
||||
|
||||
## Handoff Requirements
|
||||
- Update this step status in `phases/1-structure-alignment-refactor/index.json`.
|
||||
- Record moved math/solver files and any remaining math symbols still left in `fesa.hpp`.
|
||||
|
||||
## Do Not
|
||||
- Do not optimize the solver while moving files.
|
||||
- Do not replace deterministic tests with tolerance changes.
|
||||
@@ -0,0 +1,72 @@
|
||||
# Sprint Contract: IO Parser Extraction
|
||||
|
||||
## Objective
|
||||
Move the Abaqus Phase 1 input parser into the `IO` module while preserving the documented strict parser subset and unsupported-feature diagnostics.
|
||||
|
||||
## Required Reading
|
||||
- /AGENTS.md
|
||||
- /PROGRESS.md
|
||||
- /PLAN.md
|
||||
- /docs/README.md
|
||||
- /docs/HARNESS_ENGINEERING.md
|
||||
- /docs/ARCHITECTURE.md
|
||||
- /docs/ADR.md
|
||||
- /docs/ABAQUS_INPUT_SUBSET.md
|
||||
- /docs/VERIFICATION_PLAN.md
|
||||
- /phases/1-structure-alignment-refactor/step0-architecture-map.md
|
||||
- /phases/1-structure-alignment-refactor/step2.md
|
||||
|
||||
## Scope
|
||||
- Extract `KeywordLine`, `ParseResult`, `AbaqusInputParser`, and parser-only helpers into `IO`.
|
||||
- Keep parser output in `Domain`.
|
||||
- Preserve strict rejection for `S4R`, `Part/Assembly/Instance`, `*Include`, `NLGEOM=YES`, nonzero prescribed displacement, and unsupported keyword parameters.
|
||||
- Keep normalized reference behavior for `references/quad_02_phase1.inp`.
|
||||
|
||||
## Allowed Files
|
||||
- `include/fesa/fesa.hpp`
|
||||
- `include/fesa/IO/`
|
||||
- `src/IO/`
|
||||
- `include/fesa/Core/`
|
||||
- `src/Core/`
|
||||
- `tests/`
|
||||
- `CMakeLists.txt`
|
||||
- `phases/1-structure-alignment-refactor/index.json`
|
||||
- `PLAN.md`
|
||||
- `PROGRESS.md`
|
||||
|
||||
## Explicit Non-Goals
|
||||
- Do not add new Abaqus keyword support.
|
||||
- Do not accept original `references/quad_02.inp` as a Phase 1 parser input.
|
||||
- Do not change `docs/ABAQUS_INPUT_SUBSET.md` unless a purely clarifying note is required.
|
||||
- Do not move results or reference comparator code in this step.
|
||||
|
||||
## Tests To Write First
|
||||
- Add or update an include/link test for `fesa/IO` parser headers.
|
||||
- Preserve parser acceptance and rejection tests as characterization tests.
|
||||
- Ensure original `quad_02.inp` unsupported provenance remains rejected where tested.
|
||||
|
||||
## Reference Artifacts
|
||||
- `references/quad_02.inp`
|
||||
- `references/quad_02_phase1.inp`
|
||||
|
||||
Do not edit these files.
|
||||
|
||||
## Acceptance Commands
|
||||
```bash
|
||||
python scripts/validate_workspace.py
|
||||
```
|
||||
|
||||
## Evaluator Checklist
|
||||
- Parser code lives in `IO` and does not own analysis or assembly behavior.
|
||||
- Parser subset discipline is unchanged.
|
||||
- Diagnostics still include enough source context for malformed input.
|
||||
- `Domain` remains the parser output boundary.
|
||||
- Stored reference compatibility notes remain true.
|
||||
|
||||
## Handoff Requirements
|
||||
- Update this step status in `phases/1-structure-alignment-refactor/index.json`.
|
||||
- Record moved parser files and any unsupported-feature behavior verified.
|
||||
|
||||
## Do Not
|
||||
- Do not normalize reference files inside parser code.
|
||||
- Do not silently broaden parser compatibility while refactoring.
|
||||
@@ -0,0 +1,72 @@
|
||||
# Sprint Contract: Results Reference Extraction
|
||||
|
||||
## Objective
|
||||
Move the in-memory result model, Phase 1 results writer, displacement CSV loader, and reference comparator into `Results` while preserving the documented step/frame/field schema.
|
||||
|
||||
## Required Reading
|
||||
- /AGENTS.md
|
||||
- /PROGRESS.md
|
||||
- /PLAN.md
|
||||
- /docs/README.md
|
||||
- /docs/HARNESS_ENGINEERING.md
|
||||
- /docs/ARCHITECTURE.md
|
||||
- /docs/ADR.md
|
||||
- /docs/RESULTS_SCHEMA.md
|
||||
- /docs/VERIFICATION_PLAN.md
|
||||
- /docs/NUMERICAL_CONVENTIONS.md
|
||||
- /phases/1-structure-alignment-refactor/step0-architecture-map.md
|
||||
- /phases/1-structure-alignment-refactor/step2.md
|
||||
|
||||
## Scope
|
||||
- Extract `FieldOutput`, `ResultFrame`, `ResultStep`, `ResultFile`, `InMemoryResultsWriter`, displacement CSV tables, comparison options, and comparison results.
|
||||
- Preserve mandatory Phase 1 `U` and `RF` field metadata.
|
||||
- Preserve CSV mapping from Abaqus `Node Label`, `U-U1`, `U-U2`, `U-U3`, `UR-UR1`, `UR-UR2`, `UR-UR3`.
|
||||
- Keep HDF5 as a future writer adapter; do not add the dependency yet.
|
||||
|
||||
## Allowed Files
|
||||
- `include/fesa/fesa.hpp`
|
||||
- `include/fesa/Results/`
|
||||
- `src/Results/`
|
||||
- `include/fesa/Core/`
|
||||
- `include/fesa/IO/`
|
||||
- `tests/`
|
||||
- `CMakeLists.txt`
|
||||
- `phases/1-structure-alignment-refactor/index.json`
|
||||
- `PLAN.md`
|
||||
- `PROGRESS.md`
|
||||
|
||||
## Explicit Non-Goals
|
||||
- Do not add HDF5 output implementation.
|
||||
- Do not change result labels, field positions, basis, or comparison tolerances.
|
||||
- Do not add reaction CSV parsing in this step.
|
||||
- Do not change analysis execution.
|
||||
|
||||
## Tests To Write First
|
||||
- Add or update include/link tests for `fesa/Results` headers.
|
||||
- Preserve existing result schema, CSV loader, comparison, and `quad_02_phase1` displacement regression tests as characterization tests.
|
||||
|
||||
## Reference Artifacts
|
||||
- `references/quad_02_phase1.inp`
|
||||
- `references/quad_02_displacements.csv`
|
||||
|
||||
Do not edit these files.
|
||||
|
||||
## Acceptance Commands
|
||||
```bash
|
||||
python scripts/validate_workspace.py
|
||||
```
|
||||
|
||||
## Evaluator Checklist
|
||||
- Result model follows `docs/RESULTS_SCHEMA.md`.
|
||||
- `U` and `RF` metadata are unchanged.
|
||||
- CSV comparison still matches by node id, not row order alone.
|
||||
- `quad_02_phase1` stored displacement regression still passes.
|
||||
- HDF5 APIs do not leak into solver core.
|
||||
|
||||
## Handoff Requirements
|
||||
- Update this step status in `phases/1-structure-alignment-refactor/index.json`.
|
||||
- Record moved result/comparator files and any remaining result symbols still left in `fesa.hpp`.
|
||||
|
||||
## Do Not
|
||||
- Do not relax reference tolerances to make relocation pass.
|
||||
- Do not treat missing Abaqus reaction CSV as solved.
|
||||
@@ -0,0 +1,68 @@
|
||||
# Sprint Contract: MITC4 Geometry Strain Extraction
|
||||
|
||||
## Objective
|
||||
Move MITC4 geometry, director, natural-coordinate, displacement, direct covariant strain, and MITC shear-tying helpers into the `Element` module without changing the documented formulation.
|
||||
|
||||
## Required Reading
|
||||
- /AGENTS.md
|
||||
- /PROGRESS.md
|
||||
- /PLAN.md
|
||||
- /docs/README.md
|
||||
- /docs/HARNESS_ENGINEERING.md
|
||||
- /docs/ARCHITECTURE.md
|
||||
- /docs/ADR.md
|
||||
- /docs/NUMERICAL_CONVENTIONS.md
|
||||
- /docs/MITC4_FORMULATION.md
|
||||
- /docs/VERIFICATION_PLAN.md
|
||||
- /phases/1-structure-alignment-refactor/step0-architecture-map.md
|
||||
- /phases/1-structure-alignment-refactor/step3.md
|
||||
|
||||
## Scope
|
||||
- Extract MITC4 natural points, tying points, director frames, geometry, integration basis, displacement derivative helpers, direct strain rows, and MITC shear tying rows.
|
||||
- Keep the FESA/Abaqus S4 node order and tying-point labels unchanged.
|
||||
- Keep diagnostics for invalid thickness, singular center normal, singular basis, and singular Jacobian.
|
||||
- Keep `drilling` handling out of this step except where existing local rotation structures require it.
|
||||
|
||||
## Allowed Files
|
||||
- `include/fesa/fesa.hpp`
|
||||
- `include/fesa/Element/`
|
||||
- `src/Element/`
|
||||
- `include/fesa/Core/`
|
||||
- `include/fesa/Math/`
|
||||
- `tests/`
|
||||
- `CMakeLists.txt`
|
||||
- `phases/1-structure-alignment-refactor/index.json`
|
||||
- `PLAN.md`
|
||||
- `PROGRESS.md`
|
||||
|
||||
## Explicit Non-Goals
|
||||
- Do not change MITC4 formulas, signs, tying interpolation, basis construction, or tolerances.
|
||||
- Do not move stiffness integration or material matrix code in this step unless needed only to resolve declarations.
|
||||
- Do not add S4R, reduced integration, hourglass control, pressure loads, or nonlinear geometry.
|
||||
|
||||
## Tests To Write First
|
||||
- Add or update include/link tests for MITC4 geometry/strain module headers.
|
||||
- Preserve finite-difference, tying interpolation, geometry, basis, and diagnostic tests as characterization tests.
|
||||
|
||||
## Reference Artifacts
|
||||
- None.
|
||||
|
||||
## Acceptance Commands
|
||||
```bash
|
||||
python scripts/validate_workspace.py
|
||||
```
|
||||
|
||||
## Evaluator Checklist
|
||||
- MITC4 geometry/strain helpers live in `Element`.
|
||||
- The implementation still matches `docs/MITC4_FORMULATION.md`.
|
||||
- FESA tying point sign convention remains unchanged.
|
||||
- No parser, assembly, or result behavior changes are mixed in.
|
||||
- Existing MITC4 geometry and strain tests still pass.
|
||||
|
||||
## Handoff Requirements
|
||||
- Update this step status in `phases/1-structure-alignment-refactor/index.json`.
|
||||
- Record moved MITC4 geometry/strain files and any remaining Element symbols still left in `fesa.hpp`.
|
||||
|
||||
## Do Not
|
||||
- Do not simplify or rewrite the formulation during relocation.
|
||||
- Do not tune tests around floating-point drift unless a real relocation-induced bug is found and fixed.
|
||||
@@ -0,0 +1,70 @@
|
||||
# Sprint Contract: MITC4 Material Stiffness Extraction
|
||||
|
||||
## Objective
|
||||
Move MITC4 material matrix, covariant-to-local transform, integration scaffolding, drilling stabilization, stiffness assembly, and internal force helpers into the documented `Element` and `Material` module boundaries.
|
||||
|
||||
## Required Reading
|
||||
- /AGENTS.md
|
||||
- /PROGRESS.md
|
||||
- /PLAN.md
|
||||
- /docs/README.md
|
||||
- /docs/HARNESS_ENGINEERING.md
|
||||
- /docs/ARCHITECTURE.md
|
||||
- /docs/ADR.md
|
||||
- /docs/NUMERICAL_CONVENTIONS.md
|
||||
- /docs/MITC4_FORMULATION.md
|
||||
- /docs/VERIFICATION_PLAN.md
|
||||
- /phases/1-structure-alignment-refactor/step0-architecture-map.md
|
||||
- /phases/1-structure-alignment-refactor/step6.md
|
||||
|
||||
## Scope
|
||||
- Extract plane-stress MITC4 material matrix helpers and material diagnostics.
|
||||
- Extract `2 x 2 x 2` integration data, stiffness accumulation, local/global transform, drilling stabilization, `MITC4ElementKernel`, and internal force helpers.
|
||||
- Keep `drilling_stiffness_scale = 1.0e-3` and reference-diagonal policy unchanged.
|
||||
- Keep `Element` responsible for MITC4 element kernel behavior; keep reusable material-law helpers under `Material` if separated.
|
||||
|
||||
## Allowed Files
|
||||
- `include/fesa/fesa.hpp`
|
||||
- `include/fesa/Element/`
|
||||
- `src/Element/`
|
||||
- `include/fesa/Material/`
|
||||
- `src/Material/`
|
||||
- `include/fesa/Math/`
|
||||
- `tests/`
|
||||
- `CMakeLists.txt`
|
||||
- `phases/1-structure-alignment-refactor/index.json`
|
||||
- `PLAN.md`
|
||||
- `PROGRESS.md`
|
||||
|
||||
## Explicit Non-Goals
|
||||
- Do not change MITC4 stiffness formulas, drilling policy, integration order, or patch-test tolerances.
|
||||
- Do not add stress/resultant output.
|
||||
- Do not add reduced integration, S4R, hourglass control, nonlinear tangent stiffness, or pressure loads.
|
||||
- Do not change assembly behavior beyond include dependency repair.
|
||||
|
||||
## Tests To Write First
|
||||
- Add or update include/link tests for MITC4 stiffness/material module headers.
|
||||
- Preserve stiffness symmetry, rigid body, drilling sensitivity, internal force, patch, and locking-sensitivity tests as characterization tests.
|
||||
|
||||
## Reference Artifacts
|
||||
- None.
|
||||
|
||||
## Acceptance Commands
|
||||
```bash
|
||||
python scripts/validate_workspace.py
|
||||
```
|
||||
|
||||
## Evaluator Checklist
|
||||
- MITC4 material and stiffness code no longer lives in the umbrella header as implementation.
|
||||
- Drilling policy matches `docs/MITC4_FORMULATION.md`.
|
||||
- Element patch and locking-sensitivity tests still pass.
|
||||
- No unsupported Abaqus behavior or result output is added.
|
||||
- Public facade includes remain compatible.
|
||||
|
||||
## Handoff Requirements
|
||||
- Update this step status in `phases/1-structure-alignment-refactor/index.json`.
|
||||
- Record moved MITC4 material/stiffness files and any remaining MITC4 implementation still left in `fesa.hpp`.
|
||||
|
||||
## Do Not
|
||||
- Do not optimize or parallelize element stiffness in this relocation step.
|
||||
- Do not use reference displacement mismatch to retune formulation parameters.
|
||||
@@ -0,0 +1,82 @@
|
||||
# Sprint Contract: Assembly Analysis Extraction
|
||||
|
||||
## Objective
|
||||
Move full-space assembly, reduced projection, reaction recovery path, analysis state/result objects, and linear static workflow into `Assembly` and `Analysis` while preserving Phase 1 solver behavior.
|
||||
|
||||
## Required Reading
|
||||
- /AGENTS.md
|
||||
- /PROGRESS.md
|
||||
- /PLAN.md
|
||||
- /docs/README.md
|
||||
- /docs/HARNESS_ENGINEERING.md
|
||||
- /docs/ARCHITECTURE.md
|
||||
- /docs/ADR.md
|
||||
- /docs/NUMERICAL_CONVENTIONS.md
|
||||
- /docs/RESULTS_SCHEMA.md
|
||||
- /docs/MITC4_FORMULATION.md
|
||||
- /docs/VERIFICATION_PLAN.md
|
||||
- /phases/1-structure-alignment-refactor/step0-architecture-map.md
|
||||
- /phases/1-structure-alignment-refactor/step2.md
|
||||
- /phases/1-structure-alignment-refactor/step3.md
|
||||
- /phases/1-structure-alignment-refactor/step5.md
|
||||
- /phases/1-structure-alignment-refactor/step7.md
|
||||
|
||||
## Scope
|
||||
- Extract `AssemblyResult`, `ReducedSystem`, full-space assembly, reduced projection, and full-vector reaction recovery helpers into `Assembly`.
|
||||
- Extract `AnalysisState`, `AnalysisResult`, `Analysis`, `LinearStaticAnalysis`, and input-to-analysis convenience workflow into `Analysis`.
|
||||
- Keep Strategy + Template Method structure visible.
|
||||
- Preserve `RF = K_full * U_full - F_full`.
|
||||
- Preserve solver adapter injection and deterministic default solver behavior.
|
||||
|
||||
## Allowed Files
|
||||
- `include/fesa/fesa.hpp`
|
||||
- `include/fesa/Assembly/`
|
||||
- `src/Assembly/`
|
||||
- `include/fesa/Analysis/`
|
||||
- `src/Analysis/`
|
||||
- `include/fesa/Core/`
|
||||
- `include/fesa/Element/`
|
||||
- `include/fesa/Math/`
|
||||
- `include/fesa/Results/`
|
||||
- `include/fesa/IO/`
|
||||
- `tests/`
|
||||
- `CMakeLists.txt`
|
||||
- `phases/1-structure-alignment-refactor/index.json`
|
||||
- `PLAN.md`
|
||||
- `PROGRESS.md`
|
||||
|
||||
## Explicit Non-Goals
|
||||
- Do not change solve algorithms, convergence logic, boundary-condition semantics, or result schema.
|
||||
- Do not add nonlinear, dynamic, heat-transfer, pressure-load, RBE, or HDF5 behavior.
|
||||
- Do not compute reactions from reduced quantities.
|
||||
- Do not add production sparse storage beyond the existing scaffold.
|
||||
|
||||
## Tests To Write First
|
||||
- Add or update include/link tests for `Assembly` and `Analysis` module headers.
|
||||
- Preserve assembly, reduced solve, solver injection, full-vector RF, input-to-result workflow, and `quad_02_phase1` reference regression tests as characterization tests.
|
||||
|
||||
## Reference Artifacts
|
||||
- `references/quad_02_phase1.inp`
|
||||
- `references/quad_02_displacements.csv`
|
||||
|
||||
Do not edit these files.
|
||||
|
||||
## Acceptance Commands
|
||||
```bash
|
||||
python scripts/validate_workspace.py
|
||||
```
|
||||
|
||||
## Evaluator Checklist
|
||||
- Assembly owns full-space stiffness/load preservation and reduced projection.
|
||||
- Analysis owns execution flow and state updates.
|
||||
- `DofManager` remains the owner of equation numbering and full/reduced mapping.
|
||||
- Full-vector RF recovery is unchanged.
|
||||
- `quad_02_phase1` displacement regression still passes.
|
||||
|
||||
## Handoff Requirements
|
||||
- Update this step status in `phases/1-structure-alignment-refactor/index.json`.
|
||||
- Record moved assembly/analysis files and any remaining production implementation still left in `fesa.hpp`.
|
||||
|
||||
## Do Not
|
||||
- Do not hide a behavior change under the label "refactor".
|
||||
- Do not broaden Phase 1 feature scope.
|
||||
@@ -0,0 +1,70 @@
|
||||
# Sprint Contract: Architecture Evaluator Closeout
|
||||
|
||||
## Objective
|
||||
Independently evaluate the completed structure-alignment refactor against `docs/ARCHITECTURE.md`, persistent project guardrails, tests, reference artifacts, and phase handoff requirements.
|
||||
|
||||
## Required Reading
|
||||
- /AGENTS.md
|
||||
- /PROGRESS.md
|
||||
- /PLAN.md
|
||||
- /docs/README.md
|
||||
- /docs/HARNESS_ENGINEERING.md
|
||||
- /docs/ARCHITECTURE.md
|
||||
- /docs/ADR.md
|
||||
- /docs/NUMERICAL_CONVENTIONS.md
|
||||
- /docs/ABAQUS_INPUT_SUBSET.md
|
||||
- /docs/VERIFICATION_PLAN.md
|
||||
- /docs/RESULTS_SCHEMA.md
|
||||
- /docs/MITC4_FORMULATION.md
|
||||
- /phases/1-structure-alignment-refactor/index.json
|
||||
- /phases/1-structure-alignment-refactor/step0-architecture-map.md
|
||||
|
||||
## Scope
|
||||
- Review the final production layout under `include/fesa/` and `src/`.
|
||||
- Confirm the umbrella header is a facade, not the primary implementation body.
|
||||
- Confirm source ownership matches the `src/` directory structure in `docs/ARCHITECTURE.md`.
|
||||
- Run validation and inspect stored-reference regression status.
|
||||
- Produce an evaluator report at `phases/1-structure-alignment-refactor/step9-evaluator-report.md`.
|
||||
- Update phase status, `PLAN.md`, and `PROGRESS.md`.
|
||||
|
||||
## Allowed Files
|
||||
- `phases/index.json`
|
||||
- `phases/1-structure-alignment-refactor/index.json`
|
||||
- `phases/1-structure-alignment-refactor/step9-evaluator-report.md`
|
||||
- `PLAN.md`
|
||||
- `PROGRESS.md`
|
||||
|
||||
## Explicit Non-Goals
|
||||
- Do not implement missing refactor work in the evaluator step.
|
||||
- Do not change solver behavior or tests to make evaluation pass.
|
||||
- Do not claim full PRD Phase 1 completion unless R-010 and R-013 are also resolved.
|
||||
- Do not approve a layout that still relies on `fesa.hpp` as the main implementation location.
|
||||
|
||||
## Tests To Write First
|
||||
- None. This is an evaluator-only step.
|
||||
|
||||
## Reference Artifacts
|
||||
- `references/quad_02_phase1.inp`
|
||||
- `references/quad_02_displacements.csv`
|
||||
|
||||
## Acceptance Commands
|
||||
```bash
|
||||
python scripts/validate_workspace.py
|
||||
```
|
||||
|
||||
## Evaluator Checklist
|
||||
- `src/Analysis`, `src/Assembly`, `src/Boundary`, `src/Core`, `src/Element`, `src/IO`, `src/Load`, `src/Math`, `src/Material`, `src/Property`, `src/Results`, and `src/Util` exist as needed and own their documented implementation areas.
|
||||
- `include/fesa/fesa.hpp` is a compatibility facade and does not contain the bulk of production implementation.
|
||||
- Public tests and direct module include tests pass.
|
||||
- Parser subset, MITC4 formulation, numerical conventions, result schema, and reference comparison behavior are unchanged.
|
||||
- `quad_02_phase1` stored displacement regression still passes.
|
||||
- PLAN/PROGRESS clearly state any residual architecture debt.
|
||||
|
||||
## Handoff Requirements
|
||||
- If passed, mark `1-structure-alignment-refactor` completed in `phases/index.json`.
|
||||
- If failed, write concrete findings and required fixes in `step9-evaluator-report.md` and keep the phase pending or blocked.
|
||||
- Keep R-010 and R-013 visible if they remain unresolved.
|
||||
|
||||
## Do Not
|
||||
- Do not self-approve incomplete module separation.
|
||||
- Do not let a passing compile hide architecture drift.
|
||||
Reference in New Issue
Block a user