# 7.8. Particle Region

This section is referenced in the following other sections

- Simulation Setup: Particles

## 7.8.1. Particle Region

Scope

  Fuego Procedure

Summary

  Contains the commands needed to build and solve a set of Lagrangian particles

    begin Particle Region Regionname

       Compute Continuity Source

       Compute Energy Source

       Compute Mixture_Fraction Source

       Compute Momentum Source

       Compute Rte Particle Source

       Compute Soot_Mass_Fraction Source [ With Soot Split {=} SootSplit  ]

       Compute Source Lhs Contribution

       Compute Species Source

       Disable Particle Transfer Checks

       Fluid Region Name {=} FluidRegionName

       Fluid Velocity Fluctuation Model {=} {continuous_random_walk | discrete_random_walk | none}

       Include Thermophoretic Force

       Interpolate Fluid Variable FluidVarName For Output As ParticleVarName [ With Vector Size VecSize  ]

       Lagrangian Particles

       Maximum Particle Subcycles {=} SubCycles

       Minimum Particle Subcycles {=} SubCycles

       Number Of Fluid Species {=} NumSpecies

       Particle Maximum Search Grid Dimension {=} Size

       Particle Random Number Generator Seed {=} Size

       Particle Rebalance Imbalance Threshold {=} Threshold

       Particle Rebalance Step Frequency {=} Nsteps

       Particle Reservoir Size {=} Size

       Perform Initial Particle Rebalance

       Use Finite Element Model ModelName [ Model Coordinates Are Nodal_variable_name  ]

       begin Create Initial Particle Distribution DistributionName
       end

       begin Create Particles From File BlockName
       end

       begin Fluid Variable Specification SpecificationName
       end

       begin Heartbeat Label
       end

       begin Heartbeat Output Label
       end

       begin History Output Label
       end

       begin Insert Particle Particlename
       end

       begin Particle Average AverageName
       end

       begin Particle Breakup Model ModelName
       end

       begin Particle Definition Particlename
       end

       begin Particle Filled Shape FilledShapeName
       end

       begin Particle Filled Tree FilledTreeName
       end

       begin Particle Inflow Boundary Condition On Surface Surfacename
       end

       begin Particle Interaction Model ModelName
       end

       begin Particle Interface InterfaceName
       end

       begin Particle Material MaterialName
       end

       begin Particle Open Boundary Condition On Surface Surfacename
       end

       begin Particle Postprocess Operation
       end

       begin Particle Postprocessing Name
       end

       begin Particle Spray SprayName
       end

       begin Particle Stats Output Name
       end

       begin Particle Tabular Output Name
       end

       begin Particle Wall Boundary Condition On Surface Surfacename
       end

       begin Restart Data Label
       end

       begin Results Output Label
       end

    end Particle Region Regionname

### 7.8.1.1. Line Commands

###### Compute Continuity Source

Syntax

  Compute Continuity Source

Summary

  Compute continuity source to be transferred to fluid region.

Description

  Compute a continuity source term to be used in the fluid continuity equation (pressure). The source term is accumulated in the nodal field called continuity_source, which has units of mass change per time per volume. This field should be transferred to the fluid region into the corresponding field.

###### Compute Energy Source

Syntax

  Compute Energy Source

Summary

  Compute energy source to be transferred to fluid region.

Description

  Compute an energy source term to be used in the fluid energy equation. The source term is accumulated in the nodal field called energy_source, which has units of internal energy change per time per volume (the same units as density times dh/dt). This field should be transferred to the fluid region into the corresponding field.

###### Compute Mixture_Fraction Source

Syntax

  Compute Mixture_Fraction Source

Summary

  Compute mixture fraction sources to be transferred to fluid region.

Description

  Compute a mixture fraction source terms to be used in the fluid species. The source terms are accumulated in two nodal fields called `mixture_fraction_source` and `second_mixture_fraction_source`, which have units of change in mass per time per volume. These fields should be transferred to the fluid region into the corresponding fields. The specific components of the mixture fraction vector for which a source is added depend on the specific Particle Type being used. For example, for the `WILDFIRE_PARTICLE` type the first variable contains the source for water vapor and the second for the volatile stream.

###### Compute Momentum Source

Syntax

  Compute Momentum Source

Summary

  Compute momentum source to be transferred to fluid region.

Description

  Compute a momentum source term to be used in the fluid momentum equation. The source term is accumulated in the nodal field called momentum_source, which has units of momentum change per time per volume (the same units as density times du/dt). This field should be transferred to the fluid region into the corresponding field.

###### Compute Rte Particle Source

Syntax

  Compute Rte Particle Source

Summary

  Compute radiative source term in particle energy equation.

Description

  Compute a radiative source term in the particle energy equation. This option will require specification of the `ABSORPTIVITY` in the particle material block. This option will also require the transfer of scalar flux in the transfer from a PMR region to the Lagrangian region.

###### Compute Soot_Mass_Fraction Source

Syntax

  Compute Soot_Mass_Fraction Source [ With Soot Split {=} SootSplit ]

Summary

  Compute soot mass fraction source to be transferred to fluid region.

Description

  Compute a soot mass fraction source terms to be used in the fluid soot mass fraction transport equation. The source terms are accumulated in the nodal fields called `soot_mass_fraction_source`, which have units of change in mass per time per volume. These fields should be transferred to the fluid region into the corresponding fields.

  An optional parameter to this line command specifies the split of volatile production directed to soot. Default for this parameter is 0.01.

###### Compute Source Lhs Contribution

Syntax

  Compute Source Lhs Contribution

Summary

  Compute LHS matrix contribution from particle source terms to fluid equation.

Description

  Compute contributions from particle source terms to the diagonal of the LHS matrix of the corresponding fluid equations. This contribution provides added stability in the fluid solve. The LHS contribution is accumulated in nodal fields called x_momentum_source_lhs, y_momentum_source_lhs, and z_momentum_source_lhs for the momentum equations; energy_source_lhs for the energy equation; species_source_lhs for the species equations (not yet implemented); and continuity_source_lhs for the continuity equation (not yet implemented). These fields should be transferred to the fluid region into the corresponding fields.

###### Compute Species Source

Syntax

  Compute Species Source

Summary

  Compute species source to be transferred to fluid region.

Description

  Compute a species source term to be used in the fluid species. The source term is accumulated in the nodal field called species_source, which has units of mass of species k change per time per volume. This field should be transferred to the fluid region into the corresponding field.

###### Disable Particle Transfer Checks

Syntax

  Disable Particle Transfer Checks

Summary

  Disables transfer checking on the particle region.

Description

  Normally the transfers to the particle region are verified against the particle physics, but this command disables these checks. This is an advanced user option - use with care. Transfer errors are treated as warnings and printed to the log file when this option is active.

###### Fluid Region Name

Syntax

  Fluid Region Name {=} FluidRegionName

Summary

  Inform particle region of the name of the fluid region to which it is coupled. This is needed if associations must be made between particle-related and fluid species, e.g. between oxidizers or products of particle reactions that are coupled to fluid species.

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

###### Fluid Velocity Fluctuation Model

Syntax

  Fluid Velocity Fluctuation Model {=} {continuous_random_walk | discrete_random_walk | none}

Summary

  Specify the fluid velocity fluctuation type for this particle block.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
FluctVelModelType | {continuous_random_walk | discrete_random_walk | none} | –

###### Include Thermophoretic Force

Syntax

  Include Thermophoretic Force

Summary

  Include thermophoretic force in momentum source terms.

Description

  Compute the thermophoretic force on a Lagrangian particle to be included in the momentum source terms of the particle momentum equations. Thermophoretic force is given by , where is the particle radius, is the fluid viscosity, is the fluid density, is the fluid temperature, and is the temperature gradient affecting the particle. The `temperature_gradient` field must be transferred from the fluid region to the corresponding particle region field when using this capability.

###### Interpolate Fluid Variable

Syntax

  Interpolate Fluid Variable FluidVarName For Output As ParticleVarName [ With Vector Size VecSize ]

Summary

  Define an interpolation from the fluid to the particles

Description

  The FluidVarName should be the name of a fluid variable that is on the receiving end of a transfer operation from a Fuego fluid region. The ParticleVarName may be chosen by the user; this same variable should then be listed in the region output block to obtain values in the output file.

Parameter | Value | Default
--- | --- | ---
FluidVarName | string | –
ParticleVarName | string | –

###### Lagrangian Particles

Syntax

  Lagrangian Particles

Summary

  Allows the introduction of Lagrangian particles into the flow.

###### Maximum Particle Subcycles

Syntax

  Maximum Particle Subcycles {=} SubCycles

Summary

  Set maximum number of subcycles to be taken for each particle at each timestep.

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

###### Minimum Particle Subcycles

Syntax

  Minimum Particle Subcycles {=} SubCycles

Summary

  Set minimum number of subcycles to be taken for each particle at each timestep.

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

###### Number Of Fluid Species

Syntax

  Number Of Fluid Species {=} NumSpecies

Summary

  Set number of fluid species in the coupled Fuego region (needed for handling mass fractions transferred from Fuego region)

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

###### Particle Maximum Search Grid Dimension

Syntax

  Particle Maximum Search Grid Dimension {=} Size

Summary

  This feature is deprecated as the auxiliary structured grid has been replaced by a stk coarse search.

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

###### Particle Random Number Generator Seed

Syntax

  Particle Random Number Generator Seed {=} Size

Summary

  Specify a random number generator seed for particle region related rand() calls.

Description

  Seeds the pseudo-random number generator used by the boost mersenne twister random number generator within the particle region with the unsigned integer value. The default seed is set to 12345 + Rank ID for a multiprocessor run (12345 + 0 for a single processor run). This command line will also influence the sequence of values produced by the random number generator outside the particle region. Currently random numbers are used in particle probability distribution functions, particle spray, particle breakup model, particle surface interactions and particle dynamics.

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

###### Particle Rebalance Imbalance Threshold

Syntax

  Particle Rebalance Imbalance Threshold {=} Threshold

Summary

  Set threshold for the ratio of maximum to minimum particles per processor that triggers dynamic particle rebalance.

Description

  Set threshold for the ratio of maximum to minimum particles per processor that triggers dynamic particle rebalance. This is the percent imbalance to trigger a rebalance, so an entry of 0.25 will rebalance when the maximum imbalance is 25 percent off from idea. This command works in tandem with the `PARTICLE REBALANCE STEP FREQUENCY` command, and Fuego will test the imbalance threshold and if necessary perform a rebalance only on the steps indicated by the frequency command. If no step frequency is specified, no rebalance will be performed. If the minimum number of particles on a processor is zero, a value of one is used for the minimum when computing the max/min ratio.

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

###### Particle Rebalance Step Frequency

Syntax

  Particle Rebalance Step Frequency {=} Nsteps

Summary

  Set frequency (in timesteps) with which dynamic rebalancing of the mesh decomposition of the particle region will be recomputed, when necessary.

Description

  Set frequency (in timesteps) with which the need for dynamic rebalancing of the mesh decomposition of the particle region will be recomputed. Weighting for the decomposition is based on number of particles per element, so that after redistributing the mesh each processor should include approximately the same number of particles. Note that this command works together with the `PARTICLE REBALANCE IMBALANCE THRESHOLD` command. At the specified frequency, Fuego computes the current level of imbalance (the ratio of maximum to minimum particles per processor). If this imbalance exceeds the specified threshold, a rebalance is performed. If no frequency is specified, the default is to perform no rebalancing.

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

###### Particle Reservoir Size

Syntax

  Particle Reservoir Size {=} Size

Summary

  Keep a reservoir of inactive particles to minimize topology changes and reduce the number of output files.

