# 7.34. Output

This section is referenced in the following other sections

- Running & Troubleshooting: Results output failure for large meshes
- Simulation Setup: Output Reference
- Simulation Setup: Restart Reference

## 7.34.1. Results Output

Scope

  Aria Region, Input_Output Region

Summary

  Describes the location and type of the output stream used for outputting results for the enclosing region.

    begin Results Output Label

       Additional Steps {=} List_of_steps...

       Additional Times {=} List_of_times...

       At Step n {increment | interval} {=} m

       At Time Dt1 {increment | interval} {=} Dt2

       Auto Output {all | element | global | nodal} User Defined Variables [ In UserOutputResultsList...  ]

       Auto Output {all | element | global | nodal} Variables

       Component Separator Character {=} Separator

       Database Name {=} StreamName

       Database Type {=} {catalyst | catalyst_exodus | cgns | dof | dof_exodus | exodus | exodusii | exonull | generated | genesis | null | parallel_exodus | textmesh}

       Edge [ VariableList...  ]

       Edge Variables {=} [ VariableList...  ]

       Element [ VariableList...  ]

       Element Variables {=} [ VariableList...  ]

       Enable Large Ids

       Exclude {=} [ ElementBlockList...  ]

       Exists {=} {abort | add_suffix | append | overwrite}

       Face [ VariableList...  ]

       Face Variables {=} [ VariableList...  ]

       Global [ Variables...  ]

       Global Variables {=} [ Variables...  ]

       Include {=} [ ElementBlockList...  ]

       Nodal [ VariableList...  ]

       Nodal Variables {=} [ VariableList...  ]

       Node [ VariableList...  ]

       Node Variables {=} [ VariableList...  ]

       Nodeset [ VariableList...  ]

       Nodeset Variables {=} [ VariableList...  ]

       Output Mesh {=} {exposed surface | refined | unrefined}

       Output On Signal {=} {sigabrt | sigalrm | sigfpe | sighup | sigill | sigint | sigkill | sigpipe | sigquit | sigsegv | sigterm | sigusr1 | sigusr2}

       Overwrite {=} {false | no | off | on | true | yes}

       Property PropertyName {=} PropertyValue

       Sideset [ VariableList...  ]

       Sideset Variables {=} [ VariableList...  ]

       Start Time {=} Start_time

       Surface [ VariableList...  ]

       Surface Variables {=} [ VariableList...  ]

       Synchronize Output

       Termination Time {=} Final_time

       Timeseries Name {=} filename

       Timestep Adjustment Interval {=} Nsteps

       Title

       Use External Control

       Use Output Scheduler Timer_name

       begin Catalyst Label
       end

    end Results Output Label

### 7.34.1.1. Line Commands

###### Additional Steps

Syntax

  Additional Steps {=} List_of_steps…

Summary

  Additional simulation steps when output should occur.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
List_of_steps | integer… | –

###### Additional Times

Syntax

  Additional Times {=} List_of_times…

Summary

  Additional simulation times when output should occur.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
List_of_times | real… | –

###### At Step

Syntax

  At Step n {increment | interval} {=} m

Summary

  Specify an output interval in terms of the internal iteration step count. The first step specifies the step count at the beginning of this interval and the second step specifies the output frequency to be used within this interval.

Parameter | Value | Default
--- | --- | ---
n | integer | –
Option | {increment | interval} | –
{=} | {= | are | is} | –
m | integer | –

###### At Time

Syntax

  At Time Dt1 {increment | interval} {=} Dt2

Summary

  Specify an output interval in terms of the internal simulation time. The first time specifies the time at the beginning of this time interval and the second time specifies the output frequency to be used within this interval.

Parameter | Value | Default
--- | --- | ---
Dt1 | real | –
Option | {increment | interval} | –
{=} | {= | are | is} | –
Dt2 | real | –

###### Auto Output

Syntax

  Auto Output {all | element | global | nodal} User Defined Variables [ In UserOutputResultsList… ]

Summary

  Allows users to automatically output all user output defined variables for the type requested.

Parameter | Value | Default
--- | --- | ---
auto_output_type_3 | {all | element | global | nodal} | –

###### Auto Output

Syntax

  Auto Output {all | element | global | nodal} Variables

Summary

  Allows users to automatically output all user output defined variables for the type requested.

Parameter | Value | Default
--- | --- | ---
auto_output_type_3 | {all | element | global | nodal} | –

###### Component Separator Character

Syntax

  Component Separator Character {=} Separator

Summary

  The separator is the single character used to separate the output variable basename (e.g. “stress”) from the suffices (e.g. “xx”, “yy”) when displaying the names of the individual variable components. For example, the default separator is “_”, which results in names similar to “stress_xx”, “stress_yy”, … “stress_zx”. To eliminate the separator, specify an empty string (“”) or NONE.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Separator | string | –

###### Database Name

Syntax

  Database Name {=} StreamName

Summary

  The base name of the database containing the output results. If the filename begins with the ‘/’ character, it is an absolute path; otherwise, the path to the current directory will be prepended to the name. If this line is omitted, then a filename will be created from the basename of the input file with a “.e” suffix appended.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
StreamName | string | –

###### Database Type

Syntax

  Database Type {=} {catalyst | catalyst_exodus | cgns | dof | dof_exodus | exodus | exodusii | exonull | generated | genesis | null | parallel_exodus | textmesh}

