OOMMF Oxs Extension Modules

This page contains links to extensions to the OOMMF Oxs (OOMMF eXtensible Solver) 3D micromagnetic solvers, Oxsii and Boxsi. These extensions were not developed by OOMMF personnel, and NIST assumes no responsibility whatsoever for its use by other parties, and makes no guarantees, expressed or implied, about its quality, reliability, or any other characteristic.

The “OOMMF releases” information below marks the earliest version of OOMMF that the extension has been successfully tested against. Later versions of OOMMF should also work, unless an explicit note to the contrary is provided.

These extensions are included in each OOMMF release postdating the extension initial release date. The corresponding OOMMF binary release includes binary builds of extensions not requiring external libraries. Extensions requiring external libraries must be built by the user from source.

General Oxs extensions installation instructions

To install and use Oxs extension software, you should follow the instructions from the site where you downloaded the extension. Some extensions on this page may be included in official OOMMF releases. Otherwise, adding an extension requires a C++ compiler compatible with OOMMF. The installation sections of the OOMMF User's Guide contain information on C++ compiler requirements and detailed build instructions. In general, though, 3 steps will be required:
  1. Download the Oxs extension software and install (copy) it into the directory
    Depending on the extension, additional supporting software libraries may also need to be installed on your system. Check the documentation for the Oxs extension you are installing for details.

  2. (Re)build the OOMMF software. If you are using a binary distribution of OOMMF, you should first destroy the pre-built executables by running the following command from the OOMMF root directory (oommf/):
    tclsh oommf.tcl pimake distclean
    If you originally built from source, and have not changed your compiler nor made other significant changes to your build environment, then you may omit the "pimake distclean" step. To compile the Oxs extension software and link it into the Oxs executable, run the command
    tclsh oommf.tcl pimake
    from the oommf root directory (oommf/).

  3. Create MIF 2.x files that contain Specify blocks for the new Oxs extension class. See the documentation of the extension class for details.

Oxs Extension Modules

Date created: February 6, 2004 | Last updated: January 5, 2023    Contact: Webmaster