How taewooopark/mumax3-ultrafast works
mumax³ ultrafast is a mumax³-compatible micromagnetic simulator, with a native Apple Metal execution backend and an optional desktop app. The main workflow is to provide an .mx3 script, execute it through the Go engine and GPU backend, and inspect or convert the resulting fields. The repository also includes a standalone result viewer, file conversion tools, and a distributed server. Several backend and desktop-runtime links are documented rather than visible in sampled implementation excerpts, so those links are marked unverified where appropriate.
Main entry points: mumax3/main.go mumax3 command · engine Physics engine · mumax3-convert/main.go Format converter · App.tsx Desktop workspace
Components 17
Desktop experience
- Desktop workspace
apps/desktop/src/App.tsx - Desktop API
apps/desktop/src/api.ts - 3D result viewer
apps/desktop/src/components/ResultViewer.tsx
Simulation runtime
- mumax3 command
cmd/mumax3/main.go - Script compiler
script/compile.go - Physics engine
engine - Demag kernel
mag/demagkernel.go - Distributed server
cmd/mumax3-server/main.go
GPU execution
- GPU operations
cuda - Metal backend
cuda/metal/metal_runtime_darwin_arm64.cc
Results and tools
- Simulation outputs
engine - Format converter
cmd/mumax3-convert/main.go - OVF I/O
oommf/oommf.go - Dump I/O
dump/read.go - Field rendering
draw/image.go
Other components
- Physicist
- Desktop runtime
Connections 18
- Physicist → Desktop workspace: opens workspace
README.md - Physicist → mumax3 command: runs simulation
README.md - Desktop workspace → Desktop API: uses API
apps/desktop/src/App.tsx - Desktop workspace → 3D result viewer: loads viewer
apps/desktop/src/App.tsx - Desktop API → Desktop runtime: invokes runtime
- mumax3 command → Script compiler: compiles scripts
cmd/mumax3/main.go - mumax3 command → Physics engine: runs engine
cmd/mumax3/main.go - mumax3 command → GPU operations: initializes GPU
cmd/mumax3/main.go - Physics engine → GPU operations: uses GPU operations
engine/average.go - Physics engine → Demag kernel: builds demag kernel
- GPU operations → Metal backend: executes on Metal
README.md - Physics engine → Simulation outputs: writes simulation outputs
README.md - Physicist → Format converter: converts results
cmd/mumax3-convert/main.go - Format converter → OVF I/O: reads and writes OVF
cmd/mumax3-convert/main.go - Format converter → Dump I/O: reads dumps
cmd/mumax3-convert/main.go - Format converter → Field rendering: renders images
cmd/mumax3-convert/main.go - 3D result viewer → Simulation outputs: visualizes OVF results
README.md - Distributed server → mumax3 command: runs jobs