Summary

  The database type/format to be used for the output results.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
DatabaseType | {catalyst | catalyst_exodus | cgns | dof | dof_exodus | exodus | exodusii | exonull | generated | genesis | null | parallel_exodus | textmesh} | –

###### Edge

Syntax

  Edge [ VariableList… ]

Summary

  Define the variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line. The entities that this variable are written to can also be limited or specified with “exclude list_of_entities” or “include list_of_entities”. Edge variables are not supported for all database types.

###### Edge Variables

Syntax

  Edge Variables {=} [ VariableList… ]

Summary

  Define the variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line. The entities that this variable are written to can also be limited or specified with “exclude list_of_entities” or “include list_of_entities”. Edge variables are not supported for all database types.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –

###### Element

Syntax

  Element [ VariableList… ]

Summary

  Define the variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line. The entities that this variable are written to can also be limited or specified with “exclude list_of_entities” or “include list_of_entities”

###### Element Variables

Syntax

  Element Variables {=} [ VariableList… ]

Summary

  Define the variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line. The entities that this variable are written to can also be limited or specified with “exclude list_of_entities” or “include list_of_entities”

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –

###### Enable Large Ids

Syntax

  Enable Large Ids

Summary

  Enable 64 bit entity IDs for output

###### Exclude

Syntax

  Exclude {=} [ ElementBlockList… ]

Summary

  Specify that the results file will only contain a subset of the element blocks in the analysis model. The element_block_list lists only the blocks which will not be output to the results database.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –

###### Exists

Syntax

  Exists {=} {abort | add_suffix | append | overwrite}

Summary

  Specify the behavior when creating this database and there is an existing file with the same name. The default behavior is “OVERWRITE” which deletes the existing file and creates a new file of the same name. “APPEND” will (if possible) append the new data to the end of the existing file. “ABORT” will print an error message and end the analysis. “ADD_SUFFIX” will add a -s???? suffix where the ???? is replaced by a sequential number starting at 0002.

Parameter | Value | Default
--- | --- | ---
{=} | {= | is} | –
Option2 | {abort | add_suffix | append | overwrite} | –

###### Face

Syntax

  Face [ VariableList… ]

Summary

  Define the variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line. The entities that this variable are written to can also be limited or specified with “exclude list_of_entities” or “include list_of_entities”. Face variables are not supported for all database types.

###### Face Variables

Syntax

  Face Variables {=} [ VariableList… ]

Summary

  Define the variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line. The entities that this variable are written to can also be limited or specified with “exclude list_of_entities” or “include list_of_entities”. Face variables are not supported for all database types.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –

###### Global

Syntax

  Global [ Variables… ]

Summary

  Define the global variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line.

###### Global Variables

Syntax

  Global Variables {=} [ Variables… ]

Summary

  Define the global variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –

###### Include

Syntax

  Include {=} [ ElementBlockList… ]

Summary

  Specify that the results file will only contain a subset of the element blocks in the analysis model. The element_block_list lists only the blocks which will be output to the results database.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –

###### Nodal

Syntax

  Nodal [ VariableList… ]

Summary

  Define the nodal variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line.

###### Nodal Variables

Syntax

  Nodal Variables {=} [ VariableList… ]

Summary

  Define the nodal variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –

###### Node

Syntax

  Node [ VariableList… ]

Summary

  Define the nodal variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line.

###### Node Variables

Syntax

  Node Variables {=} [ VariableList… ]

Summary

  Define the nodal variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –

###### Nodeset

Syntax

  Nodeset [ VariableList… ]

Summary

  Define the variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line. The entities that this variable are written to can also be limited or specified with “exclude list_of_entities” or “include list_of_entities”. Nodeset variables are not supported for all database types.

###### Nodeset Variables

Syntax

  Nodeset Variables {=} [ VariableList… ]

Summary

  Define the variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line. The entities that this variable are written to can also be limited or specified with “exclude list_of_entities” or “include list_of_entities”. Nodeset variables are not supported for all database types.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –

###### Output Mesh

Syntax

  Output Mesh {=} {exposed surface | refined | unrefined}

Summary

  Use this command to turn on “unrefined” as the output mesh. The default behavior is “refined”, in which field variables are output on the current mesh, which may have been refined (either uniformly or adaptively) or had its topology altered in some way (e.g., dynamic load balancing) with respect to the original mesh read from the input file. By specifying “Output Mesh = unrefined”, all output variables are output only on the original mesh objects read from the input file.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
OutputMesh | {exposed surface | refined | unrefined} | –

###### Output On Signal

Syntax

  Output On Signal {=} {sigabrt | sigalrm | sigfpe | sighup | sigill | sigint | sigkill | sigpipe | sigquit | sigsegv | sigterm | sigusr1 | sigusr2}

Summary

  When the specified signal is raised, the output stream associated with this block will be output.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Signals | {sigabrt | sigalrm | sigfpe | sighup | sigill | sigint | sigkill | sigpipe | sigquit | sigsegv | sigterm | sigusr1 | sigusr2} | –

###### Overwrite

Syntax

  Overwrite {=} {false | no | off | on | true | yes}