Description

  The exodus output file format requires a constant number of mesh objects across all timesteps. In particle simulations, particle mesh objects are created and destroyed whenever they enter or exit the domain; in parallel, particle mesh objects must also be created or destroyed whenever they enter of leave the local mesh partition. This results in a new exodus file being written at each output time step. These files can be concatenated in EnSight or ParaView using filename wildcards, but the number of files can become unwieldy. To alleviate this, Fuego allows a reservoir of inactive particles to be created and stored. At the beginning of the simulation, the reservoir is filled with the number of inactive particles specified by the \textt{PARTICLE RESERVOIR SIZE} command. When a new particle is introduced to the flow, instead of creating or destroying a mesh object, a particle from the reservoir is activated. Similarly, when a particle passes out of the domain, its mesh object is inactivated and returned to the reservoir. An element variable with field name “active” can be output, equal to 1 for active particles and 0 for inactive; this variable can aid in visualization of only the active particles. If the reservoir shrinks to size zero or grows to twice its specified size, it is reset to the specified size; this results in a change in the number of mesh objects and the need for a new exodus file. However, by choosing a reasonable reservoir size the user can reduce the total number of output files; the ideal size is approximately the maximum number of particles expected on any one processor at any given time throughout the course of the simulation.

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

###### Perform Initial Particle Rebalance

Syntax

  Perform Initial Particle Rebalance

Summary

  Perform a particle rebalance during initialization

###### Use Finite Element Model

Syntax

  Use Finite Element Model ModelName [ Model Coordinates Are Nodal_variable_name ]

Summary

  Associates a predefined finite element model with this region.

Parameter | Value | Default
--- | --- | ---
ModelName | string | –

## 7.8.2. Create Initial Particle Distribution

Scope

  Particle Region

Summary

  Defines an initial distribution of particles within the region’s volume based on the mesh

  This feature is DEPRECATED – it is difficult to ensure that particle creation along the elements of the mesh is applied consistently

    begin Create Initial Particle Distribution DistributionName

       Diameter {=} Diameter

       X_Velocity {=} X_velocity

       Y_Velocity {=} Y_velocity

       Z_Velocity {=} Z_velocity

       Particle Definition {=} Definition

    end Create Initial Particle Distribution DistributionName

### 7.8.2.1. Line Commands

###### Diameter

Syntax

  Diameter {=} Diameter

Summary

  Set initial diameter of particle(s)

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

###### X_Velocity

Syntax

  X_Velocity {=} X_velocity

Summary

  Set initial x velocity for particle(s).

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

###### Y_Velocity

Syntax

  Y_Velocity {=} Y_velocity

Summary

  Set initial y velocity for particle(s).

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

###### Z_Velocity

Syntax

  Z_Velocity {=} Z_velocity

Summary

  Set initial z velocity for particle(s).

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

###### Particle Definition

Syntax

  Particle Definition {=} Definition

Summary

  Set particle definition to be used for this block

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

## 7.8.3. Create Particles From File

Scope

  Particle Region

Summary

  Block that defines creation of particles using a tab-delimited data file

Description

  This block defines the creation of a set of particles based on data in a tab-delimited text file. The first line of this file should contain a single integer, giving the number of particles to be created. The rest of the file defines the particle data, one particle per line. There are two accepted formats for the particle file: 7-columns and 10-columns. The following is required in the correct order for the 7-column format: particle positions x, y, and z; particle velocities u, v, and w; and particle diameter d. 3 additional fields are required for the 10-column format, and the fields should be in this order: particle positions x, y, and z; particle velocities u, v, and w; particle diameter d; particle temperature T; particle number represented (parcelling); and particle insertion time.

  Note that the particle temperature and number represented, and insertion time are specified as constant for all particles in the file when using the 7-column format.

    begin Create Particles From File BlockName

       Creation_Time {=} CreationTime

       Diameter {=} Diameter

       Filename {=} FileName

       Interaction List Filename {=} InteractionListFileName

       Insertion Time {=} InsertionTime

       Length_Scale_Factor {=} LengthScaleFactor

       Mass Represented {=} Mass_represented

       Mass_Fraction Species {=} y0

       Number Represented {=} Num_represented

       Porosity {=} Porosity

       Time_Scale_Factor {=} TimeScaleFactor

       Track Particles For Tabular Output

       Temperature {=} Temperature

       X_Velocity {=} X_velocity

       Y_Velocity {=} Y_velocity

       Z_Velocity {=} Z_velocity

       Particle Definition {=} Definition

    end Create Particles From File BlockName

### 7.8.3.1. Line Commands

###### Creation_Time

Syntax

  Creation_Time {=} CreationTime

Summary

  Set time at which to insert particles

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

###### Diameter

Syntax

  Diameter {=} Diameter

Summary

  Set initial diameter of particle(s)

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

###### Filename

Syntax

  Filename {=} FileName

Summary

  Name of file containing tab-delimited particle data.

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

###### Interaction List Filename

Syntax

  Interaction List Filename {=} InteractionListFileName

Summary

  Name of file containing interaction list.

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

###### Insertion Time

Syntax

  Insertion Time {=} InsertionTime

Summary

  Set time at which to insert particle; particle will be inserted at the first time step at or after this value.

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

###### Length_Scale_Factor

Syntax

  Length_Scale_Factor {=} LengthScaleFactor

Summary

  Multiplicative factor to be applied to all lengths in the input file (e.g. if file data is in meters and simulation is in cm, this factor should be 0.01)

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

###### Mass Represented

Syntax

  Mass Represented {=} Mass_represented

Summary

  Set mass of physical particles represented by each particle node.

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

###### Mass_Fraction

Syntax

  Mass_Fraction Species {=} y0

Summary

  Specification of mass fraction to be used for computing particle mass initial condition.

Parameter | Value | Default
--- | --- | ---
Species | string | –
{=} | {= | are | is} | –
y0 | real | –

###### Number Represented

Syntax

  Number Represented {=} Num_represented

Summary

  Set number of physical particles represented by each particle node.

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

###### Porosity

Syntax

  Porosity {=} Porosity

Summary

  Set initial porosity for particle(s).

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

###### Time_Scale_Factor

Syntax

  Time_Scale_Factor {=} TimeScaleFactor

Summary

  Multiplicative factor to be applied to all time values in the input file

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

###### Track Particles For Tabular Output

Syntax

  Track Particles For Tabular Output

Summary

  All particles of this description are added to the tabular output

Description

  Any particle matching this description will be output to the tabular data

###### Temperature

Syntax

  Temperature {=} Temperature

Summary

  Set initial temperature for particle(s).

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

###### X_Velocity

Syntax

  X_Velocity {=} X_velocity

Summary

  Set initial x velocity for particle(s).

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

###### Y_Velocity

Syntax

  Y_Velocity {=} Y_velocity

Summary

  Set initial y velocity for particle(s).

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

###### Z_Velocity

Syntax

  Z_Velocity {=} Z_velocity

Summary

  Set initial z velocity for particle(s).

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

###### Particle Definition

Syntax

  Particle Definition {=} Definition

Summary

  Set particle definition to be used for this block

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

## 7.8.4. Fluid Variable Specification

Scope

  Particle Region

Summary

  Specify fluid variables that will be used in the absence of transfers from the Fuego fluid region.

    begin Fluid Variable Specification SpecificationName

       Density {=} Density

       Molecular_Weight {=} Molec_weight

       Specific_Heat {=} Specific_heat

       Temperature {=} Temperature

       Thermal_Conductivity {=} Thermal_cond

       Turbulent_Dissipation {=} Turbulent_diss

       Turbulent_Kinetic_Energy {=} Turbulent_ke

       Viscosity {=} Viscosity

       X_Velocity {=} X_velocity

       Y_Velocity {=} Y_velocity

       Z_Velocity {=} Z_velocity

    end Fluid Variable Specification SpecificationName

### 7.8.4.1. Line Commands

###### Density

Syntax

  Density {=} Density

Summary

  Set density for fluid.

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

###### Molecular_Weight

Syntax

  Molecular_Weight {=} Molec_weight

Summary

  Set molecular weight for fluid.

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

###### Specific_Heat

Syntax

  Specific_Heat {=} Specific_heat

Summary

  Set specific heat for fluid.

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

###### Temperature

Syntax

  Temperature {=} Temperature

Summary

  Set temperature for fluid.

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

###### Thermal_Conductivity

Syntax

  Thermal_Conductivity {=} Thermal_cond

Summary

  Set thermal conductivity for fluid.

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

###### Turbulent_Dissipation

Syntax

  Turbulent_Dissipation {=} Turbulent_diss

Summary

  Set turbulent dissipation for fluid.

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

###### Turbulent_Kinetic_Energy

Syntax

  Turbulent_Kinetic_Energy {=} Turbulent_ke

Summary

  Set turbulent kinetic energy for fluid.

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

###### Viscosity

Syntax

  Viscosity {=} Viscosity

Summary

  Set viscosity for fluid.

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

###### X_Velocity

Syntax

  X_Velocity {=} X_velocity

Summary

  Set x velocity for fluid.

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

###### Y_Velocity

Syntax

  Y_Velocity {=} Y_velocity

Summary

  Set y velocity for fluid.

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

###### Z_Velocity

Syntax

  Z_Velocity {=} Z_velocity

Summary

  Set z velocity for fluid.

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

## 7.8.5. Particle Postprocessing

Scope

  Particle Region

Summary

  Block that defines creation of fields for postprocessing and possible output

Description

  Fields will be registered, created and computed throughout the simulation. Users can then request this field to be outputted through the results output.

    begin Particle Postprocessing Name

       Postprocess {density_p | diameter_p | film_temperature_p | nusselt_fluid_p | nusselt_particle_p | specific_heat_p | surface_tension_p | thermal_conductivity_p | viscosity_p}

    end Particle Postprocessing Name

### 7.8.5.1. Line Commands

###### Postprocess

Syntax

  Postprocess {density_p | diameter_p | film_temperature_p | nusselt_fluid_p | nusselt_particle_p | specific_heat_p | surface_tension_p | thermal_conductivity_p | viscosity_p}

Summary

  Designate a postprocess variable to be created and post processed for optional output in results file.

Parameter | Value | Default
--- | --- | ---
ParticlePostProcessID | {density_p | diameter_p | film_temperature_p | nusselt_fluid_p | nusselt_particle_p | specific_heat_p | surface_tension_p | thermal_conductivity_p | viscosity_p} | –

## 7.8.6. Particle Postprocess Operation

Scope

  Particle Region

Summary

  Defines a custom post-processor block to be run at the end of the time step.

