forked from 1b-agent/fieldcraft-upstream
docs: examples gallery in the README
An Examples section before Build: a tile per sample with its picture, one line and its name for File > Samples or fieldcraft --sample NAME, linking docs/examples.md; the roadmap notes the gallery. Closes #167 Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01UhhZMBTviDQxZvwnyP89fo
This commit is contained in:
1 parent
0b7f3021d9
commit
98d263ae54
2 files changed
+15
-1
No files matched your search
@@ -92,6 +92,19 @@ The same part also meshes all-hex automatically with the octree mesher (`mesh.he
|
||||
|
||||

|
||||
|
||||
## Examples
|
||||
|
||||
Ready-to-solve samples: open one from **File ▸ Samples** (or the start screen), or start the app
|
||||
with `fieldcraft --sample NAME`, and press **Solve**. Each opens and solves within half a minute and is checked
|
||||
against a closed form or a reference solution ([docs/examples.md](docs/examples.md)).
|
||||
|
||||
| | | |
|
||||
|---|---|---|
|
||||
|  |  |  |
|
||||
| **Drop test** (`drop-test`): an aluminium bracket dropped 2 m onto a tilted floor; explicit dynamics, the strike's stress waves | **Rubber seal** (`rubber-seal`): a Mooney–Rivlin gasket ring squeezed 25 %; nonlinear static, large strain | **Heated bracket** (`heated-bracket`): a clamped steel bracket heated at one end; steady heat and thermal stress |
|
||||
|  | *No picture yet: the viewport does not draw flow results (M12).* | |
|
||||
| **Hex-meshed bracket** (`bracket-hex`): the bracket split into 30 cells, meshed all-hex (hex20), von Mises | **Flow past a bracket** (`flow-past`): air past an L-bracket on the floor; lattice Boltzmann flow, the drag and the force on each face | |
|
||||
|
||||
## Build
|
||||
|
||||
```sh
|
||||
@@ -106,6 +119,7 @@ Rust 1.95 or later, with the `wasm32-unknown-unknown` target for `cargo xtask ci
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Examples](docs/examples.md): the ready-to-solve samples and their checks
|
||||
- [Architecture](docs/architecture.md): crates, layers and the meshing pipeline
|
||||
- [Element library](docs/elements.md) and [verification and validation](docs/verification.md)
|
||||
- [Capability checklist](docs/parity.md) and [roadmap](ROADMAP.md)
|
||||
|
||||
Reference in new issue
Block a user