OOMMF Documentation

Next: Disclaimer

OOMMF
User's Guide

September 27, 2023

This manual documents release 2.1a0.

This manual describes OOMMF (Object Oriented Micromagnetic Framework), a public domain micromagnetics program developed at the National Institute of Standards and Technology. The program is designed to be portable, flexible, and extensible, with a user-friendly graphical interface. The code is written in C++ and Tcl/Tk. Target systems include a wide range of Unix, Windows, and macOS platforms.

Disclaimer
Overview of OOMMF
Installation
- Requirements
- Basic Installation
- Advanced Installation
- Platform Specific Installation Issues
Quick Start: Example OOMMF Session
OOMMF Architecture Overview
Command Line Launching
OOMMF Launcher/Control Interface: mmLaunch
OOMMF eXtensible Solver
- OOMMF eXtensible Solver Interactive Interface: Oxsii
- OOMMF eXtensible Solver Batch Interface: boxsi
- Standard Oxs_Ext Child Classes
- Contributed Oxs_Ext Child Classes
Micromagnetic Problem Editor: mmProbEd
Micromagnetic Problem File Source: FileSource
The 2D Micromagnetic Solver
- The 2D Micromagnetic Interactive Solver: mmSolve2D
- OOMMF 2D Micromagnetic Solver Batch System
Data Table Display: mmDataTable
Data Graph Display: mmGraph
Vector Field Display: mmDisp
Data Archive: mmArchive
Documentation Viewer: mmHelp
Command Line Utilities
- Bitmap File Format Conversion: any2ppm
- Making Data Tables from Vector Fields: avf2odt
- Vector Field File Format Conversion: avf2ovf
- Making Bitmaps from Vector Fields: avf2ppm
- Making PostScript from Vector Fields: avf2ps
- Vector Field File Difference: avfdiff
- Field from Magnetization (3D): computefield
- Cyclic Redundancy Check: crc32
- Killing OOMMF Processes: killoommf
- Last Oxsii/Boxsi Run: lastjob
- The OOMMF Host Server: launchhost
- Oxs Log File Review: logreview
- H Fields from Magnetization (2D): mag2hfield
- MIF Format Conversion: mifconvert
- Process Nicknames: nickname
- ODT Derived Quantity Calculator: odtcalc
- ODT Table Concatenation: odtcat
- ODT Column Extraction: odtcols
- Oxs Package Management: oxspkg
- Oxs Regression Tests: oxsregression
- OOMMF and Process ID Information: pidinfo
- Platform-Independent Make: pimake
Problem Specification File Formats (MIF)
- MIF 1.1
- MIF 1.2
- MIF 2.1
- MIF 2.2
- Tips for writing MIF 2.x files
Data Table File Format (ODT)
Vector Field File Format (OVF)
- The OVF 0.0 format
- The OVF 1.0 format
- The OVF 2.0 format
Troubleshooting
Credits
Bibliography
Index

OOMMF Documentation Team
September 27, 2023