Description

  The block type defines the post-processor operation performed, as in:

      Begin particle postprocess operation Integral

  or

      Begin particle postprocess operation Average

  The valid types are described below.

  Integral

  Perform an integral of the specified scalar function () on either the specified volume (blocks) or surface (sidesets) and save the result as a global variable. The function can depend on time and space (,,,) and any nodal variable.

  On volumes this is:

  while on surfaces it is:

  Average

  Perform a volume or area weighted average of the specified scalar function () on either the specified volume (blocks) or surface (sidesets) and save the result as a global variable. The function can depend on time and space (,,,) and any nodal variable.

  On volumes this is:

  while on surfaces it is:

  Sum

  Find the nodal summation of the specified scalar function () on either the specified volume (blocks) or surface (sidesets) and save the result as a global variable. The function can depend on time and space (,,,) and any nodal variable.

  Min

  Find the nodal minimum of the specified scalar function () on either the specified volume (blocks) or surface (sidesets) and save the result as a global variable. The function can depend on time and space (,,,) and any nodal variable.

  Max

  Find the nodal maximum of the specified scalar function () on either the specified volume (blocks) or surface (sidesets) and save the result as a global variable. The function can depend on time and space (,,,) and any nodal variable.

  L2_Norm

  Find the nodal L2-norm of the specified scalar function () on either the specified volume (blocks) or surface (sidesets) and save the result as a global variable. The function can depend on time and space (,,,) and any nodal variable.

  On volumes this is:

  while on surfaces it is:

  Global

  Evaluate a global function () and save the result as a global variable. The function can depend on time and any other global variable. You should not specify any location entries for a global post-processor.

      Begin particle postprocess operation Global
        Output name = maxTempC
        Function = "maxTemp - 273.15"
      End

  Nodal_Field

  Evaluate the specified scalar function () on either the specified volume (blocks) or surface (sidesets) and save the result in a nodal field. The function can depend on time and space (,,,) and any nodal variable.

      Begin particle postprocess operation Nodal_Field
        Output name = nuCalc
        Location = all_blocks
        Function = "viscosity/density"
      End

  Integrated_Flux

  Evaluate the integrated flux of a specified vector function (requires 2 or 3 components for depending on problem dimension). This must be performed on surfaces, not on volumes. The result is saved in a global variable. The functions can depend on time and space (,,,) and any nodal variable.

      Begin particle postprocess operation Integrated_Flux
        Output name = mass_flux
        Location = surface_1
        Function = "density*x_velocity" \$
                   "density*y_velocity" \$
                   "density*z_velocity"
      End

    begin Particle Postprocess Operation

       Function {=} FunctionStr...

       Location {=} MeshEntites...

       Output Name {=} OutputName

    end Particle Postprocess Operation

### 7.8.6.1. Line Commands

###### Function

Syntax

  Function {=} FunctionStr…

Summary

  Provide a string function to evaluate in the post-processor.

Description

  A quoted function string for the post-processor to evaluate. For the FLUX post-processor you must provide multiple quoted entries - one per spatial dimension. For all other types you may only provide a single function string.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
FunctionStr | “string”… | –

###### Location

Syntax

  Location {=} MeshEntites…

Summary

  Mesh locations to evaluate the post-processor at.

Description

  A list of block or sideset names to evaluate the post-processor at. For multiple blocks you can either include them all in one line or add separate lines. The aliases “all_blocks” and “all_surfaces” can also be used. You cannot mix blocks and sidesets in a single post-processor block.

      Begin particle postprocess operation nodal_field
        Output name = nuCalc
        Location = all_blocks
        Function = "viscosity/density"
      End

      Begin particle postprocess operation nodal_field
        Output name = nuCalc
        Location = block_1 block_2 block_3
        Function = "viscosity/density"
      End

      Begin particle postprocess operation nodal_field
        Output name = nuCalc
        Location = block_1
        Location = block_2
        Location = block_3
        Function = "viscosity/density"
      End

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

###### Output Name

Syntax

  Output Name {=} OutputName

Summary

  Define the name for the output variable (global or nodal depending on the type).

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

## 7.8.7. Heartbeat

Scope

  Average Region, Fuego Region, Input_Output Region, Particle 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...  ]

       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.8.7.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.

###### 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.8.8. History Output

Scope

  Average Region, Fuego Region, Input_Output Region, Particle 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...  ]

       Flush Interval {=} Option

       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 Dynamic Topology Io

       Use Output Scheduler Timer_name

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

    end History Output Label

### 7.8.8.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.

###### Flush Interval

Syntax

  Flush Interval {=} Option

Summary

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

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

###### 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 Dynamic Topology Io

Syntax

  Use Dynamic Topology Io

Summary

  Specify that the app use IO for dynamic topology modifications where the output files are stored in a single database. Legacy file format for dynamically changing topology results in the creation of multiple files for each output on a mesh modification. This option leverages the ability of netCDF to create mesh groups within a single database and concatenate all mesh files into one. The names of each mesh group are of the form IOSS_MESH_GROUP-??? where ??? is the 1-based output index 1, 2, …, 10, …., 100, … Please note that netCDF has a current limit of 65,536 groups

###### 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.8.9. Insert Particle

Scope

  Particle Region

Summary

  Block that defines data for an individual particle to be inserted into the flow.

    begin Insert Particle Particlename

       Diameter {=} Diameter

       Insertion Time {=} InsertionTime

       Mass Represented {=} Mass_represented

       Mass_Fraction Species {=} y0

       Number {=} Number

       Number Represented {=} Num_represented

       Porosity {=} Porosity

       Track Particles For Tabular Output

       Temperature {=} Temperature

       X {=} x

       X1 {=} x

       X2 {=} x

       X_Velocity {=} X_velocity

       Y {=} y

       Y1 {=} y

       Y2 {=} y

       Y_Velocity {=} Y_velocity

       Z {=} z

       Z1 {=} z

       Z2 {=} z

       Z_Velocity {=} Z_velocity

       Particle Definition {=} Definition

    end Insert Particle Particlename

### 7.8.9.1. Line Commands

###### Diameter

Syntax

  Diameter {=} Diameter

Summary

  Set initial diameter of particle(s)

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

###### Insertion Time

Syntax

  Insertion Time {=} InsertionTime

Summary

  Set time at which to insert particle; particle will be inserted at the first time step at or after this value.

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

###### Mass Represented

Syntax

  Mass Represented {=} Mass_represented

Summary

  Set mass of physical particles represented by each particle node.

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

###### Mass_Fraction

Syntax

  Mass_Fraction Species {=} y0

Summary

  Specification of mass fraction to be used for computing particle mass initial condition.

Parameter | Value | Default
--- | --- | ---
Species | string | –
{=} | {= | are | is} | –
y0 | real | –

###### Number

Syntax

  Number {=} Number

Summary

  Set number of particle nodes to insert. For a line insertion, this should be greater than 1, and points (x1,y1,z1) and (x2,y2,z2) should be input. This places a line of equally spaced particle nodes between the two points. If no second point is specified, all particles are placed at the same point. Note that if the NUMBER REPRESENTED command is used, the total number of physical particles equals NUMBER * NUMBER_REPRESENTED

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

###### Number Represented

Syntax

  Number Represented {=} Num_represented

Summary

  Set number of physical particles represented by each particle node.

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

###### Porosity

Syntax

  Porosity {=} Porosity

Summary

  Set initial porosity for particle(s).

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

###### Track Particles For Tabular Output

Syntax

  Track Particles For Tabular Output

Summary

  All particles of this description are added to the tabular output

Description

  Any particle matching this description will be output to the tabular data

###### Temperature

Syntax

  Temperature {=} Temperature

Summary

  Set initial temperature for particle(s).

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

###### X

Syntax

  X {=} x

Summary

  Set initial x position for particle(s).

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

###### X1

Syntax

  X1 {=} x

Summary

  Set x position for point 1 defining a line of particles.

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

###### X2

Syntax

  X2 {=} x

Summary

  Set x position for point 2 defining a line of particles.

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

###### X_Velocity

Syntax

  X_Velocity {=} X_velocity

Summary

  Set initial x velocity for particle(s).

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

###### Y

Syntax

  Y {=} y

Summary

  Set initial y position for particle(s).

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

###### Y1

Syntax

  Y1 {=} y

Summary

  Set y position for point 1 defining a line of particles.

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

###### Y2

Syntax

  Y2 {=} y

Summary

  Set y position for point 2 defining a line of particles.

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

###### Y_Velocity

Syntax

  Y_Velocity {=} Y_velocity

Summary

  Set initial y velocity for particle(s).

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

###### Z

Syntax

  Z {=} z

Summary

  Set initial z position for particle(s).

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

###### Z1

Syntax

  Z1 {=} z

Summary

  Set z position for point 1 defining a line of particles.

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

###### Z2

Syntax

  Z2 {=} z

Summary

  Set z position for point 2 defining a line of particles.

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

###### Z_Velocity

Syntax

  Z_Velocity {=} Z_velocity

Summary

  Set initial z velocity for particle(s).

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

###### Particle Definition

Syntax

  Particle Definition {=} Definition

Summary

  Set particle definition to be used for this block

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

## 7.8.10. Particle Average

Scope

  Particle Region

Summary

  Block that defines averaging over particles in each control volume cell.

    begin Particle Average AverageName

       Average Field ParticleField For Output As CellField

       Averaging Type {=} {mass | number | volume}

       Time Average Using Period TimePeriod

    end Particle Average AverageName

### 7.8.10.1. Line Commands

###### Average Field

Syntax

  Average Field ParticleField For Output As CellField

Summary

  Define averaging operation from a field defined onto the particles into another field available for output on the fluid mesh.

Parameter | Value | Default
--- | --- | ---
ParticleField | string | –
CellField | string | –

###### Averaging Type

Syntax

  Averaging Type {=} {mass | number | volume}

Summary

  Type of particle averaging to perform. Options are NUMBER, MASS, and VOLUME for number-weighted, mass-weighted, and volume weighted means.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
AverageType | {mass | number | volume} | –

###### Time Average Using Period

Syntax

  Time Average Using Period TimePeriod

Summary

  Average particle variables over time as well as volume, over specified time period.

Parameter | Value | Default
--- | --- | ---
TimePeriod | real | –

## 7.8.11. Particle Breakup Model

Scope

  Particle Region

Summary

  Block that defines a specific particle breakup model.

    begin Particle Breakup Model ModelName

       Breakup Model Type {=} {tab_model}

       Diameter Reduction Factor {=} Factor

       Limit New Particle Splitting

       Maximum Number Of Particles Per Parcel {=} Number

       Minimum Mass Per Parcel {=} Mass

       Particle Breakup Parameter VarName {=} Value...

    end Particle Breakup Model ModelName

### 7.8.11.1. Line Commands

###### Breakup Model Type

Syntax

  Breakup Model Type {=} {tab_model}

Summary

  Type of breakup model.

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

###### Diameter Reduction Factor

Syntax

  Diameter Reduction Factor {=} Factor

Summary

  Limit reduction of particle diameter by the specified value.

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

###### Limit New Particle Splitting

Syntax

  Limit New Particle Splitting

Summary

  If a particle has just been created on the previous step, limit breakup to splitting the particle in half.

###### Maximum Number Of Particles Per Parcel

Syntax

  Maximum Number Of Particles Per Parcel {=} Number

Summary

  After splitting, create new parcels if, and only if, number of particles in the parcel exceeds specified maximum. This may be superseded by a specified minimum mass.

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

###### Minimum Mass Per Parcel

Syntax

  Minimum Mass Per Parcel {=} Mass

Summary

  Limit creation of new parcels if parcel mass drops below the specified minimum.

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

###### Particle Breakup Parameter

Syntax

  Particle Breakup Parameter VarName {=} Value…

Summary

  Parameter for the particle breakup model.

Description

  The breakup model requires a number of user-defined parameters to be entered. An exception will be thrown if any of these required parameters are missing.

  The TAB_MODEL breakup model requires parameters PARTICLE_VISCOSITY and PARTICLE_SURFACE_TENSION.

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

## 7.8.12. Particle Definition

Scope

  Particle Region

Summary

  Block that defines a particle type, including all of its parameters. At least one of these blocks is necessary in every particle region

    begin Particle Definition Particlename

       Add Particle Interface InterfaceName

       Add Particle Material MaterialName

       Minimum_Diameter {=} MinimumDiameter

       Minimum_Mass {=} MinimumMass

       Particle Breakup Model {=} ModelName

       Particle Energy Equation {=} {chemically_reactive_energy_type | constant_particle_energy_type | heated_evaporating_energy_type | heated_particle_energy_type | wild_fire_energy_type}

       Particle Interaction Model {=} ModelName

       Particle Is Stationary

       Particle Type {=} {cpd_particle | evaporating_particle | fixed_heated_particle | fixed_particle | generalized_particle | heated_particle | inertial_particle | tracker | wildfire_particle}

       Particle Velocity Equation {=} {inertial_particle_velocity | tracker_particle_velocity}

       Use Particle Species {=} UseParticleSpecies...

       Use Species Material SpeciesMaterialName For SpeciesName

       begin General Chemistry ChemistryName
       end

       begin Ode Solver Parameters SolverName
       end

    end Particle Definition Particlename

