Python API¶
Last changes: Documentation changelog
FullMag’s public authoring surface is the embedded stage-first Python DSL
(import fullmag as fm), usable either in batch stage-first scripts (fm.study(...) and
study.stages.add_*) or interactive live sessions connected to a running FullMag instance
(Live Session, fm.connect()). The tree is organized by authoring owner.
Every terminal API page follows the public entry contract and includes a Control Room crosswalk mapping Python constructs to the Control Room v2 workspace, Semantic Inspectors, and visualization views. Frontend coverage and explicit missing-UI notes are centralized in Control Room capability register.
Meshing is a dedicated family with separate FDM and FEM branches. Within FEM, ferromagnet and airbox commands are separated, and every topology mode has its own page. Low-level composite discretization objects remain in a small compatibility branch instead of mixing with mesh workflows.
Live & batch round-trip¶
Interactive REPL / notebook sessions (fm.connect(), fm.transaction(), fm.relax(), fm.run(),
fm.field(), fm.table(), fm.sweep()) operate over the same underlying SceneDocument and
SI-normalized ProblemIR schema as batch scripts, and can export a canonical stage-first Python script
at any time via fm.export_script().
- Problem
- Problem
- Contract
- Governing equations
- Symbols and SI units
- Assumptions and validity
- Frozen-spin constraints
- Standard entry: Frozen-spins (source-first, argument-complete)
- Python API
- ProblemIR
- Round-trip and failure semantics
- Discrete realization
- Implementation mapping
- Validation
- Limitations
- Scientific bibliography
- Control Room crosswalk
- Source-code index
- Validation
- Problem IR
- Round Trip
- Control Room crosswalk
- API and source scope
- Source-code index
- Problem
- Geometry
- Geometry primitives
- Geometry transforms
- Boolean geometry operations
- Imported geometry
- Geometry regions
- Universe and domain
- Auxiliary geometry
- Control Room crosswalk
- API and source scope
- Source-code index
- Materials
- Magnetic material
- Spatial Parameter Fields
- Elastic materials
- Magnetostriction laws
- Which page owns my input?
- Precedence model
- Common failure modes
- Control Room crosswalk
- API and source scope
- Source-code index
- Magnets and Textures
- Ferromagnet
- Initial magnetization
- Uniform Texture
- Preset Textures
- Contract
- Governing equations
- Coordinate, mapping, plane, and transform pipeline
- Uniform
- Deterministic random texture
- Vortex and antivortex
- Bloch and Neel skyrmions
- Bimeron: implemented field, topology, and exact core geometry
- Smooth Bloch or Neel domain wall
- Two-domain initializer
- Helical texture
- Conical texture
- Antiskyrmion
- Skyrmionium
- Hopfion
- Version 1 compatibility
- Symbols and SI units
- Assumptions and validity
- Python API
- ProblemIR
- Round-trip and failure semantics
- Discrete realization
- Implementation mapping
- Validation
- Limitations
- Scientific bibliography
- Control Room crosswalk
- Source-code index
- Mumax3 Texture Compatibility
- Physical problem
- Governing equations
- Mumax3-compatible vortex wall
- Compact-support hopfion
- Symbols and SI units
- Assumptions and validity
- Python API and parameters
- ProblemIR lowering
- Round-trip, provenance, and failure semantics
- Discrete realization and backend semantics
- Implementation mapping
- Validation
- Limitations and deferred qualification
- Scientific bibliography
- Current magnetization
- Control Room crosswalk
- Python API
- Source-code index
- Control Room crosswalk
- API and source scope
- Source-code index
- Interactions
- Exchange interaction
- Demagnetization
- Zeeman field
- Uniaxial anisotropy
- Cubic anisotropy
- Interfacial DMI
- Bulk DMI
- Thermal noise
- Magnetoelastic interaction
- Oersted field
- Spin-transfer torque
- Spin-orbit torque
- Drift-diffusion spin torque
- Inter-region couplings
- Control Room crosswalk
- API and source scope
- Source-code index
- Current and Excitations
- Current transport
- Prescribed current
- Regional field drive
- RF drive
- Microstrip antenna
- CPW antenna
- Control Room crosswalk
- API and source scope
- Source-code index
- Boundary Conditions
- Periodic boundary conditions
- 1. Physical problem and solver family
- 2. Governing equations
- 3. Symbols and SI units
- 4. Assumptions, boundary meaning, and validity limits
- 5. Python API and complete parameter reference
- 6. ProblemIR, normalization, and provenance
- 7. Round-trip and failure semantics
- 8. Discrete realization and execution sequence
- 9. Implementation mapping
- 10. Validation and qualification
- 11. Limitations and failure modes
- 12. Scientific bibliography
- 13. Source-code index
- Floquet boundary conditions
- 1. Physical problem and solver family
- 2. Governing equations
- 3. Symbols and SI units
- 4. Assumptions, boundary meaning, and validity limits
- 5. Python API and complete parameter reference
- 6. ProblemIR, normalization, and provenance
- 7. Round-trip and failure semantics
- 8. Discrete realization and execution sequence
- 9. Implementation mapping
- 10. Validation and qualification
- 11. Limitations and failure modes
- 12. Scientific bibliography
- 13. Source-code index
- Mechanical boundary conditions and loads
- Control Room crosswalk
- Physics and source scope
- Bibliography
- Source-code index
- Periodic boundary conditions
- Meshing
- FDM Meshing API
- FEM Meshing API
- Bibliography
- Source-code index
- Low-Level Discretization Hints
- Discretization Hints
- Hybrid
- Control Room crosswalk
- API and source scope
- Source-code index
- Dynamics
LLGDynamics Contract- 1. Physical problem and overview
- 2. Governing equations
- 3. Symbols and SI units
- 4. Assumptions and limits of validity
- 5. Python API and parameter contract
- 6.
ProblemIRand canonical script representation - 7. Round-trip, provenance, and failure semantics
- 8. Discrete realization and numerical operators
- 9. Backend and device implementation mapping
- 10. Validation and benchmark gates
- 11. Known limitations and operational constraints
- 12. Scientific bibliography
- 13. Source-code index
- Time Integrator Selection (
LLG.integrator)- 1. Physical problem and overview
- 2. Governing equations
- 3. Symbols and SI units
- 4. Assumptions and limits of validity
- 5. Python API and parameter contract
- 6.
ProblemIRand canonical script representation - 7. Round-trip, provenance, and failure semantics
- 8. Discrete realization and numerical operators
- 9. Backend and device implementation mapping
- 10. Validation and benchmark gates
- 11. Known limitations and operational constraints
- 12. Scientific bibliography
- 13. Source-code index
AdaptiveTimestepContract- 1. Physical problem and overview
- 2. Governing equations
- 3. Symbols and SI units
- 4. Assumptions and limits of validity
- 5. Python API and parameter contract
- 6.
ProblemIRand canonical script representation - 7. Round-trip, provenance, and failure semantics
- 8. Discrete realization and numerical operators
- 9. Backend and device implementation mapping
- 10. Validation and benchmark gates
- 11. Known limitations and operational constraints
- 12. Scientific bibliography
- 13. Source-code index
FieldRefreshPolicyContract- 1. Physical problem and overview
- 2. Governing equations
- 3. Symbols and SI units
- 4. Assumptions and limits of validity
- 5. Python API and parameter contract
- 6.
ProblemIRand canonical script representation - 7. Round-trip, provenance, and failure semantics
- 8. Discrete realization and numerical operators
- 9. Backend and device implementation mapping
- 10. Validation and benchmark gates
- 11. Known limitations and operational constraints
- 12. Scientific bibliography
- 13. Source-code index
- Control Room crosswalk
- API and source scope
- Source-code index
- Studies
TimeEvolutionStudy andadd_timeStage Contract- 1. Physical problem and overview
- 2. Governing equations
- 3. Symbols and SI units
- 4. Assumptions and limits of validity
- 5. Python API and parameter contract
- 6.
ProblemIRand canonical script representation - 7. Round-trip, provenance, and failure semantics
- 8. Discrete realization and numerical operators
- 9. Backend and device implementation mapping
- 10. Validation and benchmark gates
- 11. Known limitations and operational constraints
- 12. Scientific bibliography
- Control Room crosswalk
- 13. Source-code index
RelaxationStudy,RelaxStop, andadd_relaxStage Contract- 1. Physical problem and overview
- 2. Governing equations
- 3. Symbols and SI units
- 4. Assumptions and limits of validity
- 5. Python API and parameter contract
- 6.
ProblemIRand canonical script representation - 7. Round-trip, provenance, and failure semantics
- 8. Discrete realization and numerical operators
- 9. Backend and device implementation mapping
- 10. Validation and benchmark gates
- 11. Known limitations and operational constraints
- 12. Scientific bibliography
- Control Room crosswalk
- 13. Source-code index
- Hysteresis
- Eigenmodes
- 1. Contract and scope
- 2. Governing equations
- 3. Symbols and SI units
- 4. Assumptions and validity
- 5. Python API and complete parameter reference
- 6. ProblemIR
- 7. Round-trip and failure semantics
- 8. Discrete realization
- 9. Implementation mapping
- 10. Validation
- 11. Limitations
- 12. Scientific bibliography
- 13. Source-code index
- Frequency Response
- 1. Physical problem and solver family
- 2. Governing equations
- 3. Symbols and SI units
- 4. Assumptions, boundary meaning, and validity limits
- 5. Python API and complete parameter reference
- 6. ProblemIR, normalization, and provenance
- 7. Round-trip and failure semantics
- 8. Discrete realization and execution sequence
- 9. Implementation mapping
- 10. Validation and qualification
- 11. Limitations and failure modes
- 12. Scientific bibliography
- 13. Source-code index
- Control Room crosswalk
- API and source scope
- Source-code index
- Outputs
- Fields And Scalars
- Quantities
- Modes and Spectra
- 1. Contract and scope
- 2. Governing equations
- 3. Symbols and SI units
- 4. Assumptions and validity
- 5. Python API
- 6. ProblemIR
- 7. Round-trip and failure semantics
- 8. Discrete realization
- 9. Implementation mapping
- 10. Validation
- 11. Limitations
- 12. Scientific bibliography
- Control Room crosswalk
- 13. Source-code index
- Dispersion and Response
- 1. Contract and scope
- 2. Governing equations
- 3. Symbols and SI units
- 4. Assumptions and validity
- 5. Python API
- 6. ProblemIR
- 7. Round-trip and failure semantics
- 8. Discrete realization
- 9. Implementation mapping
- 10. Validation
- 11. Limitations
- 12. Scientific bibliography
- Control Room crosswalk
- 13. Source-code index
- Snapshots
- Autosave
- Control Room crosswalk
- API and source scope
- Source-code index
- Runtime
- Runtime Selection
- Backend Policy
- Simulation
- Live Session
- Results
- Artifacts
- Provenance
- Control Room crosswalk
- API and source scope
- Source-code index
Bibliography¶
No independent scientific model is introduced by this navigation page. Use the bibliography on the selected terminal page; this statement is an explicit applicability boundary, not an omitted reference.
Source-code index¶
This is a navigation page and introduces no standalone implementation symbol. The exact source-code index is maintained by the selected terminal page.