Summary

  (DEPRECATED, Use EXISTS) Specify whether the database should be overwritten if it exists. The default behavior is to overwrite unless this command is specified in the output block and either off, false, or no is specified.

Parameter | Value | Default
--- | --- | ---
{=} | {= | is} | –
Option2 | {false | no | off | on | true | yes} | –

###### Property

Syntax

  Property PropertyName {=} PropertyValue

Summary

  Define a database property named “PropertyName” with the value “PropertyValue”. If PropertyValue consists of all digits, it will define an integer property. If PropertyValue is “true” or “yes” or “false” or “no”, it will define a logical property; otherwise it will define a string property. Supported properties are typically database dependent; Current properties are:

  - COMPRESSION_LEVEL = [0..9] (off)

  - COMPRESSION_SHUFFLE = true|false|on|off (off)

  - FILE_TYPE = netcdf4 (forces use of netcdf-4 hdf5-based file) (netcdf3)

  - INTEGER_SIZE_DB = 4|8 (4)

  - INTEGER_SIZE_API = 4|8 (4)

  - REAL_SIZE_DB = 4|8 (8 is default)

  - LOGGING = true|false|on|off (off)

  - MAX_NAME_LENGTH = value (32)

Parameter | Value | Default
--- | --- | ---
PropertyName | string | –
{=} | {= | are | is} | –
PropertyValue | string | –

###### Sideset

Syntax

  Sideset [ VariableList… ]

Summary

  Define the variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line. The entities that this variable are written to can also be limited or specified with “exclude list_of_entities” or “include list_of_entities”. Face variables are not supported for all database types.

###### Sideset Variables

Syntax

  Sideset Variables {=} [ VariableList… ]

Summary

  Define the variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line. The entities that this variable are written to can also be limited or specified with “exclude list_of_entities” or “include list_of_entities”. Face variables are not supported for all database types.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –

###### Start Time

Syntax

  Start Time {=} Start_time

Summary

  Specify the time to start outputting results from this output request block. This time overrides all ‘at time’ and ‘at step’ specifications.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Start_time | real | –

###### Surface

Syntax

  Surface [ VariableList… ]

Summary

  Define the variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line. The entities that this variable are written to can also be limited or specified with “exclude list_of_entities” or “include list_of_entities”. Face variables are not supported for all database types.

###### Surface Variables

Syntax

  Surface Variables {=} [ VariableList… ]

Summary

  Define the variables that should be written to the results database. If “variable” is entered, then its name will be used on the output database. If “variable as db_name” is entered, then “db_name” will be the name used on the database for the internal variable “variable”. Multiple “variable” or “variable as db_name” entries are allowed on the same line. The entities that this variable are written to can also be limited or specified with “exclude list_of_entities” or “include list_of_entities”. Face variables are not supported for all database types.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –

###### Synchronize Output

Syntax

  Synchronize Output

Summary

  In an analysis with multiple regions, it is sometimes desirable to synchronize the output of results data between the regions. This can be done by adding the SYNCHRONIZE OUTPUT command line to the results output block. If a results block has this set, then it will write output whenever a previous region writes output. The ordering of regions is based on the order in the input file, algorithmic considerations, or by solution control specifications.

  Although the USE OUTPUT SCHEDULER command line can also synchronize output between regions, the SYNCHRONIZE OUTPUT command line will synchronize the output with regions where the output frequency is not under the direct control of the Sierra IO system. Examples of this are typically coupled applications where one or more of the codes are not Sierra-based applications such as Alegra and CTH. A results block with SYNCHRONIZE OUTPUT specified will also synchronize its output with the output of the external code.

  The SYNCHRONIZE OUTPUT command can be used with other output scheduling commands such as time-based or step-based output specifications.

###### Termination Time

Syntax

  Termination Time {=} Final_time

Summary

  Specify the time to stop outputting results from this output request block.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Final_time | real | –

###### Timeseries Name

Syntax

  Timeseries Name {=} filename

Summary

  Optionally specify a filename for a timeseries file that outputs the root database filename in the order that they are written. This is useful when running on large numbers of processors with many mesh-mods that cause simple disk operations to hang.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
filename | string | –

###### Timestep Adjustment Interval

Syntax

  Timestep Adjustment Interval {=} Nsteps

Summary

  Specify the number of steps to ‘look ahead’ and adjust the timestep to ensure that the specified output times or simulation end time will be hit ‘exactly’.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Nsteps | integer | –

###### Title

Syntax

  Title

Summary

  Specify the title to be used for this specific output block.

###### Use External Control

Syntax

  Use External Control

Summary

  Do not schedule any results output but instead depend on an externally coupled application to explicitly call for results output.

###### Use Output Scheduler

Syntax

  Use Output Scheduler Timer_name

Summary

  Associates a predefined output scheduler with this output block (results, restart, heartbeat, or history).

Parameter | Value | Default
--- | --- | ---
Timer_name | string | –

## 7.34.2. Heartbeat

Scope

  Aria Region, Input_Output Region