### 7.8.12.1. Line Commands

###### Add Particle Interface

Syntax

  Add Particle Interface InterfaceName

Summary

  Add a particle interface to the particle definition

Parameter | Value | Default
--- | --- | ---
InterfaceName | string | –

###### Add Particle Material

Syntax

  Add Particle Material MaterialName

Summary

  Add a material component to the particle definition

Parameter | Value | Default
--- | --- | ---
MaterialName | string | –

###### Minimum_Diameter

Syntax

  Minimum_Diameter {=} MinimumDiameter

Summary

  Set the minimum diameter before deletion of the particle.

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

###### Minimum_Mass

Syntax

  Minimum_Mass {=} MinimumMass

Summary

  Set the minimum mass before deletion of the particle.

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

###### Particle Breakup Model

Syntax

  Particle Breakup Model {=} ModelName

Summary

  Set a breakup model on this particle type

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

###### Particle Energy Equation

Syntax

  Particle Energy Equation {=} {chemically_reactive_energy_type | constant_particle_energy_type | heated_evaporating_energy_type | heated_particle_energy_type | wild_fire_energy_type}

Summary

  Specify the particle energy type for this particle block.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
ParticleEnergyType | {chemically_reactive_energy_type | constant_particle_energy_type | heated_evaporating_energy_type | heated_particle_energy_type | wild_fire_energy_type} | –

###### Particle Interaction Model

Syntax

  Particle Interaction Model {=} ModelName

Summary

  Set an interaction model on this particle type

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

###### Particle Is Stationary

Syntax

  Particle Is Stationary

Summary

  Marks the particle as being stationary, ie. the particle remains at the same position for the lifetime of the simulation.

###### Particle Type

Syntax

  Particle Type {=} {cpd_particle | evaporating_particle | fixed_heated_particle | fixed_particle | generalized_particle | heated_particle | inertial_particle | tracker | wildfire_particle}

Summary

  Specify the particle type for this particle block.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
ParticleType | {cpd_particle | evaporating_particle | fixed_heated_particle | fixed_particle | generalized_particle | heated_particle | inertial_particle | tracker | wildfire_particle} | –

###### Particle Velocity Equation

Syntax

  Particle Velocity Equation {=} {inertial_particle_velocity | tracker_particle_velocity}

Summary

  Specify the particle velocity type for this particle block.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
ParticleVelocityType | {inertial_particle_velocity | tracker_particle_velocity} | –

###### Use Particle Species

Syntax

  Use Particle Species {=} UseParticleSpecies…

Summary

  Specifies the given particle species present within a particle.

  Note that the number of species in a particle is determined through the list of species given in the input file.

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

###### Use Species Material

Syntax

  Use Species Material SpeciesMaterialName For SpeciesName

Summary

  Assign a material type to a species specified in USE PARTICLE SPECIES

Description

  Allows for material types defined in BEGIN PARTICLE MATERIAL to be used as a specific species specified within the PARTICLE DEFINITION block.

Parameter | Value | Default
--- | --- | ---
SpeciesMaterialName | string | –
SpeciesName | string | –

## 7.8.13. Particle Filled Shape

Scope

  Particle Region

Summary

  Block that defines data for a particle filled shape.

    begin Particle Filled Shape FilledShapeName

       Diameter {=} Diameter

       Insertion Time {=} InsertionTime

       Mass Represented {=} Mass_represented

       Mass_Fraction Species {=} y0

       Number Represented {=} Num_represented

       Particle Diameter Distribution Parameter VarName {=} Value

       Particle Diameter Distribution Type {=} {constant | lognormal | normal | rosin_rammler | uniform}

       Particle Velocity Distribution Parameter VarName {=} Value

       Particle Velocity Distribution Type {=} {constant | lognormal | normal | rosin_rammler | uniform}

       Particle Shape Parameter VarName {=} Value...

       Particle Shape Type {=} {brick | cone | cylinder | sphere}

       Porosity {=} Porosity

       Track Particles For Tabular Output

       Temperature {=} Temperature

       X_Velocity {=} X_velocity

       Y_Velocity {=} Y_velocity

       Z_Velocity {=} Z_velocity

       Particle Definition {=} Definition

    end Particle Filled Shape FilledShapeName

### 7.8.13.1. Line Commands

###### Diameter

Syntax

  Diameter {=} Diameter

Summary

  Set initial diameter of particle(s)

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

###### Insertion Time

Syntax

  Insertion Time {=} InsertionTime

Summary

  Set time at which to insert particle; particle will be inserted at the first time step at or after this value.

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

###### Mass Represented

Syntax

  Mass Represented {=} Mass_represented

Summary

  Set mass of physical particles represented by each particle node.

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

###### Mass_Fraction

Syntax

  Mass_Fraction Species {=} y0

Summary

  Specification of mass fraction to be used for computing particle mass initial condition.

Parameter | Value | Default
--- | --- | ---
Species | string | –
{=} | {= | are | is} | –
y0 | real | –

###### Number Represented

Syntax

  Number Represented {=} Num_represented

Summary

  Set number of physical particles represented by each particle node.

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

###### Particle Diameter Distribution Parameter

Syntax

  Particle Diameter Distribution Parameter VarName {=} Value

Summary

  Parameter for the probability distribution function for particle diameters.

Description

  The number and type of parameters needed depends on the type of the probability distribution being used. The available distributions are described below.

  CONSTANT

  Required Parameters: VALUE

  Always returns a constant value

  UNIFORM

  Required Parameters: MIN, MAX

  Returns a random value uniformly distributed between the provided min and max values.

  NORMAL

  Required Parameters: MEAN, STDEV

  Optional Parameters: MIN, MAX

  Returns a random value normally distributed using the provided mean and standard deviation. If optional min or max values are provided then the PDF will be clipped to zero outside those bounds. The PDF for this distribution is:

  LOGNORMAL

  Required Parameters: MEAN and STDEV or LOGMEAN and LOGSTDEV or MEDIAN and SCATTER

  Optional Parameters: MIN, MAX

  Returns a random value with a log-normal distribution. If optional min or max values are provided then the PDF will be clipped to zero outside those bounds. The PDF for this distribution is:

  There are several ways to specify the parameters needed for this distribution ( and ). You can provide them directly (using LOGMEAN and LOGSTDEV), or you can provide non-log-scaled parameters and have them calculated.

  Keep in mind that unlike a normal distribution, the peak of a lognormal distribution (its mode) is not equal to its mean or median. For a log-normal distribution the mean is

  the median is

  and the mode (peak of the distribution) is

  If you provide a mean (, MEAN) and standard deviation (, STDEV), then the log-mean () and log-standard deviation () will be calculated using

  Alternately, if you provide a median (, MEDIAN) and scatter (, SCATTER), then log-mean () and log-standard deviation () will be calculated using

  The median and scatter physical interpretation is best understood by the fact that about two thirds of the distribution will lie between and . Similarly, 95 percent of the distribution will lie between and . As such, the value for (SCATTER) must be a value greater than one since it is a multiplier of the median.

  ROSIN_RAMMLER

  Required Parameters: X, Q

  Optional Parameters: MIN, MAX

  Returns a random value with a Rosin-Rammler (or Weibull) distribution. If optional min or max values are provided then the PDF will be clipped to zero outside those bounds. The PDF for this distribution is:

  The values provided for and must both be greater than zero.

Parameter | Value | Default
--- | --- | ---
VarName | string | –
{=} | {= | are | is} | –
Value | “string” | –

###### Particle Diameter Distribution Type

Syntax

  Particle Diameter Distribution Type {=} {constant | lognormal | normal | rosin_rammler | uniform}

Summary

  Probability distribution type for particle diameters

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
DistributionType | {constant | lognormal | normal | rosin_rammler | uniform} | CONSTANT

###### Particle Velocity Distribution Parameter

Syntax

  Particle Velocity Distribution Parameter VarName {=} Value

Summary

  Parameters for the probability distribution function for particle velocities.

Description

  The number and type of parameters needed depends on the type of the probability distribution being used. The arguments here are the same as those used for the diameter distribution, consult that section for relevant details.

Parameter | Value | Default
--- | --- | ---
VarName | string | –
{=} | {= | are | is} | –
Value | “string” | –

###### Particle Velocity Distribution Type

Syntax

  Particle Velocity Distribution Type {=} {constant | lognormal | normal | rosin_rammler | uniform}

Summary

  Probability distribution type for particle velocities

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
DistributionType | {constant | lognormal | normal | rosin_rammler | uniform} | CONSTANT

###### Particle Shape Parameter

Syntax

  Particle Shape Parameter VarName {=} Value…

Summary

  Parameter for the particle filled shape.

Description

  For each particle filled shape a particle definition and shape type must be specified. Also, particle diameter distribution type and its appropriate parameters must be specified.

  A correctly defined ParticleFilledShape must also meet prescribed parameters. The number and type of parameters needed depends on the type of the particle filled shape being employed.

  For all particle filled shapes, CENTER and NUMBER_OF_PARTICLES or PARTICLE_NUMBER_DENSITY parameters must be set. Additional parameters that must be set based on the shape are as follows:

      SPHERE   req. params RADIUS
      CYLINDER req. params RADIUS, HEIGHT, NORMAL
      BRICK    req. params DIMENSIONS, V1, V2
      CONE     req. params RADIUS, HEIGHT, NORMAL

           opt. param *VELOCITY_NORMAL

  Each parameter required should be entered in a separate command line.

  Extra notes:

  CYLINDER: For the cylinder, the center point is defined at the center of the circular base. The normal is a vector that points in the direction of the cylinders height.

  BRICK: For the brick, the center point is defined at the center of the rectangular base, which lies in the plane of V1 and V2 orthogonal vectors. The normal, constructed from the cross product of V1 and V2, points in the direction of the bricks height. Parameter DIMENSIONS specifies width, length and height (in that order). The width and length is defined along V1 and V2 vectors respectively.

  CONE: For the cone, the center point is defined at the center of the circular base. The normal is a vector that points in the direction of the cones height (tip).

  *VELOCITY_NORMAL is a parameter required when a Particle Velocity Distribution is specified. If particle velocity distribution is not specified, the magnitude of velocity of all particles within a shape is set to 0.

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

###### Particle Shape Type

Syntax

  Particle Shape Type {=} {brick | cone | cylinder | sphere}

Summary

  Particle filled shape type.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
ShapeType | {brick | cone | cylinder | sphere} | –

###### Porosity

Syntax

  Porosity {=} Porosity

Summary

  Set initial porosity for particle(s).

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

###### Track Particles For Tabular Output

Syntax

  Track Particles For Tabular Output

Summary

  All particles of this description are added to the tabular output

Description

  Any particle matching this description will be output to the tabular data

###### Temperature

Syntax

  Temperature {=} Temperature

Summary

  Set initial temperature for particle(s).

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

###### X_Velocity

Syntax

  X_Velocity {=} X_velocity

Summary

  Set initial x velocity for particle(s).

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

###### Y_Velocity

Syntax

  Y_Velocity {=} Y_velocity

Summary

  Set initial y velocity for particle(s).

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

###### Z_Velocity

