ODT Table Concatenation: odtcat

The odtcat utility reads an ODT file on stdin that contains one or more tables, and concatenates them together into a single table, creating a new ODT file consisting of a single table. When successive tables are joined, the tail of the first is truncated as necessary so that the specified control column is monotonic across the seam.

This tool is useful for fixing up ODT output from a simulation that was interrupted and restarted from checkpoint data one or more times.

Launching
The odtcat launch command is:

tclsh oommf.tcl odtcat [standard options] [-b overlap_lines] \
   [-c control_column] [-o order] [-q] <infile >outfile

where

-b overlap_lines

Overlap window size. This is the maximum number of lines to retain when looking for overlap between two adjacent tables. This is also the upper limit on the number of lines that may be removed when two tables are joined. The default value is 100.

-c control_column

Specifies control column, either by number or glob-string. Default is the glob string {Oxs_TimeDriver:*:Simulation time } Oxs_MinDriver:*:Iteration.

-o order

Order selection: one of increase, decrease, auto (default), or none.

-q

Quiet; don't write informational messages to stderr.

<infile

odtcat reads its input from stdin. Use the redirection operator ``<'' to read input from a file.

>outfile

odtcat writes its output to stdout. Use the redirection operator ``>'' to send output to a file.

The first table header is examined and compared against the control column specification to identify the control column. If multiple columns match the control column specification, then an error is reported and the process exits. The OOMMF command line utility odtcols with the -s command line switch can be used to view column headers before running odtcat.

Each table in the input stream is assumed to have the same layout as the first; header information between tables is summarily eliminated. As each table is encountered, a check is made that the new table has the same number of columns as the first. If not, an error is reported and processing is halted.

When subsequent table headers are encountered, the values in the control column in the tail of the preceding table and the head of the succeeding table are compared. The order selection is used to determine the position of the start of the latter table inside the tail of the former. If the data are not compatible with the specified ordering, then an error is reported an the program aborts. If identical values are discovered, then the matching lines in the earlier table are excluded from the output stream.

If the -q flag is not specified, then after processing is complete a report is written to stderr detailing the number of tables merged and the number of data lines eliminated.

OOMMF Documentation Team
May 11, 2021