Summary

  Describes the location and type of the output stream used for outputting the heartbeat information for the enclosing region.

    begin Heartbeat Label

       Additional Steps {=} List_of_steps...

       Additional Times {=} List_of_times...

       Append {=} {false | off | on | true}

       At Step n {increment | interval} {=} m

       At Time Dt1 {increment | interval} {=} Dt2

       Auto Output {all | element | global | nodal} User Defined Variables [ In UserOutputHeartBeatList...  ]

       Element [ VariableList...  ]

       Exists {=} {abort | append | overwrite}

       Face [ VariableList...  ]

       Flush Interval {=} Option

       Format {=} {csv | original | spyhis}

       Global [ Variables...  ]

       Labels {=} {off | on}

       Legend {=} {off | on}

       Monitor {= | the} {history | restart | results}

       Nodal [ VariableList...  ]

       Node [ VariableList...  ]

       Nodeset [ VariableList...  ]

       Output On Signal {=} {sigabrt | sigalrm | sigfpe | sighup | sigill | sigint | sigkill | sigpipe | sigquit | sigsegv | sigterm | sigusr1 | sigusr2}

       Precision {=} Precision

       Start Time {=} Start_time

       Stream Name {=} OutputFilename

       Synchronize Output

       Termination Time {=} Final_time

       Timestamp Format

       Timestep Adjustment Interval {=} Nsteps

       Use Output Scheduler Timer_name

       Variable {=} {edge | element | face | global | nodal | node} Variable_list...

    end Heartbeat Label

### 7.34.2.1. Line Commands

###### Additional Steps

Syntax

  Additional Steps {=} List_of_steps…

Summary

  Additional simulation steps when output should occur.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
List_of_steps | integer… | –

###### Additional Times

Syntax

  Additional Times {=} List_of_times…

Summary

  Additional simulation times when output should occur.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
List_of_times | real… | –

###### Append

Syntax

  Append {=} {false | off | on | true}

Summary

  Specifies whether the heartbeat file is appended if it exists. By default, the file is appended if restart is requested and not if restart is not requested. This option does not work for automatic restarts because a new heartbeat file is written with each auto restart.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Option | {false | off | on | true} | –

###### At Step

Syntax

  At Step n {increment | interval} {=} m

Summary

  Specify an output interval in terms of the internal iteration step count. The first step specifies the step count at the beginning of this interval and the second step specifies the output frequency to be used within this interval.

Parameter | Value | Default
--- | --- | ---
n | integer | –
Option | {increment | interval} | –
{=} | {= | are | is} | –
m | integer | –

###### At Time

Syntax

  At Time Dt1 {increment | interval} {=} Dt2

Summary

  Specify an output interval in terms of the internal simulation time. The first time specifies the time at the beginning of this time interval and the second time specifies the output frequency to be used within this interval.

Parameter | Value | Default
--- | --- | ---
Dt1 | real | –
Option | {increment | interval} | –
{=} | {= | are | is} | –
Dt2 | real | –

###### Auto Output

Syntax

  Auto Output {all | element | global | nodal} User Defined Variables [ In UserOutputHeartBeatList… ]

Summary

  Allows users to automatically output all user output defined variables for the type requested.

Parameter | Value | Default
--- | --- | ---
auto_output_type_4 | {all | element | global | nodal} | –

###### Element

Syntax

  Element [ VariableList… ]

Summary

  Define the element variables that should be written to the heartbeat database. The syntax is: “element {internal_name} at element {id} as {DBname}” or “element {internal_name} nearest location X, Y, Z as {DBname}”.

  Where {internal_name} is the name of the variable in the Sierra application; and {DBname} is the name as it should appear on the heartbeat database.

###### Exists

Syntax

  Exists {=} {abort | append | overwrite}

Summary

  Specify the behavior when creating this database and there is an existing file with the same name. The default behavior is “OVERWRITE” which deletes the existing file and creates a new file of the same name. “APPEND” will (if possible) append the new data to the end of the existing file. “ABORT” will print an error message and end the analysis.

Parameter | Value | Default
--- | --- | ---
{=} | {= | is} | –
Option2 | {abort | append | overwrite} | –

###### Face

Syntax

  Face [ VariableList… ]

Summary

  Define the face variables that should be written to the heartbeat database. The syntax is: “face {internal_name} at face {id} as {DBname}” or “face {internal_name} nearest location X, Y, Z as {DBname}”.

  Where {internal_name} is the name of the variable in the Sierra application; and {DBname} is the name as it should appear on the heartbeat database.

###### Flush Interval

Syntax

  Flush Interval {=} Option

Summary

  The minimum time interval (in seconds) at which the heartbeat output will be explicitly flushed to disk. The default is 10 seconds.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Option | integer | 10

###### Format

Syntax

  Format {=} {csv | original | spyhis}

Summary

  The stream type/format to be used for the output results.The only three options at this time are ‘Original’ which is the old default Sierra heartbeat format; ‘SpyHis’ which mimics the CTH Spyhis history output format; and ‘CSV’

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
StreamTypes | {csv | original | spyhis} | –

###### Global

Syntax

  Global [ Variables… ]

Summary

  Define the global/reduction variables that should be written to the heartbeat database. The syntax is: “global {internal_name} as {DBname}”.

  Where {internal_name} is the name of the variable in the Sierra application; and {DBname} is the name as it should appear on the heartbeat database.

###### Labels

Syntax

  Labels {=} {off | on}

Summary

  Specifies whether labels will be displayed or just the value of the variable. Labels will be shown if this line is not present.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Option | {off | on} | on

###### Legend

Syntax

  Legend {=} {off | on}