Syntax

  Z_Velocity {=} Z_velocity

Summary

  Set initial z velocity for particle(s).

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

###### Particle Definition

Syntax

  Particle Definition {=} Definition

Summary

  Set particle definition to be used for this block

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

## 7.8.14. Particle Filled Tree

Scope

  Particle Region

Summary

  Block that defines data for a particle filled tree.

    begin Particle Filled Tree FilledTreeName

       Particle Tree Parameter VarName {=} Value...

       Particle Tree Type {=} {coniferous | deciduous | shrub}

       begin Crown Info Name
       end

       begin Trunk Info Name
       end

    end Particle Filled Tree FilledTreeName

### 7.8.14.1. Line Commands

###### Particle Tree Parameter

Syntax

  Particle Tree Parameter VarName {=} Value…

Summary

  Parameter for the particle filled tree.

Description

  ParticleFilledTree classes are added to support the following 3D particle filled tree shape categories: DECIDUOUS, CONIFEROUS, SHRUB.

  DECIDUOUS tree includes oak, maple, redwood. These types of trees are represented by a sphere, cone and cylinder shapes. Sphere represents the crown, cylinder represents the trunk and the cone represents trunk narrowing inside the crown defined between the bottom surface of the crown (sphere) where its basal radius is that of the trunk and its center.

  CONIFEROUS tree includes pine, cedar, spruce, fir. These types of trees are represented by two cones and cylinder shapes. The first cone represents the crown, cylinder represents the trunk and the second cone represents trunk narrowing inside the crown defined between the bottom surface of the crown (cone) where its basal radius is that of the trunk and its tip.

  SHRUB, also referred to as a woody plant, includes a broom. They are represented by a sphere and cone shapes. Sphere represents the crown and the cone represents trunk narrowing inside the crown between the bottom surface of the crown (sphere) and its center. Note, a SHRUB is a special case of a DECIDUOUS tree in which the trunk outside the crown is missing.

  A correctly defined ParticleFilledTree must meet prescribed parameters. The number and type of parameters needed depends on the type of the particle filled tree being employed.

  For all particle filled trees, the following must be set:

  - Particle Tree Type

  - Particle Crown Definition

  - Particle Trunk Definition

  For all particle filled trees, the following parameters must also be set:

      CENTER
      NORMAL
      CROWN_NUMBER_OF_PARTICLES
      CROWN_VOLUME_FRACTION
      CROWN_PARTICLE_DIAMETER_VARIATION
      TRUNK_PARTICLE_DIAMETER_VARIATION
          TRUNK_NUMBER_OF_PARTICLES
          TRUNK_VOLUME_FRACTION
          CROWN_RADIUS
          TRUNK_RADIUS

  Additional parameters that must be set based on the tree are as follows:

      DECIDUOUS  req. params CROWN_BASE_HEIGHT
      CONIFEROUS req. params TREE_HEIGHT, CROWN_BASE_HEIGHT

  Each parameter required should be entered in a separate command line.

  Extra notes:

       DECIDUOUS         CONIFEROUS
         --                  /\
       /    \               /  \
      [  /\  ]             /    \
       \_||_/ _ _         /  /\  \              SHRUB
         ||    | x       /  /  \  \              --
         ||    |        /___|  |___\  _ _      /    \
         ||    |            |  |       | x    [  /\  ]
         ||   _|_           |__|      _|_      \_||_/

      CENTER is a center point defined at the base of the trunk.
      NORMAL is a vector perpendicular to the base of the trunk.
      TREE_HEIGHT is the distance defined between the ground and the
          top of the tree crown.
      CROWN_BASE_HEIGHT is the distance between the ground and the base
                of the tree crown (or 'x' in the above schematic).
      CROWN_VOLUME_FRACTION, or porosity for a porous medium, is a percent
                 number provided between 0 and 1 that describes
                 constituent material based on the whole volume.
                             For a spherical fuel element, this value should
                             never be larger than a sixth of pi.
      CROWN_PARTICLE_DIAMETER_VARIATION is a percent number provided between
                        0 and 1 that describes particle
                        diameter variation. Within the range,
                        random particle diameters are selected,
                        which are based on the number of
                        particles and volume fraction params.
      TRUNK_PARTICLE_DIAMETER_VARIATION (see above)
      TRUNK_VOLUME_FRACTION (see above)

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

###### Particle Tree Type

Syntax

  Particle Tree Type {=} {coniferous | deciduous | shrub}

Summary

  Particle filled tree type. Supported tree types include DECIDUOUS, CONIFEROUS and SHRUB.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
TreeType | {coniferous | deciduous | shrub} | –

## 7.8.15. Crown Info

Scope

  Particle Filled Tree

Summary

  Block that defines data for a tree crown.

    begin Crown Info Name

       Diameter {=} Diameter

       Insertion Time {=} InsertionTime

       Mass Represented {=} Mass_represented

       Mass_Fraction Species {=} y0

       Number Represented {=} Num_represented

       Porosity {=} Porosity

       Track Particles For Tabular Output

       Temperature {=} Temperature

       X_Velocity {=} X_velocity

       Y_Velocity {=} Y_velocity

       Z_Velocity {=} Z_velocity

       Particle Definition {=} Definition

    end Crown Info Name

### 7.8.15.1. Line Commands

###### Diameter

Syntax

  Diameter {=} Diameter

Summary

  Set initial diameter of particle(s)

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

###### Insertion Time

Syntax

  Insertion Time {=} InsertionTime

Summary

  Set time at which to insert particle; particle will be inserted at the first time step at or after this value.

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

###### Mass Represented

Syntax

  Mass Represented {=} Mass_represented

Summary

  Set mass of physical particles represented by each particle node.

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

###### Mass_Fraction

Syntax

  Mass_Fraction Species {=} y0

Summary

  Specification of mass fraction to be used for computing particle mass initial condition.

Parameter | Value | Default
--- | --- | ---
Species | string | –
{=} | {= | are | is} | –
y0 | real | –

###### Number Represented

Syntax

  Number Represented {=} Num_represented

Summary

  Set number of physical particles represented by each particle node.

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

###### Porosity

Syntax

  Porosity {=} Porosity

Summary

  Set initial porosity for particle(s).

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

###### Track Particles For Tabular Output

Syntax

  Track Particles For Tabular Output

Summary

  All particles of this description are added to the tabular output

Description

  Any particle matching this description will be output to the tabular data

###### Temperature

Syntax

  Temperature {=} Temperature

Summary

  Set initial temperature for particle(s).

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

###### X_Velocity

Syntax

  X_Velocity {=} X_velocity

Summary

  Set initial x velocity for particle(s).

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

###### Y_Velocity

Syntax

  Y_Velocity {=} Y_velocity

Summary

  Set initial y velocity for particle(s).

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

###### Z_Velocity

Syntax

  Z_Velocity {=} Z_velocity

Summary

  Set initial z velocity for particle(s).

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

###### Particle Definition

Syntax

  Particle Definition {=} Definition

Summary

  Set particle definition to be used for this block

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

## 7.8.16. Trunk Info

Scope

  Particle Filled Tree

Summary

  Block that defines data for a tree trunk.

    begin Trunk Info Name

       Diameter {=} Diameter

       Insertion Time {=} InsertionTime

       Mass Represented {=} Mass_represented

       Mass_Fraction Species {=} y0

       Number Represented {=} Num_represented

       Porosity {=} Porosity

       Track Particles For Tabular Output

       Temperature {=} Temperature

       X_Velocity {=} X_velocity

       Y_Velocity {=} Y_velocity

       Z_Velocity {=} Z_velocity

       Particle Definition {=} Definition

    end Trunk Info Name

### 7.8.16.1. Line Commands

###### Diameter

Syntax

  Diameter {=} Diameter

Summary

  Set initial diameter of particle(s)

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

###### Insertion Time

Syntax

  Insertion Time {=} InsertionTime

Summary

  Set time at which to insert particle; particle will be inserted at the first time step at or after this value.

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

###### Mass Represented

Syntax

  Mass Represented {=} Mass_represented

Summary

  Set mass of physical particles represented by each particle node.

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

###### Mass_Fraction

Syntax

  Mass_Fraction Species {=} y0

Summary

  Specification of mass fraction to be used for computing particle mass initial condition.

Parameter | Value | Default
--- | --- | ---
Species | string | –
{=} | {= | are | is} | –
y0 | real | –

###### Number Represented

Syntax

  Number Represented {=} Num_represented

Summary

  Set number of physical particles represented by each particle node.

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

###### Porosity

Syntax

  Porosity {=} Porosity

Summary

  Set initial porosity for particle(s).

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

###### Track Particles For Tabular Output

Syntax

  Track Particles For Tabular Output

Summary

  All particles of this description are added to the tabular output

Description

  Any particle matching this description will be output to the tabular data

###### Temperature

Syntax

  Temperature {=} Temperature

Summary

  Set initial temperature for particle(s).

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

###### X_Velocity

Syntax

  X_Velocity {=} X_velocity

Summary

  Set initial x velocity for particle(s).

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

###### Y_Velocity

Syntax

  Y_Velocity {=} Y_velocity

Summary

  Set initial y velocity for particle(s).

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

###### Z_Velocity

Syntax

  Z_Velocity {=} Z_velocity

Summary

  Set initial z velocity for particle(s).

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

###### Particle Definition

Syntax

  Particle Definition {=} Definition

Summary

  Set particle definition to be used for this block

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

## 7.8.17. Particle Inflow Boundary Condition On Surface

Scope

  Particle Region

Summary

  Defines a boundary condition for particle inflow on a named surface of the mesh.

    begin Particle Inflow Boundary Condition On Surface Surfacename

       Diameter {=} Diameter

       Insertion Time {=} InsertionTime

       Mass Represented {=} Mass_represented

       Mass_Fraction Species {=} y0

       Number Represented {=} Num_represented

       Porosity {=} Porosity

       Track Particles For Tabular Output

       Temperature {=} Temperature

       X_Velocity {=} X_velocity

       Y_Velocity {=} Y_velocity

       Z_Velocity {=} Z_velocity

       Particle Definition {=} Definition

    end Particle Inflow Boundary Condition On Surface Surfacename

### 7.8.17.1. Line Commands

###### Diameter

Syntax

  Diameter {=} Diameter

Summary

  Set initial diameter of particle(s)

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

###### Insertion Time

Syntax

  Insertion Time {=} InsertionTime

Summary

  Set time at which to insert particle; particle will be inserted at the first time step at or after this value.

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

###### Mass Represented

Syntax

  Mass Represented {=} Mass_represented

Summary

  Set mass of physical particles represented by each particle node.

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

###### Mass_Fraction

Syntax

  Mass_Fraction Species {=} y0

Summary

  Specification of mass fraction to be used for computing particle mass initial condition.

Parameter | Value | Default
--- | --- | ---
Species | string | –
{=} | {= | are | is} | –
y0 | real | –

###### Number Represented

Syntax

  Number Represented {=} Num_represented

Summary

  Set number of physical particles represented by each particle node.

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

###### Porosity

Syntax

  Porosity {=} Porosity

Summary

  Set initial porosity for particle(s).

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

###### Track Particles For Tabular Output

Syntax

  Track Particles For Tabular Output

Summary

  All particles of this description are added to the tabular output

Description

  Any particle matching this description will be output to the tabular data

###### Temperature

Syntax

  Temperature {=} Temperature

Summary

  Set initial temperature for particle(s).

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

###### X_Velocity

Syntax

  X_Velocity {=} X_velocity

Summary

  Set initial x velocity for particle(s).

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

###### Y_Velocity

Syntax

  Y_Velocity {=} Y_velocity

