Home    Search    Reference Manuals    Return   





Users Manual for Program MTABLE




Table of Contents

   Introduction
   Input data commands
   Input data Example
   Output data Example




Introduction

Program MTABLE extracts scalars written in *.resu-files generated by program MPLOT. Program MTABLE automatically executes program MPLOT if necessary. MTABLE collects the results from different calculations and generates a table which summarizes all calculations in one file MTABLE_FILE. If the user so which, the table in the MTABLE_FILE can be sorted in different ways by the script sort_mtabler.




Input data commands

Input data are read in free format, valid separators between the input values are <space>, <comma>, <tab>, <equal sign> or <carriage return>. The commands can be written both in lower and upper case letters. The operation of the program is controlled by the commands described below; some of the commands also need arguments.

FOLLOW_SECS= <fsecs>
Update the output every fsecs seconds.
When program MTABLE is extracting results from calculations made in program OPTI. It is possible to let program MTABLE follow the results written in program OPTI, the output is updated every fsecs [s]. If fsecs is less or equal 0(zero) program MTABLE will only write to MTABLE_FILE only once and then stop further execution.
Declared= Real*4    Default= 0.

IDENT_FILES= <.id-files>
Extract results from the following files. The file description under the IDENT_FILES-command can be written as a UNIX ambiguous file reference. How the UNIX ambiguous file references shall be written, please write opman sh and search for ambiguous file reference or pathname expansion.
The files under IDENT_FILES can be any of *.id, *.mp, *.resu or *.print. Up to 1000 files or expressions can be written under IDENT_FILES.
Declared= Character*80(1000)    Default= "id/*.id"

LIMIT_VALUE= <val_lim>
Mark values exceeding val_lim in red font in the output table.
Declared= Real*4    Default= 1.e36

MPLOTF_FILE= <.mplotf-file>
Defines the *.mplotf-file to be used when creating the *.resu-, *.print- and *.mp-files.
Program MTABLE reads the the timestamp of the *.mplotf-file and *.id-files, if necessary MTABLE will start program MPLOT in order to update the contents in the *.resu-, *.print- and/or *.mp-files.
If MPLOTF_FILE equals blank, program MTABLE will not start program MPLOT.
Declared= Character*132    Default= Blank

WRITE_ID= <char>
Indicator for writing the names of the *.resu-files used in the table.
char=no => No output will be written in the table.
char=yes=> The *.resu-files will be written in the first column of the table.
Declared= Character*3    Default= yes

WRITE_HEAD= <char>
Indicator for writing a head line in the table.
char=no => No output will be written in the table.
char=yes=> Head line number HEAD_NO will be written in the last column of the table.
Declared= Character*3    Default= yes

HEAD_NO= <value>
Setting the head line number to be printed in the table.
Declared= Integer*4    Default= 1

VARIABLES= <chars>
Variables to be extracted from the *.resu-files and written in the table.
The number of items defined under command VARIABLES will control the number of columns to be written in the output table. If no variables are defined, program MTABLE will exit with an error message.
Declared= Character*24(100)    Default= Blank

VALUE= <chars>
Controls the type of value to be written in the output table.
The contents in the *.resu-files are generated by the STAT- and FTWZ-command in program MPLOT. If number of items in VALUE are less than number of items in VARIABLES program MTABLE will repeat the last item in VALUE for the last variables in VARIABLES. If number of items in VALUE are more than number of items in VARIABLES the extra data in VALUE will be omitted.

Following keywords reads scalars generated in the STAT-command:
MAX = The maximum value of the variable
MIN = The minimum value of the variable
NO = The scalar will not be searched for in the .resu-file
RMS = The RMS-value of the variable
RMQ = The RMQ-value of the variable.
AVERAGE = The average value of the variable,
key-word AV can also be used.
STANDARD_DEVIATION = The standard deviation of the variable,
key-word SD can also be used.
PERCENTILE_0.15 = The 0.15 percentile of the variable,
key-word PTILE_0.15 can also be used.
PERCENTILE_25 = The 25 percentile of the variable,
key-word PTILE_25 can also be used.
PERCENTILE_50 = The 50 percentile of the variable,
key-word PTILE_50 can also be used.
PERCENTILE_75 = The 75 percentile of the variable,
key-word PTILE_75 can also be used.
PERCENTILE_99.85 = The 99.85 percentile of the variable,
key-word PTILE_99.85 can also be used.
XVAR_WHEN_MAX = The time when the maximum value of the variable was obtained
key-word TMA can also be used.
XVAR_WHEN_MIN = The time when the minimum value of the variable was obtained
key-word TMI can also be used.
ABS_MAX = The maximum value of abs(MAX) and abs(MIN),
key-word AMAX can also be used.