Summary

  Specifies whether a legend will be displayed prior to outputting any variables. The legend will not be shown unless this line is present. The legend shows the names of the variables that will be written to the heartbeat output stream. If the variable has multiple components, then the component count is shown after the variable e.g., velocity(3).

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Option | {off | on} | on

###### Monitor

Syntax

  Monitor {= | the} {history | restart | results}

Summary

  Specifies whether a line will be written to the heartbeat stream when either the results, history, and/or restart data are output.

Parameter | Value | Default
--- | --- | ---
Equals | {= | the} | –
Option | {history | restart | results} | –

###### Nodal

Syntax

  Nodal [ VariableList… ]

Summary

  Define the nodal variables that should be written to the heartbeat database. The syntax is: “nodal {internal_name} at node {id} as {DBname}” or “nodal {internal_name} nearest location X, Y, Z as {DBname}”.

  Where {internal_name} is the name of the variable in the Sierra application; and {DBname} is the name as it should appear on the heartbeat database.

###### Node

Syntax

  Node [ VariableList… ]

Summary

  Define the nodal variables that should be written to the heartbeat database. The syntax is: “node {internal_name} at node {id} as {DBname}” or “node {internal_name} nearest location X, Y, Z as {DBname}”.

  Where {internal_name} is the name of the variable in the Sierra application; and {DBname} is the name as it should appear on the heartbeat database.

###### Nodeset

Syntax

  Nodeset [ VariableList… ]

Summary

  Define the nodeset variables that should be written to the heartbeat database. The syntax is: “nodeset {internal_name} at node {id} as {DBname}” or “nodeset {internal_name} nearest location X, Y, Z as {DBname}”.

  Where {internal_name} is the name of the variable in the Sierra application; and {DBname} is the name as it should appear on the heartbeat database. This option finds a single value for the {internal_name} specified without having to specify a nodeset id or name.

###### Output On Signal

Syntax

  Output On Signal {=} {sigabrt | sigalrm | sigfpe | sighup | sigill | sigint | sigkill | sigpipe | sigquit | sigsegv | sigterm | sigusr1 | sigusr2}

Summary

  When the specified signal is raised, the output stream associated with this block will be output.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Signals | {sigabrt | sigalrm | sigfpe | sighup | sigill | sigint | sigkill | sigpipe | sigquit | sigsegv | sigterm | sigusr1 | sigusr2} | –

###### Precision

Syntax

  Precision {=} Precision

Summary

  The precision to be used for the output of real variables (default=5).

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Precision | integer | 5

###### Start Time

Syntax

  Start Time {=} Start_time

Summary

  Specify the time to start outputting results from this output request block. This time overrides all ‘at time’ and ‘at step’ specifications.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Start_time | real | –

###### Stream Name

Syntax

  Stream Name {=} OutputFilename

Summary

  The filename of where the heartbeat data should be written. If the filename begins with the ‘/’ character, it is an absolute path; otherwise, the path to the current directory will be prepended to the name. In addition, there are several predefined streams that can be specified. The predefined streams are ‘cout’ or ‘stdout’ specifies standard output; ‘cerr’, ‘stderr’, ‘clog’, or ‘log’ specifies standard error; ‘output’ or ‘outputP0’ specifies Sierra’s standard output which is redirected to the file specified by the ‘-o’ option on the command line. If the file already exists, it is overwritten. If this line is omitted, then a filename will be created from the basename of the input file with a “.hrt” suffix appended.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
OutputFilename | string | –

###### Synchronize Output

Syntax

  Synchronize Output

Summary

  In an analysis with multiple regions, it is sometimes desirable to synchronize the output of results data between the regions. This can be done by adding the SYNCHRONIZE OUTPUT command line to the results output block. If a results block has this set, then it will write output whenever a previous region writes output. The ordering of regions is based on the order in the input file, algorithmic considerations, or by solution control specifications.

  Although the USE OUTPUT SCHEDULER command line can also synchronize output between regions, the SYNCHRONIZE OUTPUT command line will synchronize the output with regions where the output frequency is not under the direct control of the Sierra IO system. Examples of this are typically coupled applications where one or more of the codes are not Sierra-based applications such as Alegra and CTH. A results block with SYNCHRONIZE OUTPUT specified will also synchronize its output with the output of the external code.

  The SYNCHRONIZE OUTPUT command can be used with other output scheduling commands such as time-based or step-based output specifications.

###### Termination Time

Syntax

  Termination Time {=} Final_time

Summary

  Specify the time to stop outputting results from this output request block.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Final_time | real | –

###### Timestamp Format

Syntax

  Timestamp Format

Summary

  The format to be used for the timestamp. See ‘man strftime’ for more information.

###### Timestep Adjustment Interval

Syntax

  Timestep Adjustment Interval {=} Nsteps

Summary

  Specify the number of steps to ‘look ahead’ and adjust the timestep to ensure that the specified output times or simulation end time will be hit ‘exactly’.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Nsteps | integer | –

###### Use Output Scheduler

Syntax

  Use Output Scheduler Timer_name

Summary

  Associates a predefined output scheduler with this output block (results, restart, heartbeat, or history).

Parameter | Value | Default
--- | --- | ---
Timer_name | string | –

###### Variable

Syntax

  Variable {=} {edge | element | face | global | nodal | node} Variable_list…