Summary

  Set initial y velocity for particle(s).

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

###### Z_Velocity

Syntax

  Z_Velocity {=} Z_velocity

Summary

  Set initial z velocity for particle(s).

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

###### Particle Definition

Syntax

  Particle Definition {=} Definition

Summary

  Set particle definition to be used for this block

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

## 7.8.18. Particle Interface

Scope

  Particle Region

Summary

  Block that defines a specific particle-fluid interaction (e.g. reaction or evaporation)

    begin Particle Interface InterfaceName

        {critical_porosity | critical_temperature | flame_temperature_for_transport | fuel_molecular_weight | heat_of_combustion | mass_diffusivity | prandtl_number | reference_heat_of_vaporization | reference_pressure | reference_temperature | schmidt_number | thermal_diffusivity | universal_gas_constant} {=} Value

       Particle Species SpeciesName StoichCoef

       Reaction Rate Parameter Name {=} RateParam

       begin Particle Evaporation EvaporationName
       end

       begin Particle Reaction ReactionName
       end

    end Particle Interface InterfaceName

### 7.8.18.1. Line Commands

###### Particleinterfaceparameter

Syntax

  Particleinterfaceparameter {critical_porosity | critical_temperature | flame_temperature_for_transport | fuel_molecular_weight | heat_of_combustion | mass_diffusivity | prandtl_number | reference_heat_of_vaporization | reference_pressure | reference_temperature | schmidt_number | thermal_diffusivity | universal_gas_constant} {=} Value

Summary

  Constant value for the specified parameter (in consistent units).

Parameter | Value | Default
--- | --- | ---
ParticleInterfaceParameter | {critical_porosity | critical_temperature | flame_temperature_for_transport | fuel_molecular_weight | heat_of_combustion | mass_diffusivity | prandtl_number | reference_heat_of_vaporization | reference_pressure | reference_temperature | schmidt_number | thermal_diffusivity | universal_gas_constant} | –
{=} | {= | are | is} | –
Value | real | –

###### Particle Species

Syntax

  Particle Species SpeciesName StoichCoef

Summary

  Particle species name and stoichiometric coefficient for this interface.

Parameter | Value | Default
--- | --- | ---
SpeciesName | string | –
StoichCoef | real | –

###### Reaction Rate Parameter

Syntax

  Reaction Rate Parameter Name {=} RateParam

Summary

  Specification of reaction rate parameters, E, A, latent heat.

Description

  Specification of reaction rate parameters, E, A, latent heat. Note that activation energies should be in per-mole units (e.g. kJ/mol or erg/mol, where energy units are consistent with the rest of the input file)

Parameter | Value | Default
--- | --- | ---
Name | string | –
{=} | {= | are | is} | –
RateParam | real | –

## 7.8.19. Particle Evaporation

Scope

  Particle Interface

Summary

  Sub-block that defines a specific particle evaporation. Maximum one per interface.

    begin Particle Evaporation EvaporationName

        {critical_porosity | critical_temperature | flame_temperature_for_transport | fuel_molecular_weight | heat_of_combustion | mass_diffusivity | prandtl_number | reference_heat_of_vaporization | reference_pressure | reference_temperature | schmidt_number | thermal_diffusivity | universal_gas_constant} {=} Value

       Gas Species SpeciesName StoichCoef

    end Particle Evaporation EvaporationName

### 7.8.19.1. Line Commands

###### Particleinterfaceparameter

Syntax

  Particleinterfaceparameter {critical_porosity | critical_temperature | flame_temperature_for_transport | fuel_molecular_weight | heat_of_combustion | mass_diffusivity | prandtl_number | reference_heat_of_vaporization | reference_pressure | reference_temperature | schmidt_number | thermal_diffusivity | universal_gas_constant} {=} Value

Summary

  Constant value for the specified parameter (in consistent units).

Parameter | Value | Default
--- | --- | ---
ParticleInterfaceParameter | {critical_porosity | critical_temperature | flame_temperature_for_transport | fuel_molecular_weight | heat_of_combustion | mass_diffusivity | prandtl_number | reference_heat_of_vaporization | reference_pressure | reference_temperature | schmidt_number | thermal_diffusivity | universal_gas_constant} | –
{=} | {= | are | is} | –
Value | real | –

###### Gas Species

Syntax

  Gas Species SpeciesName StoichCoef

Summary

  GAS species name and stoichiometric coefficient for this interface.

Parameter | Value | Default
--- | --- | ---
SpeciesName | string | –
StoichCoef | real | –

## 7.8.20. Particle Reaction

Scope

  Particle Interface

Summary

  Sub-block that defines a specific particle reaction.

    begin Particle Reaction ReactionName

        {critical_porosity | critical_temperature | flame_temperature_for_transport | fuel_molecular_weight | heat_of_combustion | mass_diffusivity | prandtl_number | reference_heat_of_vaporization | reference_pressure | reference_temperature | schmidt_number | thermal_diffusivity | universal_gas_constant} {=} Value

       Gas Species SpeciesName StoichCoef

       Oxidizer {=} SpeciesName

       Water {=} SpeciesName

    end Particle Reaction ReactionName

### 7.8.20.1. Line Commands

###### Particleinterfaceparameter

Syntax

  Particleinterfaceparameter {critical_porosity | critical_temperature | flame_temperature_for_transport | fuel_molecular_weight | heat_of_combustion | mass_diffusivity | prandtl_number | reference_heat_of_vaporization | reference_pressure | reference_temperature | schmidt_number | thermal_diffusivity | universal_gas_constant} {=} Value

Summary

  Constant value for the specified parameter (in consistent units).

Parameter | Value | Default
--- | --- | ---
ParticleInterfaceParameter | {critical_porosity | critical_temperature | flame_temperature_for_transport | fuel_molecular_weight | heat_of_combustion | mass_diffusivity | prandtl_number | reference_heat_of_vaporization | reference_pressure | reference_temperature | schmidt_number | thermal_diffusivity | universal_gas_constant} | –
{=} | {= | are | is} | –
Value | real | –

###### Gas Species

Syntax

  Gas Species SpeciesName StoichCoef

Summary

  GAS species name and stoichiometric coefficient for this interface.

Parameter | Value | Default
--- | --- | ---
SpeciesName | string | –
StoichCoef | real | –

###### Oxidizer

Syntax

  Oxidizer {=} SpeciesName

Summary

  Oxidizer species name for this interface (may be more than one).

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

###### Water

Syntax

  Water {=} SpeciesName

Summary

  Water species name for this interface.

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

## 7.8.21. Particle Material

Scope

  Particle Region

Summary

  Block that defines material property data for a particle component

    begin Particle Material MaterialName

        {absorptivity | density | emission_multiplier | emissivity | enthalpy_of_fusion | film_prandtl_number | freezing_temperature | molecular_weight | specific_heat | surface_tension | thermal_conductivity | viscosity} {=} EvalFunction...

    end Particle Material MaterialName

### 7.8.21.1. Line Commands

###### Particlematerialproperty

Syntax

  Particlematerialproperty {absorptivity | density | emission_multiplier | emissivity | enthalpy_of_fusion | film_prandtl_number | freezing_temperature | molecular_weight | specific_heat | surface_tension | thermal_conductivity | viscosity} {=} EvalFunction…

Summary

  Constant/temperature dependent value for the specified property (in consistent units). The string entered can be a constant, or a function of time which will be evaluated using the stk expression evaluator. You must use ‘T’ as the temperature variable in this function.

Parameter | Value | Default
--- | --- | ---
ParticleMaterialProperty | {absorptivity | density | emission_multiplier | emissivity | enthalpy_of_fusion | film_prandtl_number | freezing_temperature | molecular_weight | specific_heat | surface_tension | thermal_conductivity | viscosity} | –
{=} | {= | are | is} | –
EvalFunction | “string”… | 0.0

## 7.8.22. Particle Open Boundary Condition On Surface

Scope

  Particle Region

Summary

  Defines an open boundary condition and its interaction with particles.

    begin Particle Open Boundary Condition On Surface Surfacename

    end Particle Open Boundary Condition On Surface Surfacename

## 7.8.23. Particle Spray

Scope

  Particle Region

Summary

  Block that defines data for a nozzle inflow.

    begin Particle Spray SprayName

       Arc_Angle {=} ArcAngle

       Arc_Ref {=} nRef1 nRef2 nRef3

       Center {=} Xcenter1 Xcenter2 Xcenter3

       Diameter Number Represented Vector {=} diamnumrepvec...

       Diameter {=} Diameter

       Insertion Time {=} InsertionTime

       Length Vector {=} LengthVector1 LengthVector2 LengthVector3

       Length {=} Length

       Mass Represented {=} Mass_represented

       Mass_Flow_Rate {=} Mdot

       Mass_Fraction Species {=} y0

       Normal Vector {=} NormalVector1 NormalVector2 NormalVector3

       Nozzle Radius {=} Radius

       Number Representative Points {=} NumRepPoints

       Number Represented Vector {=} numrepvec...

       Number Represented {=} Num_represented

       Particle Average_Diameter {=} Velocity

       Particle Average_Velocity {=} Velocity

       Particle Diameter Distribution Parameter VarName {=} Value

       Particle Diameter Distribution Type {=} {constant | lognormal | normal | rosin_rammler | uniform}

       Particle Log File {=} FieldName

       Particle Velocity Distribution Parameter VarName {=} Value

       Particle Velocity Distribution Type {=} {constant | lognormal | normal | rosin_rammler | uniform}

       Porosity {=} Porosity

       Spray_Angle {=} Angle

       Spray_Angle_End {=} Angle

       Spray_Angle_Start {=} Angle

       Track Particles For Tabular Output

       Temperature {=} Temperature

       Width {=} Width

       X_Velocity {=} X_velocity

       Y_Velocity {=} Y_velocity

       Z_Velocity {=} Z_velocity

       Diameter Cutoff High {=} diamcutoffhigh

       Diameter Cutoff Low {=} diamcutofflow

       Particle Definition {=} Definition

    end Particle Spray SprayName

### 7.8.23.1. Line Commands

###### Arc_Angle

Syntax

  Arc_Angle {=} ArcAngle

Summary

  Angle (in degrees) for circular wedge shaped spray

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

###### Arc_Ref

Syntax

  Arc_Ref {=} nRef1 nRef2 nRef3

Summary

  Reference vector within spray plane to measure angle from for circular wedge shaped spray

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
nRef | real1 real2 real3 | –

###### Center

Syntax

  Center {=} Xcenter1 Xcenter2 Xcenter3

Summary

  (x,y,z) coordinates of center of spray nozzle plane

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Xcenter | real1 real2 real3 | –

###### Diameter Number Represented Vector

Syntax

  Diameter Number Represented Vector {=} diamnumrepvec…

Summary

  Vector of diameters for function relating diameter of particle to number represented for fine control over number represented distributions

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

###### Diameter

Syntax

  Diameter {=} Diameter

Summary

  Set initial diameter of particle(s)

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

###### Insertion Time

Syntax

  Insertion Time {=} InsertionTime

Summary

  Set time at which to insert particle; particle will be inserted at the first time step at or after this value.

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

###### Length Vector

Syntax

  Length Vector {=} LengthVector1 LengthVector2 LengthVector3

Summary

  Components (lx,ly,lz) of vector in the plane of the spray nozzle.

Description

  This vector is necessary for a rectangular spray nozzle to define the direction in which the LENGTH parameter is measured. This vector must be orthogonal to the spray normal direction. A third vector defining the direction for the WIDTH parameter is computed internally to be orthogonal to both the NORMAL and LENGTH vectors.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
LengthVector | real1 real2 real3 | –

###### Length

