OOMMF Home next up previous contents index
Next: Vector Field File Format Up: Command Line Utilities Previous: Bitmap File Format Conversion:

Making Data Tables from Vector Fields: avf2odt

The avf2odt program converts rectangularly meshed vector field files in any of the recognized formats (OVF, VIO) into the ODT 1.0 data table format.

The avf2odt launch command is:

tclsh oommf.tcl avf2odt [standard options] \
   [-average <space|plane|line|point>] [-axis <x|y|z>] \
   [-region <xmin> <ymin> <zmin> <xmax> <ymax> <zmax>] \
   infile >outfile
-average <space|plane|line|point>
Specify type of averaging. Space outputs 1 data line consisting of the average vx, vy and vz field values in the selected region (see -region option below). For example, in magnetization files, vx, vy and vz correspond to Mx, My and Mz. If plane or line is selected, then the output data table consists of multiple lines with 4 or 5 columns respectively. The last 3 columns in both cases are the vx, vy and vz averaged over the specified axes-parallel affine subspace (i.e., plane or line). In the plane case, the first column specifies the averaging plane offset along the coordinate axis normal to the plane (see -axis option below). In the line case, the first 2 columns specify the offset of the averaging line in the coordinate plane perpendicular to the line. If -type is set to point, then no averaging is done, and the output consists of 6 column data lines, one line for each point in the selected region, where the first 3 columns are the point coordinates, and the last 3 are the vx, vy and vz values at the point.

This parameter is optional. The default value is space.

-axis <x|y|z>
For the -type plane and -type line averaging types, selects which subset of affine subspaces the averaging will be performed over. In the plane case, the -axis represents the normal direction to the planes, while for line it is the direction parallel to the lines. This parameter is ignored if -type is space or point. Optional; default is x.

-region <xmin> <ymin> <zmin> <xmax> <ymax> <zmax>
Axes-parallel rectangular box denoting region in the vector field file over which data is to be collected. The locations are in problem units (typically meters). A single hyphen, ``-'', may be specified for any of the box corner coordinates, in which case the corresponding extremal value from the input file is used. Optional; the default, -region - - - - - -, selects the entire input file.

Name of input file to process. Must be one of the recognized formats, OVF 1.0 or VIO, in a rectangular mesh subformat. Required.
Avf2odt writes its output to stdout. Use the redirection operator ``>'' to send the output to a file. For output format details, see the ODT file description.

Note: The mx, my and mz average magnetization values reported by mmSolve2D exclude points with 0 saturation magnetization. Such points are included by avf2odt, so the data table output from this program will probably not agree with that directly output by mmSolve2D if there are any such regions.

OOMMF Home next up previous Contents index

OOMMF Documentation Team
October 30, 2002