Summary

  Define the variables that should be written to the heartbeat output. The user can request that the values of certain variables be output on the heartbeat line. These variables are limited to region and framework control data currently. The syntax is:

      variable = {entity_type} {internal_name} at
                 {entity_type} {entity_id}     as {external_name}
      variable = {entity_type} {internal_name} nearest location
                 {x,y,z} as {external_name}

  For global variables, use:

      variable = global {internal_name} [as {external_name}]

  Where:

      entity_type = node, element, face, edge, global
      internal_name = Sierra variable name
      entity_id = id of the node, element, face, edge that you want
              the specified variable output at.
      external_name = name of variable on the database.

  The names ‘timestep’, and ‘time’ can be specified as variables also. They are the current timestep and simulation time. This line can appear multiple times.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Option | {edge | element | face | global | nodal | node} | –
Variable_list | string… | –

## 7.34.3. History Output

Scope

  Aria Region, Input_Output Region

Summary

  Describes the location and type of the output stream used for outputting history for the enclosing region.

    begin History Output Label

       Additional Steps {=} List_of_steps...

       Additional Times {=} List_of_times...

       At Step n {increment | interval} {=} m

       At Time Dt1 {increment | interval} {=} Dt2

       Auto Output {all | element | global | nodal} User Defined Variables [ In UserOutputHistoryList...  ]

       Database Name {=} StreamName

       Database Type {=} {catalyst | catalyst_exodus | cgns | dof | dof_exodus | exodus | exodusii | exonull | generated | genesis | null | parallel_exodus | textmesh}

       Element [ VariableList...  ]

       Exists {=} {abort | add_suffix | append | overwrite}

       Face [ VariableList...  ]

       Global [ Variables...  ]

       Nodal [ VariableList...  ]

       Node [ VariableList...  ]

       Nodeset [ VariableList...  ]

       Output On Signal {=} {sigabrt | sigalrm | sigfpe | sighup | sigill | sigint | sigkill | sigpipe | sigquit | sigsegv | sigterm | sigusr1 | sigusr2}

       Overwrite {=} {false | no | off | on | true | yes}

       Property PropertyName {=} PropertyValue

       Start Time {=} Start_time

       Synchronize Output

       Termination Time {=} Final_time

       Timestep Adjustment Interval {=} Nsteps

       Title

       Use Output Scheduler Timer_name

       Variable {=} {edge | element | face | global | nodal | node} Variable_list...

    end History Output Label

### 7.34.3.1. Line Commands

###### Additional Steps

Syntax

  Additional Steps {=} List_of_steps…

Summary

  Additional simulation steps when output should occur.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
List_of_steps | integer… | –

###### Additional Times

Syntax

  Additional Times {=} List_of_times…

Summary

  Additional simulation times when output should occur.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
List_of_times | real… | –

###### At Step

Syntax

  At Step n {increment | interval} {=} m

Summary

  Specify an output interval in terms of the internal iteration step count. The first step specifies the step count at the beginning of this interval and the second step specifies the output frequency to be used within this interval.

Parameter | Value | Default
--- | --- | ---
n | integer | –
Option | {increment | interval} | –
{=} | {= | are | is} | –
m | integer | –

###### At Time

Syntax

  At Time Dt1 {increment | interval} {=} Dt2

Summary

  Specify an output interval in terms of the internal simulation time. The first time specifies the time at the beginning of this time interval and the second time specifies the output frequency to be used within this interval.

Parameter | Value | Default
--- | --- | ---
Dt1 | real | –
Option | {increment | interval} | –
{=} | {= | are | is} | –
Dt2 | real | –

###### Auto Output

Syntax

  Auto Output {all | element | global | nodal} User Defined Variables [ In UserOutputHistoryList… ]

Summary

  Allows users to automatically output all user output defined variables for the type requested.

Parameter | Value | Default
--- | --- | ---
auto_output_type_2 | {all | element | global | nodal} | –

###### Database Name

Syntax

  Database Name {=} StreamName

Summary

  The base name of the database containing the output history. If the filename begins with the ‘/’ character, it is an absolute path; otherwise, the path to the current directory will be prepended to the name. If this line is omitted, then a filename will be created from the basename of the input file with a “.h” suffix appended.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
StreamName | string | –

###### Database Type

Syntax

  Database Type {=} {catalyst | catalyst_exodus | cgns | dof | dof_exodus | exodus | exodusii | exonull | generated | genesis | null | parallel_exodus | textmesh}

Summary

  The database type/format to be used for the output history.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
DatabaseTypes | {catalyst | catalyst_exodus | cgns | dof | dof_exodus | exodus | exodusii | exonull | generated | genesis | null | parallel_exodus | textmesh} | –

###### Element

Syntax

  Element [ VariableList… ]

Summary

  Define the element variables that should be written to the history database. The syntax is: “element {internal_name} at element {id} as {DBname}” or “element {internal_name} nearest location X, Y, Z as {DBname}”.

  Where {internal_name} is the name of the variable in the Sierra application; and {DBname} is the name as it should appear on the history database.

###### Exists

Syntax

  Exists {=} {abort | add_suffix | append | overwrite}