Syntax

  Length {=} Length

Summary

  Length of rectangular spray nozzle.

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

###### Mass Represented

Syntax

  Mass Represented {=} Mass_represented

Summary

  Set mass of physical particles represented by each particle node.

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

###### Mass_Flow_Rate

Syntax

  Mass_Flow_Rate {=} Mdot

Summary

  Mass flow rate of particles through the spray nozzle. The string entered can be a constant, or a function of time which will be evaluated using the stk expression evaluator. You must use ‘t’ as the time variable in this function.

  If the function contains commas or spaces it should be enclosed in quotes (e.g. “max(t,1)”)

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Mdot | “string” | 0.0

###### Mass_Fraction

Syntax

  Mass_Fraction Species {=} y0

Summary

  Specification of mass fraction to be used for computing particle mass initial condition.

Parameter | Value | Default
--- | --- | ---
Species | string | –
{=} | {= | are | is} | –
y0 | real | –

###### Normal Vector

Syntax

  Normal Vector {=} NormalVector1 NormalVector2 NormalVector3

Summary

  Components (nx,ny,nz) of vector normal to spray nozzle plane

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
NormalVector | real1 real2 real3 | –

###### Nozzle Radius

Syntax

  Nozzle Radius {=} Radius

Summary

  Radius of circular spray nozzle

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

###### Number Representative Points

Syntax

  Number Representative Points {=} NumRepPoints

Summary

  Number of possible insertion points used to represent this spray.

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

###### Number Represented Vector

Syntax

  Number Represented Vector {=} numrepvec…

Summary

  Vector of number represented for function relating diameter of particle to number represented for fine control over number represented distribution

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

###### Number Represented

Syntax

  Number Represented {=} Num_represented

Summary

  Set number of physical particles represented by each particle node.

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

###### Particle Average_Diameter

Syntax

  Particle Average_Diameter {=} Velocity

Summary

  DEPRECATED: Mean diameter of particles entering through spray nozzle.

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

###### Particle Average_Velocity

Syntax

  Particle Average_Velocity {=} Velocity

Summary

  DEPRECATED: Mean velocity of particles entering through spray nozzle.

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

###### Particle Diameter Distribution Parameter

Syntax

  Particle Diameter Distribution Parameter VarName {=} Value

Summary

  Parameter for the probability distribution function for particle diameters.

Description

  The number and type of parameters needed depends on the type of the probability distribution being used. The available distributions are described below.

  CONSTANT

  Required Parameters: VALUE

  Always returns a constant value

  UNIFORM

  Required Parameters: MIN, MAX

  Returns a random value uniformly distributed between the provided min and max values.

  NORMAL

  Required Parameters: MEAN, STDEV

  Optional Parameters: MIN, MAX

  Returns a random value normally distributed using the provided mean and standard deviation. If optional min or max values are provided then the PDF will be clipped to zero outside those bounds. The PDF for this distribution is:

  LOGNORMAL

  Required Parameters: MEAN and STDEV or LOGMEAN and LOGSTDEV or MEDIAN and SCATTER

  Optional Parameters: MIN, MAX

  Returns a random value with a log-normal distribution. If optional min or max values are provided then the PDF will be clipped to zero outside those bounds. The PDF for this distribution is:

  There are several ways to specify the parameters needed for this distribution ( and ). You can provide them directly (using LOGMEAN and LOGSTDEV), or you can provide non-log-scaled parameters and have them calculated.

  Keep in mind that unlike a normal distribution, the peak of a lognormal distribution (its mode) is not equal to its mean or median. For a log-normal distribution the mean is

  the median is

  and the mode (peak of the distribution) is

  If you provide a mean (, MEAN) and standard deviation (, STDEV), then the log-mean () and log-standard deviation () will be calculated using

  Alternately, if you provide a median (, MEDIAN) and scatter (, SCATTER), then log-mean () and log-standard deviation () will be calculated using

  The median and scatter physical interpretation is best understood by the fact that about two thirds of the distribution will lie between and . Similarly, 95 percent of the distribution will lie between and . As such, the value for (SCATTER) must be a value greater than one since it is a multiplier of the median.

  ROSIN_RAMMLER

  Required Parameters: X, Q

  Optional Parameters: MIN, MAX

  Returns a random value with a Rosin-Rammler (or Weibull) distribution. If optional min or max values are provided then the PDF will be clipped to zero outside those bounds. The PDF for this distribution is:

  The values provided for and must both be greater than zero.

Parameter | Value | Default
--- | --- | ---
VarName | string | –
{=} | {= | are | is} | –
Value | “string” | –

###### Particle Diameter Distribution Type

Syntax

  Particle Diameter Distribution Type {=} {constant | lognormal | normal | rosin_rammler | uniform}

Summary

  Probability distribution type for particle diameters

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
DistributionType | {constant | lognormal | normal | rosin_rammler | uniform} | CONSTANT

###### Particle Log File

Syntax

  Particle Log File {=} FieldName

Summary

  Activates output to a file of a log of inserted particle nodes, including time injected, number represented, particle diameter, and particle mass

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

###### Particle Velocity Distribution Parameter

Syntax

  Particle Velocity Distribution Parameter VarName {=} Value

Summary

  Parameters for the probability distribution function for particle velocities.

Description

  The number and type of parameters needed depends on the type of the probability distribution being used. The arguments here are the same as those used for the diameter distribution, consult that section for relevant details.

Parameter | Value | Default
--- | --- | ---
VarName | string | –
{=} | {= | are | is} | –
Value | “string” | –

###### Particle Velocity Distribution Type

Syntax

  Particle Velocity Distribution Type {=} {constant | lognormal | normal | rosin_rammler | uniform}

Summary

  Probability distribution type for particle velocities

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
DistributionType | {constant | lognormal | normal | rosin_rammler | uniform} | CONSTANT

###### Porosity

Syntax

  Porosity {=} Porosity

Summary

  Set initial porosity for particle(s).

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

###### Spray_Angle

Syntax

  Spray_Angle {=} Angle

Summary

  Maximum spray angle (degrees)

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

###### Spray_Angle_End

Syntax

  Spray_Angle_End {=} Angle

Summary

  Maximum spray angle (degrees)

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

###### Spray_Angle_Start

Syntax

  Spray_Angle_Start {=} Angle

Summary

  Minimum spray angle (degrees); if >0 results in a hollow cone spray.

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

###### Track Particles For Tabular Output

Syntax

  Track Particles For Tabular Output

Summary

  All particles of this description are added to the tabular output

Description

  Any particle matching this description will be output to the tabular data

###### Temperature

Syntax

  Temperature {=} Temperature

Summary

  Set initial temperature for particle(s).

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

###### Width

Syntax

  Width {=} Width

Summary

  Width of rectangular spray nozzle.

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

###### X_Velocity

Syntax

  X_Velocity {=} X_velocity

Summary

  Set initial x velocity for particle(s).

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

###### Y_Velocity

Syntax

  Y_Velocity {=} Y_velocity

Summary

  Set initial y velocity for particle(s).

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

###### Z_Velocity

Syntax

  Z_Velocity {=} Z_velocity

Summary

  Set initial z velocity for particle(s).

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

###### Diameter Cutoff High

Syntax

  Diameter Cutoff High {=} diamcutoffhigh

Summary

  Upper Cutoff for particle Diameters.

  This command is DEPRECATED. Use the MAX parameter for the diameter distribution instead.

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

###### Diameter Cutoff Low

Syntax

  Diameter Cutoff Low {=} diamcutofflow

Summary

  Lower Cutoff for particle Diameters.

  This command is DEPRECATED. Use the MIN parameter for the diameter distribution instead.

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

###### Particle Definition

Syntax

  Particle Definition {=} Definition

Summary

  Set particle definition to be used for this block

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

## 7.8.24. Particle Tabular Output

Scope

  Particle Region

Summary

  Block that creates and defines options for tabular output of particle data.

Description

  Particle data is output in tabulated columns, with one file per particle containing the time history of that particle, and one variable per column. Only particles inserted from an insertion source marked with the `TRACK PARTICLES FOR TABULAR OUTPUT` command line are tracked. IDs are assigned automatically using a hash code.

    begin Particle Tabular Output Name

       Filename Prefix {=} FilenamePrefix

       Output Variable VariableName [ Component Comp  ]

    end Particle Tabular Output Name

### 7.8.24.1. Line Commands

###### Filename Prefix

Syntax

  Filename Prefix {=} FilenamePrefix

Summary

  Set filename prefix for output files.

Description

  File names will be created for data output files by concatenating the prefix with the particle ID number, followed by the .dat extension, e.g. `particle_data_1.dat`.

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

###### Output Variable

Syntax

  Output Variable VariableName [ Component Comp ]

Summary

  Designate a nodal particle variable for output.

Parameter | Value | Default
--- | --- | ---
VariableName | string | –

## 7.8.25. Particle Wall Boundary Condition On Surface

Scope

  Particle Region

Summary

  Defines a wall boundary condition and its interaction with particles.

    begin Particle Wall Boundary Condition On Surface Surfacename

       Adhesion Model {=} particle_adhesion_model...

       Particle Surface Interaction Type {=} {combined | pass_through | rebound | shatter | stick | undefined}

       Reflection Model {=} particle_reflection_model...

       Particle_K_Pf_Crit {=} particle_K_PF_crit

       Particle_Contact_Angle {=} particle_contact_angle

       Particle_Maximum_Number_Fingers {=} particle_maximum_number_fingers

       Particle_Random_Graze_Angle_Maximum {=} particle_random_graze_angle_maximum

       Particle_Random_Graze_Angle_Minimum {=} particle_random_graze_angle_minimum

       Particle_Splash_Parameter_A {=} particle_splash_parameter_A

       Particle_Splash_Parameter_B {=} particle_splash_parameter_B

    end Particle Wall Boundary Condition On Surface Surfacename

### 7.8.25.1. Line Commands

###### Adhesion Model

Syntax

  Adhesion Model {=} particle_adhesion_model…

Summary

  Specifies the adhesion model to use with the combined surface interaction model. Options are “RESUSPEND_WICHNER”, “STICK”, or “NONE”.

  Each of these options is be followed by a list of arguments specific to that model. For details on the available options, refer to the particle section in the Math Models chapter of the user manual.

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

###### Particle Surface Interaction Type

Syntax

  Particle Surface Interaction Type {=} {combined | pass_through | rebound | shatter | stick | undefined}

Summary

  Type of interaction between particles and surface. Use “COMBINED” to specify separate reflection and adhesion models. All other options are DEPRECATED and are internally replaced with the equivalent “COMBINED” model.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
SurfaceInteractionType | {combined | pass_through | rebound | shatter | stick | undefined} | –

###### Reflection Model

Syntax

  Reflection Model {=} particle_reflection_model…

Summary

  Specifies the reflection model to use with the combined surface interaction model. Options are “SHATTER_BROWN”, “REBOUND”, “REBOUND_YOON”, or “NONE”.

  Each of these options is be followed by a list of arguments specific to that model. For example, the shatter model would be “REFLECTION MODEL = SHATTER_BROWN K_crit = 58 contact_angle = 45”.

  For details on the other options, refer to the particle section in the Math Models chapter of the user manual.

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

###### Particle_K_Pf_Crit

Syntax

  Particle_K_Pf_Crit {=} particle_K_PF_crit

Summary

  THIS INPUT FORMAT IS DEPRECATED. USE THE “REFLECTION MODEL” and “ADHESION MODEL” FORMAT.

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

###### Particle_Contact_Angle

Syntax

  Particle_Contact_Angle {=} particle_contact_angle