Following keywords reads scalars generated by the FTWZ-command:
WZ = Ride Index WZ
DF = The dominating frequency in Ride Index WZ
F1 = The dominating frequency in the Fourier series.
A1 = The amplitude of the dominating frequency in the Fourier series.
Fx = Frequency number x in the Fourier series.
Ax = Amplitude number x in the Fourier series
ASUM= The sum of A1-A6

Declared= Character*24(100)    Default= ABS_MAX

FORMAT= <chars>
Controls how the columns in the table will be printed.
The syntax of command FORMAT is designed in the same way as in the FORTRAN write statement. The documentation of the format specification can be found in any FORTRAN manual, but here follows a brief description:

  1. Real numbers.
    Real numbers are printed in the table by the Fw.d format specification, where w is the width of the field containing the whole number and d is the width of the fractional part of the number. Number w must be greater than 3+d, to give enough space between the numbers in the table.

  2. Real numbers with exponent.
    Real numbers with exponent are printed in the table by the Ew.d format specification, where w is the width of the field containing the whole number and d is the width of the fractional part of the number. Number w must be greater than 8+d, to give enough space between the numbers in the table.

  3. Automatic selection of exponent.
    Real numbers can be printed in the table with the Gw.d format specification. This specification writes the numbers without exponent if possible, otherwise exponent format will be used. Number w must be greater than 8+d, to give enough space between the numbers in the table.

  4. Scale factor
    The scale factor kP can be used together with the Ew.d editing descriptor. In the Ew.d editing descriptor the exponent will be chosen in a way that the number will be between 0-1, but if a scale factor 1P is written before the Ew.d editing descriptor the number in the output will be between 1-10.

  5. The format specification must be enclosed in parenthesis.
    Writing a table with real numbers occupying 11 positions, with 3 digits shall be written in the following way:
    '(f11.3)'
    Writing a table with real numbers with exponent occupying 12 positions, with 4 digits shall be written in the following way:
    '(1pe12.4)'
    Writing a table with real numbers occupying 12 positions, and 4 digits shall be written in the following way:
    '(1p,g12.4)'

If number of items in FORMAT are less than number of items in VARIABLES program MTABLE will repeat the last item in FORMAT for the last variables in VARIABLES. If number of items in FORMAT are more than number of items in VARIABLES the extra data in FORMAT will be omitted.
Declared= Character*24(100)    Default= '(1p,g12.4)'

SCALE= <chars>
Scaling factor to be applied to the values in VARIABLES.
All values in each column will be multiplied by this scale factor. If number of items in SCALE are less than number of items in VARIABLES program MTABLE will repeat the last item in SCALE for the last variables in VARIABLES. If number of items in SCALE are more than number of items in VARIABLES the extra data in SCALE will be omitted.
Declared= Real*4(100)    Default= 1.0

MTABLE_FILE= <output-file>
Defines the output file where the table will be printed.
If MTABLE_FILE is not defined the output will be written to standard output.
Declared= Character*132    Default= Blank

MTABLE_FILE_APPEND= <yes/no>
Defines if the MTABLE_FILE should be appended or replaced.
Declared= Character*3    Default= no

MTABLE_FILE_BACKUPS= <yes/no>
Defines the creating of MTABLE_FILE backup files.
If MTABLE_FILE_BACKUPS sets equal to yes, old results will be saved in backup files. A maximum of 10 backup files can be created.
Declared= Character*3    Default= yes

WRITE_INFOS= <yes/no>
Indicator for writing info messages to standard output.
The info messages contains information about how program MTABLE searches for the required scalars.
Declared= Character*3    Default= yes

WRITE_WARNINGS= <yes/no>
Indicator for writing warning messages to standard output.
It can be useful to suppress the messages when writing the result file MTABLE_FILE to standard output.
Declared= Character*3    Default= yes

END
A command which stops reading of input data, and starts the execution of the program.


Example:

Following example: Master.mtablef can be used as a master file:

##
##     Input data for program MTABLE
##

 IDENT_FILES= id/*.id                # Select idents

 MPLOTF_FILE= mplotf/Master.mplotf   # MPLOT input data file

 WRITE_ID   = yes                    # Write the ident in the table
 WRITE_HEAD = yes  HEAD_NO= 4        # Write head line #4 in the table

 VARIABLES  = S111 S112 S121 S122    # Variables to be written
 VALUE      = abs_max                # Type of value to be written
 FORMAT     = '(f11.3)'              # Output format and scale,
 SCALE      = 1e-3                   # last item will be repeated

 LIMIT_VALUE= 80e3                   # Mark big values in red
 MTABLE_FILE= S_forces.mtabler       # Output data file
 MTABLE_FILE_BACKUPS= yes            # Create MTABLE_FILE backups

 WRITE_WARNINGS= yes                 # Write warning messages
 WRITE_INFOS= yes                    # Write information messages

 FOLLOW_SECS= 60.                    # Update the output every 60 sec.
                                     # Useful when running OPTI


Output data example:

Following example shows the mplotr output file written in RTF-format:

misc_mtable_1.png