Summary

  Specify the behavior when creating this database and there is an existing file with the same name. The default behavior is “OVERWRITE” which deletes the existing file and creates a new file of the same name. “APPEND” will (if possible) append the new data to the end of the existing file. “ABORT” will print an error message and end the analysis. “ADD_SUFFIX” will add a -s???? suffix where the ???? is replaced by a sequential number starting at 0002.

Parameter | Value | Default
--- | --- | ---
{=} | {= | is} | –
Option2 | {abort | add_suffix | append | overwrite} | –

###### Face

Syntax

  Face [ VariableList… ]

Summary

  Define the face variables that should be written to the history database. The syntax is: “face {internal_name} at face {id} as {DBname}” or “face {internal_name} nearest location X, Y, Z as {DBname}”.

  Where {internal_name} is the name of the variable in the Sierra application; and {DBname} is the name as it should appear on the history database.

###### Global

Syntax

  Global [ Variables… ]

Summary

  Define the global/reduction variables that should be written to the history database. The syntax is: “global {internal_name} as {DBname}”.

  Where {internal_name} is the name of the variable in the Sierra application; and {DBname} is the name as it should appear on the history database.

###### Nodal

Syntax

  Nodal [ VariableList… ]

Summary

  Define the nodal variables that should be written to the history database. The syntax is: “nodal {internal_name} at node {id} as {DBname}” or “nodal {internal_name} nearest location X, Y, Z as {DBname}”.

  Where {internal_name} is the name of the variable in the Sierra application; and {DBname} is the name as it should appear on the history database.

###### Node

Syntax

  Node [ VariableList… ]

Summary

  Define the nodal variables that should be written to the history database. The syntax is: “node {internal_name} at node {id} as {DBname}” or “node {internal_name} nearest location X, Y, Z as {DBname}”.

  Where {internal_name} is the name of the variable in the Sierra application; and {DBname} is the name as it should appear on the history database.

###### Nodeset

Syntax

  Nodeset [ VariableList… ]

Summary

  Define the nodeset variables that should be written to the history database. The syntax is: “nodeset {internal_name} at node {id} as {DBname}” or “nodeset {internal_name} nearest location X, Y, Z as {DBname}”.

  Where {internal_name} is the name of the variable in the Sierra application; and {DBname} is the name as it should appear on the history database.

###### Output On Signal

Syntax

  Output On Signal {=} {sigabrt | sigalrm | sigfpe | sighup | sigill | sigint | sigkill | sigpipe | sigquit | sigsegv | sigterm | sigusr1 | sigusr2}

Summary

  When the specified signal is raised, the output stream associated with this block will be output.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Signals | {sigabrt | sigalrm | sigfpe | sighup | sigill | sigint | sigkill | sigpipe | sigquit | sigsegv | sigterm | sigusr1 | sigusr2} | –

###### Overwrite

Syntax

  Overwrite {=} {false | no | off | on | true | yes}

Summary

  (DEPRECATED, Use EXISTS) Specify whether the database should be overwritten if it exists. The default behavior is to overwrite unless this command is specified in the output block and either off, false, or no is specified.

Parameter | Value | Default
--- | --- | ---
{=} | {= | is} | –
Option2 | {false | no | off | on | true | yes} | –

###### Property

Syntax

  Property PropertyName {=} PropertyValue

Summary

  Define a database property named “PropertyName” with the value “PropertyValue”. If PropertyValue consists of all digits, it will define an integer property. If PropertyValue is “true” or “yes” or “false” or “no”, it will define a logical property; otherwise it will define a string property. Supported properties are typically database dependent; Some history-related properties are:

  - VARIABLE_NAME_CASE = upper|lower

  - MAX_NAME_LENGTH = value (32)

Parameter | Value | Default
--- | --- | ---
PropertyName | string | –
{=} | {= | are | is} | –
PropertyValue | string | –

###### Start Time

Syntax

  Start Time {=} Start_time

Summary

  Specify the time to start outputting results from this output request block. This time overrides all ‘at time’ and ‘at step’ specifications.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Start_time | real | –

###### Synchronize Output

Syntax

  Synchronize Output

Summary

  In an analysis with multiple regions, it is sometimes desirable to synchronize the output of results data between the regions. This can be done by adding the SYNCHRONIZE OUTPUT command line to the results output block. If a results block has this set, then it will write output whenever a previous region writes output. The ordering of regions is based on the order in the input file, algorithmic considerations, or by solution control specifications.

  Although the USE OUTPUT SCHEDULER command line can also synchronize output between regions, the SYNCHRONIZE OUTPUT command line will synchronize the output with regions where the output frequency is not under the direct control of the Sierra IO system. Examples of this are typically coupled applications where one or more of the codes are not Sierra-based applications such as Alegra and CTH. A results block with SYNCHRONIZE OUTPUT specified will also synchronize its output with the output of the external code.

  The SYNCHRONIZE OUTPUT command can be used with other output scheduling commands such as time-based or step-based output specifications.

###### Termination Time

Syntax

  Termination Time {=} Final_time

Summary

  Specify the time to stop outputting results from this output request block.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Final_time | real | –

###### Timestep Adjustment Interval

Syntax

  Timestep Adjustment Interval {=} Nsteps

Summary

  Specify the number of steps to ‘look ahead’ and adjust the timestep to ensure that the specified output times or simulation end time will be hit ‘exactly’.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Nsteps | integer | –

###### Title

Syntax

  Title

Summary

  Specify the title to be used for this specific output block.

###### Use Output Scheduler

Syntax

  Use Output Scheduler Timer_name

Summary

  Associates a predefined output scheduler with this output block (results, restart, heartbeat, or history).

Parameter | Value | Default
--- | --- | ---
Timer_name | string | –

###### Variable

Syntax

  Variable {=} {edge | element | face | global | nodal | node} Variable_list…

Summary

  Define the variables that should be written to the history database. The syntax is: “variable = entity {internal_name} at entity {id} as {DBname}” or “variable = entity {internal_name} nearest location X, Y, Z as {DBname}” or “variable = entity {internal_name} at location X, Y, Z as {DBname}”.

  Where {entity} is ‘node’, ‘element’, ‘face’, or ‘edge’; {internal_name} is the name of the variable in the Sierra application; and {DBname} is the name as it should appear on the history database.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Option | {edge | element | face | global | nodal | node} | –
Variable_list | string… | –

## 7.34.4. Output Scheduler

Scope

  Sierra

Summary

  Defines an output scheduler at the domain level which can be used by one or more output blocks (restart, results, heartbeat, history> at region scope. If used by multiple output blocks, their output will be synchronized.

    begin Output Scheduler Label

       Additional Steps {=} List_of_steps...

       Additional Times {=} List_of_times...

       At Step n {increment | interval} {=} m

       At Time Dt1 {increment | interval} {=} Dt2

       Output On Signal {=} {sigabrt | sigalrm | sigfpe | sighup | sigill | sigint | sigkill | sigpipe | sigquit | sigsegv | sigterm | sigusr1 | sigusr2}

       Start Time {=} Start_time

       Synchronize Output

       Termination Time {=} Final_time

       Timestep Adjustment Interval {=} Nsteps

       Use Output Scheduler Timer_name

    end Output Scheduler Label

### 7.34.4.1. Line Commands

###### Additional Steps

Syntax

  Additional Steps {=} List_of_steps…

Summary

  Additional simulation steps when output should occur.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
List_of_steps | integer… | –

###### Additional Times

Syntax

  Additional Times {=} List_of_times…

Summary

  Additional simulation times when output should occur.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
List_of_times | real… | –

###### At Step

Syntax

  At Step n {increment | interval} {=} m

Summary

  Specify an output interval in terms of the internal iteration step count. The first step specifies the step count at the beginning of this interval and the second step specifies the output frequency to be used within this interval.

Parameter | Value | Default
--- | --- | ---
n | integer | –
Option | {increment | interval} | –
{=} | {= | are | is} | –
m | integer | –

###### At Time

Syntax

  At Time Dt1 {increment | interval} {=} Dt2

Summary

  Specify an output interval in terms of the internal simulation time. The first time specifies the time at the beginning of this time interval and the second time specifies the output frequency to be used within this interval.

Parameter | Value | Default
--- | --- | ---
Dt1 | real | –
Option | {increment | interval} | –
{=} | {= | are | is} | –
Dt2 | real | –

###### Output On Signal

Syntax

  Output On Signal {=} {sigabrt | sigalrm | sigfpe | sighup | sigill | sigint | sigkill | sigpipe | sigquit | sigsegv | sigterm | sigusr1 | sigusr2}

Summary

  When the specified signal is raised, the output stream associated with this block will be output.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Signals | {sigabrt | sigalrm | sigfpe | sighup | sigill | sigint | sigkill | sigpipe | sigquit | sigsegv | sigterm | sigusr1 | sigusr2} | –

###### Start Time

Syntax

  Start Time {=} Start_time

Summary

  Specify the time to start outputting results from this output request block. This time overrides all ‘at time’ and ‘at step’ specifications.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Start_time | real | –

###### Synchronize Output

Syntax

  Synchronize Output

Summary

  In an analysis with multiple regions, it is sometimes desirable to synchronize the output of results data between the regions. This can be done by adding the SYNCHRONIZE OUTPUT command line to the results output block. If a results block has this set, then it will write output whenever a previous region writes output. The ordering of regions is based on the order in the input file, algorithmic considerations, or by solution control specifications.

  Although the USE OUTPUT SCHEDULER command line can also synchronize output between regions, the SYNCHRONIZE OUTPUT command line will synchronize the output with regions where the output frequency is not under the direct control of the Sierra IO system. Examples of this are typically coupled applications where one or more of the codes are not Sierra-based applications such as Alegra and CTH. A results block with SYNCHRONIZE OUTPUT specified will also synchronize its output with the output of the external code.

  The SYNCHRONIZE OUTPUT command can be used with other output scheduling commands such as time-based or step-based output specifications.

###### Termination Time

Syntax

  Termination Time {=} Final_time

Summary

  Specify the time to stop outputting results from this output request block.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Final_time | real | –

###### Timestep Adjustment Interval

Syntax

  Timestep Adjustment Interval {=} Nsteps

Summary

  Specify the number of steps to ‘look ahead’ and adjust the timestep to ensure that the specified output times or simulation end time will be hit ‘exactly’.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Nsteps | integer | –

###### Use Output Scheduler

Syntax

  Use Output Scheduler Timer_name

Summary

  Associates a predefined output scheduler with this output block (results, restart, heartbeat, or history).

Parameter | Value | Default
--- | --- | ---
Timer_name | string | –