Summary

  THIS INPUT FORMAT IS DEPRECATED. USE THE “REFLECTION MODEL” and “ADHESION MODEL” FORMAT.

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

###### Particle_Maximum_Number_Fingers

Syntax

  Particle_Maximum_Number_Fingers {=} particle_maximum_number_fingers

Summary

  THIS INPUT FORMAT IS DEPRECATED. USE THE “REFLECTION MODEL” and “ADHESION MODEL” FORMAT.

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

###### Particle_Random_Graze_Angle_Maximum

Syntax

  Particle_Random_Graze_Angle_Maximum {=} particle_random_graze_angle_maximum

Summary

  THIS INPUT FORMAT IS DEPRECATED. USE THE “REFLECTION MODEL” and “ADHESION MODEL” FORMAT.

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

###### Particle_Random_Graze_Angle_Minimum

Syntax

  Particle_Random_Graze_Angle_Minimum {=} particle_random_graze_angle_minimum

Summary

  THIS INPUT FORMAT IS DEPRECATED. USE THE “REFLECTION MODEL” and “ADHESION MODEL” FORMAT.

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

###### Particle_Splash_Parameter_A

Syntax

  Particle_Splash_Parameter_A {=} particle_splash_parameter_A

Summary

  THIS INPUT FORMAT IS DEPRECATED. USE THE “REFLECTION MODEL” and “ADHESION MODEL” FORMAT.

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

###### Particle_Splash_Parameter_B

Syntax

  Particle_Splash_Parameter_B {=} particle_splash_parameter_B

Summary

  THIS INPUT FORMAT IS DEPRECATED. USE THE “REFLECTION MODEL” and “ADHESION MODEL” FORMAT.

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

## 7.8.26. Restart Data

Scope

  Average Region, Fuego Region, Input_Output Region, Particle Region

Summary

  Describes the data required to output and input restart data for the enclosing region.

    begin Restart Data Label

       Additional Steps {=} List_of_steps...

       Additional Times {=} List_of_times...

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

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

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

       Component Separator Character {=} Separator

       Cycle Count {=} Count

       Database Name {=} StreamName

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

       Debug Dump

       Decomposition Method {=} {block | cyclic | external | geom_kway | hsfc | kway | kway_geom | linear | map | metis_sfc | random | rcb | rib | variable}

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

       File Cycle Count {=} Count

       Flush Interval {=} Option

       Input Database Name {=} StreamName

       Optional

       Output Database Name {=} StreamName

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

       Output Restart State {=} {off | on}

       Overlay Count {=} Count

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

       Property PropertyName {=} PropertyValue

       Restart {=} {auto}

       Restart Time {=} Time

       Start Time {=} Start_time

       Synchronize Output

       Shift To Start Time

       Termination Time {=} Final_time

       Timestep Adjustment Interval {=} Nsteps

       Use Dynamic Topology Io

       Use Output Scheduler Timer_name

    end Restart Data Label

### 7.8.26.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 | –

###### At Wall Time

Syntax

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

Summary

  Write a restart file at a specific wall time since the start of the run. Time string format allows s, m, h, d for seconds, minutes, hours, days

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

###### 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
--- | --- | ---
{=} | {= | is} | –
Separator | string | –

###### Cycle Count

Syntax

  Cycle Count {=} Count

Summary

  Specify the number of restart steps which will be written to the restart database before previously written steps are overwritten. For example, if the cycle count is 5 and restart is written every 0.1 seconds, the restart system will write 0.1, 0.2, 0.3, 0.4, 0.5 to the database. It will then overwrite the first step with data from time 0.6, the second with time 0.7. At time 0.8, the database would contain data at times 0.6, 0.7, 0.8, 0.4, 0.5. Note that time will not necessarily be monotonically increasing on a database that specifies the cycle count.

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

###### Database Name

Syntax

  Database Name {=} StreamName

Summary

  The database containing the input and/or output restart data. If this analysis is being restarted, restart data will be read from this file. If the analysis is writing restart data, the data will be written to this file. It will be overwritten if it exists (after being read if applicable). 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. See also the ‘Input Database’ and ‘Output Database’ commands.

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 used for the restart file.

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

###### Debug Dump

Syntax

  Debug Dump

Summary

  Specify whether the restart system will write the restart data immediately after reading the restart data if the run is restarting. The output data can be compared with the restart input data to determine whether they match.

###### Decomposition Method

Syntax

  Decomposition Method {=} {block | cyclic | external | geom_kway | hsfc | kway | kway_geom | linear | map | metis_sfc | random | rcb | rib | variable}

Summary

  The decomposition algorithm to be used to partition elements to each processor in a parallel run.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Method | {block | cyclic | external | geom_kway | hsfc | kway | kway_geom | linear | map | metis_sfc | random | rcb | rib | variable} | –

###### 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 suffix to the file name and output to that file.

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

###### File Cycle Count

Syntax

  File Cycle Count {=} Count

Summary

  Each restart dump will be written to a separate file suffixed with A,B, … The count specifies how many separate files are used before the cycle repeats. For example, if “FILE CYCLE COUNT = 3” is specified, the restart dumps would be written to file-A.rs, file-B.rs, file-C.rs, file-A.rs, … The maximum value for the cycle count is 26.

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

###### Flush Interval

Syntax

  Flush Interval {=} Option

Summary

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

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

###### Input Database Name

Syntax

  Input Database Name {=} StreamName

Summary

  The database containing the input restart data. If this analysis is being restarted, restart data will be read from this file. See also the ‘Database’ and ‘Output Database’ commands.

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

###### Optional

Syntax

  Optional

Summary

  The database will be read if it exists, but it is not an error if there is no restart database to read for this region during a restarted analysis.

###### Output Database Name

Syntax

  Output Database Name {=} StreamName

Summary

  The database containing the output restart data. If the analysis is writing restart data, the data will be written to this file. It will be overwritten if it exists. See also the ‘Database’ and ‘Input Database’ commands.

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

###### 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} | –

###### Output Restart State

Syntax

  Output Restart State {=} {off | on}

Summary

  Outputs the restarted state to the new restarted results file

Description

  NOTE: This command must be placed at the Sierra scope of the input file. Allows the analyst to visualize the restarted state for debugging

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

###### Overlay Count

Syntax

  Overlay Count {=} Count

Summary

  Specify the number of restart outputs which will be overlaid on top of the last written step. For example, if restarts are being output every 0.1 seconds and the overlay count is specified as 2, then restart will write times 0.1 to step 1 of the database. It will then write 0.2 and 0.3 also to step 1. It will then increment the database step and write 0.4 to step 2; overlay 0.5 and 0.6 on step 2… At the end of the analysis, assuming it runs to completion, the database would have times 0.3, 0.6, 0.9, … However, if there were a problem during the analysis, the last step on the database would contain an intermediate step.

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

###### Overwrite

Syntax

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

Summary

  (DEPRECATED, Use EXISTS) Specify whether the restart database should be overwritten if it exists. The default behavior is to overwrite unless this command is specified in the restart 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. If PropertyName consists of multiple strings, they will be concatenated together with “_” separating the individual words. Supported properties are typically database dependent; Current properties are:

  - COMPRESSION_LEVEL = [0..9]

  - COMPRESSION_SHUFFLE = true|false|on|off

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

  - INTEGER_SIZE_DB = 4|8

  - INTEGER_SIZE_API = 4|8

  - LOGGING = true|false|on|off

  - MAX_NAME_LENGTH = value

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

###### Restart

Syntax

  Restart {=} {auto}

Summary

  Specify automatic restart file read.

Description

  NOTE: This command must be placed at the Sierra scope of the input file.

  Specify that the analysis should be restarted from the last common time on all restart databases for each Region in the analysis. In addition to this line command, each Region in the analysis (strictly, only the region(s) that will be restarted) must have a restart block specifying the database to read the restart state data.

  By default, use of this command will not cause output files (e.g., results, history, heartbeat, restart) to be overwritten. Instead output files will be written with the same basename and the suffix `-s000*`. Common visualization packages are written to handle this file organization gracefully in order for the user to view all results seamlessly.

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

###### Restart Time

Syntax

  Restart Time {=} Time

Summary

  Specify restart file read at a specified time.

Description

  NOTE: This command must be placed at the Sierra scope of the input file.

  Specify the time that the analysis will be restarted. In addition to this line command, each Region in the analysis (strictly, only the region(s) that will be restarted) must have a restart block specifying the database to read the restart state data. The restart ‘time’ must be greater than zero and less than or equal to the termination time.

  By default, use of this command will cause previous output files (e.g., results, history, heartbeat, restart) to be overwritten. If this command is chosen, the onus is placed on the user to ensure that previous output files are not overwritten.

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

###### 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.

###### Shift To Start Time

Syntax

  Shift To Start Time

Summary

  The shift to start time option allows a user to shift the restart time to the start time of the current region. An example use case would be if a restart time of 0.5 is specified, but the user would like to start the simulation at time 1.0.

###### 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 Dynamic Topology Io

Syntax

  Use Dynamic Topology Io

Summary

  Specify that the app use IO for dynamic topology modifications where the output files are stored in a single database. Legacy file format for dynamically changing topology results in the creation of multiple files for each output on a mesh modification. This option leverages the ability of netCDF to create mesh groups within a single database and concatenate all mesh files into one. The names of each mesh group are of the form IOSS_MESH_GROUP-??? where ??? is the 1-based output index 1, 2, …, 10, …., 100, … Please note that netCDF has a current limit of 65,536 groups

###### 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.8.27. Results Output

Scope

  Average Region, Fuego Region, Input_Output Region, Particle 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...

       Element VariableList...

       Enable Large Ids

       Exclude {=} [ ElementBlockList...  ]

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

       Face VariableList...

       Flush Interval {=} Option

       Global VariableList...

       Include {=} [ ElementBlockList...  ]

       Nodal VariableList...

       Node VariableList...

       Nodeset 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...

       Start Time {=} Start_time

       Surface VariableList...

       Synchronize Output

       Termination Time {=} Final_time

       Timeseries Name {=} filename

       Timestep Adjustment Interval {=} Nsteps

       Title

       Use Dynamic Topology Io

       Use Output Scheduler Timer_name

       begin Catalyst Label
       end

    end Results Output Label

### 7.8.27.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.

Parameter | Value | Default
--- | --- | ---
VariableList | string… | –

###### 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”

Parameter | Value | Default
--- | --- | ---
VariableList | string… | –

###### 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.

Parameter | Value | Default
--- | --- | ---
VariableList | string… | –

###### Flush Interval

Syntax

  Flush Interval {=} Option

Summary

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

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

###### Global

Syntax

  Global VariableList…

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
--- | --- | ---
VariableList | string… | –

###### 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.

Parameter | Value | Default
--- | --- | ---
VariableList | string… | –

###### 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.

Parameter | Value | Default
--- | --- | ---
VariableList | string… | –

###### 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.

Parameter | Value | Default
--- | --- | ---
VariableList | string… | –

###### 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.

Parameter | Value | Default
--- | --- | ---
VariableList | 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 | –

###### 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.

Parameter | Value | Default
--- | --- | ---
VariableList | 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 | –

###### 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 Dynamic Topology Io

Syntax

  Use Dynamic Topology Io

Summary

  Specify that the app use IO for dynamic topology modifications where the output files are stored in a single database. Legacy file format for dynamically changing topology results in the creation of multiple files for each output on a mesh modification. This option leverages the ability of netCDF to create mesh groups within a single database and concatenate all mesh files into one. The names of each mesh group are of the form IOSS_MESH_GROUP-??? where ??? is the 1-based output index 1, 2, …, 10, …., 100, … Please note that netCDF has a current limit of 65,536 groups

###### 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 | –