The application batchsolve provides a simple command line interface to the OOMMF micromagnetic solver engine.
The application batchsolve is launched by the command line:
tclsh oommf.tcl batchsolve [standard options] [-end_exit <0|1>] [-end_paused] [-interface <0|1>] \ [-restart <0|1>] [-start_paused] [file]where
The input file file should contain a Micromagnetic Input Format (MIF) problem description, such as produced by mmProbEd. The batch solver searches several directories for this file, including the current working directory, the data and scripts subdirectories, and parallel directories relative to the directories app/mmsolve and app/mmpe in the OOMMF distribution. Refer to the search_path variable in batchsolve.tcl for the complete list.
If -interface is set to 1 (enabled), batchsolve registers with the account service directory application, and mmLaunch will be able to provide an interactive interface. Using this interface, batchsolve may be controlled in a manner similar to mmSolve2D. The interface allows you to pause, un-pause, and terminate the current simulation, as well as to attach data display applications to monitor the solver's progress. If more interactive control is needed, mmSolve2D should be used.
If -interface is 0 (disabled), batchsolve does not register, leaving it without an interface, unless it is sourced into another script (e.g., batchslave.tcl) that arranges for an interface on the behalf of batchsolve.
-start_paused switch to monitor the progress of
batchsolve from the very start of a simulation. With this
switch the solver will be paused immediately after loading the
specified MIF file, so you can bring up the interactive interface
and connect display applications before the simulation begins. Start the
simulation by selecting the Run command from the interactive
interface. This option cannot be used if -interface is disabled.
-end_paused switch insures that the solver does
not automatically terminate after completing the specified
simulation. This is not generally useful, but may find application
when batchsolve is called from inside a Tcl-only wrapper
The output may be changed by a Tcl wrapper script, but the default output behavior of batchsolve is to write tabular text data and the magnetization state at the control point for each applied field step. The tabular data are appended to the file basename.odt, where basename is the ``Base Output Filename'' specified in the input MIF file. See the routine GetTextData in batchsolve.tcl for details, but at present the output consists of the solver iteration count, nominal applied field B, reduced average magnetization m, and total energy. This output is in the ODT file format.
The magnetization data are written to a series of OVF (OOMMF Vector Field) files, basename.fieldnnnn.omf, where nnnn starts at 0000 and is incremented at each applied field step. (The ASCII text header inside each file records the nominal applied field at that step.) These files are viewable using mmDisp.
The solver also automatically appends the input problem specification and miscellaneous runtime information to the log file basename.log.
In addition to directly launching batchsolve from the command line, batchsolve.tcl may also be sourced into another Tcl script that provides additional control structures. Within the scheduling system of OBS, batchsolve.tcl is sourced into batchslave, which provides additional control structures that support scheduling control by batchmaster. There are several variables and routines inside batchsolve.tcl that may be accessed and redefined from such a wrapper script to provide enhanced functionality.
The following Tcl procedures are designed for external use and/or redefinition: