# 6.1. Domain

This section is referenced in the following other sections

- Simulation Setup: Assemblies
- Simulation Setup: Finite element model
- Simulation Setup: Output Reference
- Simulation Setup: Restart Reference

## 6.1.1. Sierra

Summary

  Delimits a domain to contain the procedures.

Description

  The “Begin Sierra jobid” and “End Sierra jobid” block contains the input commands for the analysis run. The jobid is an arbitrary string identifying the analysis.

    begin Sierra JobIdentifier

       Define Axis AxisName With Point PointName {direction | point} DirectName

       Define Direction DirectName With Vector Components1 Components2 Components3

       Define Point PointName With Coordinates Coordinates1 Coordinates2 Coordinates3

       Load User Plugin File File Name [ Using Function Function  ]

       Maximum Warning Count {=} Max_messages

       Restart {=} {auto}

       Restart Time {=} Time

       Serialized Io Group Size {=} Group-size

       Test Error Messages To File File_name And Die On First types...

       Title

       User Subroutine File {=} File_name

       Diagnostic Stream File_name [ Indent-streambuf-flags1[ Indent-streambuf-flags2]  ]

       Enable Timer Timer-enumeration...

       Log Log-control-name Every Interval

       Print Timer Information Every Procedure-step-interval Steps {accumulated | checkpointed}

       begin Definition For Function FunctionName
       end

       begin Finite Element Model Finite-Element-Model-Name
       end

       begin Fuego Procedure ProcedureName
       end

       begin Global Constants empty
       end

       begin Material MaterialName
       end

       begin Output Scheduler Label
       end

       begin Property Specification For Fuego Material MaterialName
       end

       begin Property Specification For Material MaterialName
       end

       begin Tpetra Equation Solver Solver Name
       end

    end Sierra JobIdentifier

### 6.1.1.1. Line Commands

###### Define Axis

Syntax

  Define Axis AxisName With Point PointName {direction | point} DirectName

Summary

  Defines a named axis in terms of a spatial point and direction vector, or from one spatial point to another.

Parameter | Value | Default
--- | --- | ---
AxisName | string | –
PointName | string | –
Option | {direction | point} | –
DirectName | string | –

###### Define Direction

Syntax

  Define Direction DirectName With Vector Components1 Components2 Components3

Summary

  Defines a named spatial direction in terms of vector components.

Parameter | Value | Default
--- | --- | ---
DirectName | string | –
Components | real1 real2 real3 | –

###### Define Point

Syntax

  Define Point PointName With Coordinates Coordinates1 Coordinates2 Coordinates3

Summary

  Defines a named point in space in terms of its coordinates.

Parameter | Value | Default
--- | --- | ---
PointName | string | –
Coordinates | real1 real2 real3 | –

###### Load User Plugin File

Syntax

  Load User Plugin File File Name [ Using Function Function ]

Summary

  This line command names the source file and registration function for C++ user plugins, subroutines and functions.

Parameter | Value | Default
--- | --- | ---
File Name | string | –

###### Maximum Warning Count

Syntax

  Maximum Warning Count {=} Max_messages

Summary

  Sets the maximum number of warnings before the execution is terminated.

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

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

###### Serialized Io Group Size

Syntax

  Serialized Io Group Size {=} Group-size

Summary

  Specifies the number of processors which can concurrently perform I/O. Specifying zero disables serialization.

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

###### Test Error Messages To File

Syntax

  Test Error Messages To File File_name And Die On First types…

Summary

  Write an error message to the specified file and then die

Parameter | Value | Default
--- | --- | ---
File_name | string | –
types | {error | message | warning} | –

###### Title

Syntax

  Title

Summary

  User-defined title for identifying the analysis. The title continues to the end of the line (including continuation lines)

###### User Subroutine File

Syntax

  User Subroutine File {=} File_name

Summary

  This line command is only for the script that runs the application code. It needs to know where to find the *.F file that contains all the user subroutines that are referenced in the input file. Although a C++ handler is provided, the apps do not do anything with this command, only the script that runs the app. Note that the scope of this command is domain!

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

###### Diagnostic Stream

Syntax

  Diagnostic Stream File_name [ Indent-streambuf-flags1[ Indent-streambuf-flags2] ]

Summary

  File path to write diagnostic messages to.

Parameter | Value | Default
--- | --- | ---
File_name | string | –

###### Enable Timer

Syntax

  Enable Timer Timer-enumeration…

Summary

  Enables runtime performance metrics data collecting.

Description

  The metrics cpu time, wall time, io count, msg count and flop count which are collected within several classes can be selectively enabled by metric class.

  CPU and wall time metrics are enabled on all platforms. The remaining metrics are enabled on some platforms based on data availability.

  Metrics:
    cpu

      Display CPU times

    wall

      Display wall times

  Metric classes:
    all

      Enable all metrics

    none

      Disable all timers

    adaptivity

      Enable metrics on adaptivity

    algorithm

      Enable metrics on algorithms

    app1

      Enable app defined metrics

    contact

      Enable metrics on contact

    domain

      Enable metrics on the domain

    material

      Enable metrics on materials

    mechanics

      Enable metrics on mechanics

    procedure

      Enable metrics on procedures

    profile1

      Enable app defined profiling metrics

    region

      Enable metrics on regions

    search

      Enable metrics on searches

    solver

      Enable metrics on solvers

    transfer

      Enable metrics on user functions

  Output formats:
    table

      Format output as a table

    xml

      Format output as an XML file

Parameter | Value | Default
--- | --- | ---
Timer-enumeration | {adaptivity | algorithm | all | app1 | app2 | app3 | app4 | contact | cpu | domain | hms | material | mechanics | none | procedure | profile1 | profile2 | profile3 | profile4 | recovery | region | search | seconds | solver | transfer | wall} | –

###### Log

Syntax

  Log Log-control-name Every Interval

Summary

  Sets the maximum number of warnings before the execution is terminated.

Parameter | Value | Default
--- | --- | ---
Log-control-name | string | –
Interval | integer | –

###### Print Timer Information Every

Syntax

  Print Timer Information Every Procedure-step-interval Steps {accumulated | checkpointed}

Summary

  Specifies the procedure step count interval to print timer information

Parameter | Value | Default
--- | --- | ---
Procedure-step-interval | integer | –
Checkpointed | {accumulated | checkpointed} | –

## 6.1.2. Definition For Function

Scope

  Sierra

Summary

  Defines a function in terms of its type and values.

    begin Definition For Function FunctionName

       Abscissa {=} Name...

       Abscissa Offset {=} Abscissa_offset

       Abscissa Scale {=} Abscissa_scale

       At Discontinuity Evaluate To {left | right}

       Column Titles Titles1 Titles2...

       Data File = filename [ X From Column xcol Y From Column ycol  ]

       Debug {=} {off | on}

       Differentiate Expression {=} Expr

       Evaluate Expression {=} Expr

       Evaluate From x0 To x1 By Dx

       Expression Variable: Expr = {element | element_sym_tensor | element_tensor | element_vector | face | global | nodal | nodal_sym_tensor | nodal_tensor | nodal_vector} value_var_name... [ State {new | none | old}  ]

       Expression Variable: Expr

       Field Types Titles1 Titles2...

       Ordinate {=} Name...

       Ordinate Offset {=} Ordinate_offset

       Ordinate Scale {=} Ordinate_scale

       Scale By x

       Type {=} {analytic | constant | multicolumn piecewise linear | piecewise analytic | piecewise constant | piecewise linear | piecewise multivariate | xtable}

       X Offset {=} X_offset

       X Scale {=} X_scale

       Y Offset {=} Y_offset

       Y Scale {=} Y_scale

       begin Expressions empty
       end

       begin Values empty
       end

    end Definition For Function FunctionName

### 6.1.2.1. Line Commands

###### Abscissa

Syntax

  Abscissa {=} Name…

Summary

  Specifies a string identifier for the independent variable. Optionally specify a scale and/or offset value which transforms the abscissa values into scaled_abscissa = scale * ( abscissa + abscissa_offset).

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

###### Abscissa Offset

Syntax

  Abscissa Offset {=} Abscissa_offset

Summary

  Alias for X OFFSET

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

###### Abscissa Scale

Syntax

  Abscissa Scale {=} Abscissa_scale

Summary

  Alias for X SCALE

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

###### At Discontinuity Evaluate To

Syntax

  At Discontinuity Evaluate To {left | right}

Summary

  Control the behavior of a piecewise constant function when evaluated at a discontinuity (plus or minus a small tolerance). The default behavior is to take the value to the right of the discontinuity. If “Left” is specified, the value to the left of the discontinuity is taken instead.

Parameter | Value | Default
--- | --- | ---
Option | {left | right} | –

###### Column Titles

Syntax

  Column Titles Titles1 Titles2…

Summary

  Name the columns (and also defined the expected number of columns) for Multicolumn Piecewise Linear tabular data.

Parameter | Value | Default
--- | --- | ---
Titles | string1 string2… | –

###### Data File

Syntax

  Data File = filename [ X From Column xcol Y From Column ycol ]

Summary

  Function will read tabular data from an input file. Compatible with the piecewise linear function type. File must be of form like:

      ---------------------------------------------
      \# EXAMPLE FILE
      1.099   1191
      1.101   221
      5.9011  133.1
      ---------------------------------------------

  Lines headed by a # are considered comments and will be ignored. Data itself must by in tabular columns separated by whitespace or commas.

Parameter | Value | Default
--- | --- | ---
filename | string | –

###### Debug

Syntax

  Debug {=} {off | on}

Summary

  Prints functions to the log file.

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

###### Differentiate Expression

Syntax

  Differentiate Expression {=} Expr

Summary

  Specifies the expression of derivative of evaluation expression.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Expr | (expression) | –

###### Evaluate Expression

Syntax

  Evaluate Expression {=} Expr

Summary

  Specifies the expression to evaluate.

Description

  This will greatly help with manufactured solutions, and be useful for other purposes as well. This uses the STK expression evaluator to evaluate the provided string. See the STK user manual for details about valid syntax.

      begin definition for function pressure
        type is analytic
        evaluate expression is "x <= 0.0 ? 0.0 : (x < 0.5 ? x*200.0
           : (x < 1.0 ? (x - 0.5) *50.0 + 100.00 : 150.0))"
      end definition for function pressure

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Expr | (expression) | –

###### Evaluate From

Syntax

  Evaluate From x0 To x1 By Dx

Summary

  Specifies the range and evaluation interval.

Parameter | Value | Default
--- | --- | ---
x0 | real | –
x1 | real | –
Dx | real | –

###### Expression Variable:

Syntax

  Expression Variable: Expr = {element | element_sym_tensor | element_tensor | element_vector | face | global | nodal | nodal_sym_tensor | nodal_tensor | nodal_vector} value_var_name… [ State {new | none | old} ]

Summary

  Specifies what the arguments of an expression correspond to. For example:

      BEGIN DEFINITION FOR FUNCTION dx_shear
        TYPE = ANALYTIC
        EXPRESSION variable: mx   = NODAL model_coordinates(x)
        EXPRESSION variable: my   = NODAL model_coordinates(y)
        EXPRESSION variable: time = GLOBAL time
        EVALUATE EXPRESSION = "(time/{termTime})*({stretchx}*(mx - 0.0) + ((my-0.25)/0.5)*{stretchxy})"
      END

  Assuming the above expression is being evaluated on nodes the current values for x and y model coordinates would be placed into mx and my and current analysis time placed into time

Parameter | Value | Default
--- | --- | ---
Expr | string | –
VarType | {element | element_sym_tensor | element_tensor | element_vector | face | global | nodal | nodal_sym_tensor | nodal_tensor | nodal_vector} | –
value_var_name | string… | –

###### Expression Variable:

Syntax

  Expression Variable: Expr

Summary

  Specifies what the arguments of an expression exists, but does not define it correspond to. For example:

      BEGIN DEFINITION FOR FUNCTION dx_shear
        TYPE = ANALYTIC
        EXPRESSION variable: mx
        EXPRESSION variable: my
        EXPRESSION variable: time
        EVALUATE EXPRESSION = "(time/{termTime})*({stretchx}*(mx - 0.0) + ((my-0.25)/0.5)*{stretchxy})"
      END

  Call function must determine what each variable actually is is based off of the string name

Parameter | Value | Default
--- | --- | ---
Expr | string | –

###### Field Types

Syntax

  Field Types Titles1 Titles2…

Summary

  The field types (GLOBAL/NODE/ELEMENT) that correspond to the column titles listed for the multicolumn data.

Parameter | Value | Default
--- | --- | ---
Titles | string1 string2… | –

###### Ordinate

Syntax

  Ordinate {=} Name…

Summary

  Specifies a string identifier for the dependent variable. Optionally specify a scale and/or offset value which transforms the ordinate values into scaled_ordinate = scale * ( ordinate + ordinate_offset).

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

###### Ordinate Offset

Syntax

  Ordinate Offset {=} Ordinate_offset

Summary

  Alias for Y OFFSET

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

###### Ordinate Scale

Syntax

  Ordinate Scale {=} Ordinate_scale

Summary

  Alias for Y SCALE

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

###### Scale By

Syntax

  Scale By x

Summary

  Specifies a scale factor to be applied.

Parameter | Value | Default
--- | --- | ---
x | real | –

###### Type

Syntax

  Type {=} {analytic | constant | multicolumn piecewise linear | piecewise analytic | piecewise constant | piecewise linear | piecewise multivariate | xtable}

Summary

  Specifies the type of function.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Type | {analytic | constant | multicolumn piecewise linear | piecewise analytic | piecewise constant | piecewise linear | piecewise multivariate | xtable} | –

###### X Offset

Syntax

  X Offset {=} X_offset

Summary

  Sets an offset for the x-axis

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

###### X Scale

Syntax

  X Scale {=} X_scale

Summary

  Sets a scale factor for the x-axis

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

###### Y Offset

Syntax

  Y Offset {=} Y_offset

Summary

  Sets an offset for the y-axis

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

###### Y Scale

Syntax

  Y Scale {=} Y_scale

Summary

  Sets a scale factor for the y-axis

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

## 6.1.3. Values

Scope

  Definition For Function

Summary

  Lists the values of the function. The values should be listed one pair per line, independent variable first, with whitespace or comma as a separator.

    begin Values empty

        Xyvalues...

    end Values empty

### 6.1.3.1. Line Commands

###### Xyvalues

Syntax

  Xyvalues Xyvalues…

Summary

  For a piecewise linear function, lists an x-y pair for the nth interpolation point.

Parameter | Value | Default
--- | --- | ---
Xyvalues | real… | –

## 6.1.4. Finite Element Model

Scope

  Sierra

Summary

  Describes the location and type of the input stream used for defining a geometry model for the enclosing region.

    begin Finite Element Model Finite-Element-Model-Name

       Alias DatabaseName As InternalName

       Component Separator Character {=} Separator

       Create {edgeset | elemset | faceset | nodeset | sideset | surface} NewSurfaceName Add SurfaceName...

       Coordinate System {=} {axisymmetric | barycentric | cartesian | cyclidic | cylindrical | polar | quadriplanar | skew | spherical | toroidal | trilinear}

       Database Name {=} StreamName

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

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

       Omit Assembly AssemblyList...

       Omit Block BlockList...

       Omit Volume VolumeList...

       Time Scale Factor {=} Scale

       Use Generic Names

       Use Material MaterialName For VolumeList...

       begin Assembly Assembly_Name
       end

       begin Block Blockname
       end

       begin Parameters For Block Blockname
       end

    end Finite Element Model Finite-Element-Model-Name

### 6.1.4.1. Line Commands

###### Alias

Syntax

  Alias DatabaseName As InternalName

Summary

  Name the database entity “DatabaseName” as “InternalName”

Description

  This “InternalName” may then be referenced in the data file in addition to the original name.

Parameter | Value | Default
--- | --- | ---
DatabaseName | string | –
InternalName | 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 | –

###### Create

Syntax

  Create {edgeset | elemset | faceset | nodeset | sideset | surface} NewSurfaceName Add SurfaceName…

Summary

  Create a new set (node, edge, face, element, side/surface) as the union of two or more existing sets. The sets must exist in the mesh database or have been created by a previous CREATE command.

Parameter | Value | Default
--- | --- | ---
GroupType | {edgeset | elemset | faceset | nodeset | sideset | surface} | –
NewSurfaceName | string | –
SurfaceName | string… | –

###### Coordinate System

Syntax

  Coordinate System {=} {axisymmetric | barycentric | cartesian | cyclidic | cylindrical | polar | quadriplanar | skew | spherical | toroidal | trilinear}

Summary

  The interpretation of the geometry data stored in this database. Optional. Defaults to Cartesian.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
CoordinateSystem | {axisymmetric | barycentric | cartesian | cyclidic | cylindrical | polar | quadriplanar | skew | spherical | toroidal | trilinear} | –

###### 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 “.g” 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 used for the mesh.

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

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

###### Omit Assembly

Syntax

  Omit Assembly AssemblyList…

Summary

  Specifies that the element blocks that are in the assemblies in AssemblyList will be omitted from the analysis.

Description

  If an assembly is used to omit an element block, then it is illegal to refer to that element block later in the file. Any of the element blocks omitted will be removed from any assembly that contains them.

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

###### Omit Block

Syntax

  Omit Block BlockList…

Summary

  Specifies that the element blocks named in the blockList be omitted from the analysis.

Description

  If an element block is omitted, then it is illegal to refer to it later in the input file e.g an initial condition may not be specified on an omitted element block. The elements, faces, etc are never created and it is as if the omitted element blocks did not exist in the mesh file. If a surface is completely determined by the omitted element block, then it is illegal to specify boundary conditions on that surface. However, if the surface spans multiple element blocks, boundary conditions may be applied on the portion of the surface supported by the element blocks that are not omitted.

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

###### Omit Volume

Syntax

  Omit Volume VolumeList…

Summary

  Specifies that the volumes named in the volumeList be omitted from the analysis.

Description

  If a volume is omitted, then it is illegal to refer to it later in the input file e.g an initial condition may not be specified on an omitted volume. The elements, faces, etc are never created and it is as if the omitted volumes did not exist in the mesh file. If a surface is completely determined by the omitted volume, then it is illegal to specify boundary conditions on that surface. However, if the surface spans multiple volumes, boundary conditions may be applied on the portion of the surface supported by the volumes that are not omitted.

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

###### Time Scale Factor

Syntax

  Time Scale Factor {=} Scale

Summary

  The scale factor to be applied to the times on the mesh database. If the scale factor is 20 and the times on the mesh database are 0.1, 0.2, 0.3, then the application will see the mesh times as 2, 4, 6.

Parameter | Value | Default
--- | --- | ---
{=} | {= | is} | –
Scale | real | –

###### Use Generic Names

Syntax

  Use Generic Names

Summary

  If this command is present then the name of all blocks and sets in the mesh will be of the form “type_”+id. For example, an element block with id=42 will be named “block_42”; a sideset with id 314 will be named “surface_314”. If there are any names in the mesh file, those names will be aliases for the blocks and sets. If this command is not present, then if a name is in the mesh file, it will be used as the name and the generic generated name will be an alias. This is used as a workaround in codes that do not correctly handle named blocks and sets or as a workaround in meshes which contain non-user-specified names.

###### Use Material

Syntax

  Use Material MaterialName For VolumeList…

Summary

  Associate the given volumes with the indicated material name.

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

## 6.1.5. Parameters For Block

Scope

  Finite Element Model

Summary

  Specifies analysis parameters associated with each element block.

    begin Parameters For Block Blockname

       Active For Procedure ProcedureName During Periods PeriodNames...

       Bending Hourglass {stiffness | viscosity} {=} Hgval

       Density Scale Factor {=} densityScaleFactor

       Deposit Specific Internal Energy Edep [ Over Time Tdep Starting At Time Tinit  ]

       Effective Moduli Model {=} {elastic | probed | pronto}

       Element Numerical Formulation {=} {new | old}

       Energy Iteration Tolerance {=} Eit

       Hourglass {stiffness | viscosity} {=} Hgval

       Hourglass {exponent | transition strain} {=} Hgval

       Inactive For Procedure ProcedureName During Periods PeriodNames...

       Include All Blocks

       Inversion Aversion Exponent {=} ia_exponent

       Inversion Aversion Stiffness {=} ia_stiffness

       Inversion Aversion Transition Jacobian {=} transition_jacobian

       Linear Bulk Viscosity {=} Lbv

       Material MatName

       Material = MatName

       Max Energy Iterations {=} Mei

       Membrane Hourglass {stiffness | viscosity} {=} Hgval

       Minimum Effective Dilatational Moduli Ratio {=} minEffectiveModuliRatio

       Minimum Effective Shear Moduli Ratio {=} minEffectiveModuliRatio

       Model {=} ModelName

       Nonlocal Regularization Kmeans Cell Size {=} kmeans_cell_size

       Nonlocal Regularization Kmeans Maximum Iterations {=} kmeans_maximum_iterations

       Nonlocal Regularization Kmeans Tolerance {=} kmeans_tolerance

       Nonlocal Regularization On stateVariableName With Length Scale {=} lengthScale [ And Staggering  ]

       Nonlocal Regularization Partitioning Scheme {=} {kmeans | metis | zoltan_hypergraph | zoltan_rcb | zoltan_rib}

       Phase PhaseLabel {=} MaterialName

       Quadratic Bulk Viscosity {=} Qbv

       Remove Block {=} ExcludeBlockList...

       Section {=} SectionName

       Solid Mechanics Use Model ModelName

       Transverse Shear Hourglass {stiffness | viscosity} {=} Hgval

    end Parameters For Block Blockname

### 6.1.5.1. Line Commands

###### Active For Procedure

Syntax

  Active For Procedure ProcedureName During Periods PeriodNames…

Summary

  Lists the solution periods during which the given BC, solver, preconditioner, etc. is active. Multiple uses of this line command within a single block will have a cumulative affect.

Parameter | Value | Default
--- | --- | ---
ProcedureName | string | –
PeriodNames | string… | –

###### Bending Hourglass

Syntax

  Bending Hourglass {stiffness | viscosity} {=} Hgval

Summary

  Supplies the hourglass stiffness and viscosity parameters for bending deformation in a shell element block.

Parameter | Value | Default
--- | --- | ---
Option | {stiffness | viscosity} | –
{=} | {= | are | is} | –
Hgval | real | –

###### Density Scale Factor

Syntax

  Density Scale Factor {=} densityScaleFactor

Summary

  Specifies a scale factor to apply to the density defined in the material. This value must be greater than zero. The default is 1.0 (no scaling).

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

###### Deposit Specific Internal Energy

Syntax

  Deposit Specific Internal Energy Edep [ Over Time Tdep Starting At Time Tinit ]

Summary

  Defines the amount of specific (per unit mass) internal energy to be deposited in the material. The energy is deposited over time tdep, beginning at time tinit. The optional parameters tdep and tinit both default to zero, so the energy will be deposited instantaneously at time zero if they are not specified. The deposition is uniform in space, so each element in the block has the same amount edep added to its specific internal energy.

Parameter | Value | Default
--- | --- | ---
Edep | real | –

###### Effective Moduli Model

Syntax

  Effective Moduli Model {=} {elastic | probed | pronto}

Summary

  Specifies the method used to determine the effective moduli. This choice can have a significant effect on the resulting hourglassing behavior. The models are: * elastic: use the initial elastic moduli * pronto: use the old PRONTO method for computing elastic moduli this approach is straight out of PRONTO, PRESTO’s predecessor. This is a bounded tangent method. * probe: Use a pronto-like method, but pass in a an artificial probe strain rate rather than the actual strain.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Option | {elastic | probed | pronto} | –

###### Element Numerical Formulation

Syntax

  Element Numerical Formulation {=} {new | old}

Summary

  Specifies which element numerical formulation to use for this block.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
Option | {new | old} | –

###### Energy Iteration Tolerance

Syntax

  Energy Iteration Tolerance {=} Eit

Summary

  Specifies the tolerance criteria for exiting the iterative solve of the implicit internal energy update equation. Applicable when using EOS material models with extracted energy updates.

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

###### Hourglass

Syntax

  Hourglass {stiffness | viscosity} {=} Hgval

Summary

  Supplies the hourglass stiffness and viscosity parameters for this element block.

Parameter | Value | Default
--- | --- | ---
Option | {stiffness | viscosity} | –
{=} | {= | are | is} | –
Hgval | real | –

###### Hourglass

Syntax

  Hourglass {exponent | transition strain} {=} Hgval

Summary

  Supplies the hourglass stiffness and viscosity parameters for this element block.

Parameter | Value | Default
--- | --- | ---
Option | {exponent | transition strain} | –
{=} | {= | are | is} | –
Hgval | real | –

###### Inactive For Procedure

Syntax

  Inactive For Procedure ProcedureName During Periods PeriodNames…

Summary

  Lists the solution periods during which the given BC, solver, preconditioner, etc. is inactive. Multiple uses of this line command within a single block will have a cumulative affect.

Parameter | Value | Default
--- | --- | ---
ProcedureName | string | –
PeriodNames | string… | –

###### Include All Blocks

Syntax

  Include All Blocks

Summary

  Use this parameters definition for all blocks.

  When using this option within the FINITE ELEMENT MODEL command block the PARAMETERS FOR BLOCK will not use a Blockname.

###### Inversion Aversion Exponent

Syntax

  Inversion Aversion Exponent {=} ia_exponent

Summary

  Sets the exponent used to compute the smooth approximate nodal jacobian ratio. A higher exponent results in a more-accurate approximation to the ratio. This is only active for uniform gradient elements. Default = 5.

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

###### Inversion Aversion Stiffness

Syntax

  Inversion Aversion Stiffness {=} ia_stiffness

Summary

  Sets a stiffness parameter for the inversion aversion penalty. This is only active for uniform gradient elements. Default = 1.0e5.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
ia_stiffness | real | 1.e5

###### Inversion Aversion Transition Jacobian

Syntax

  Inversion Aversion Transition Jacobian {=} transition_jacobian

Summary

  Sets the critical relative nodal Jacobian ratio for inversion aversion. If this value is nonzero, an additional recoverable energy term is added which penalizes further element distortion. This energy is only active for uniform gradient elements.

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

###### Linear Bulk Viscosity

Syntax

  Linear Bulk Viscosity {=} Lbv

Summary

  Supplies the linear coefficient for the bulk viscosity computations.

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

###### Material

Syntax

  Material MatName

Summary

  Associates this element block with its material properties.

Parameter | Value | Default
--- | --- | ---
MatName | string | –

###### Material =

Syntax

  Material = MatName

Summary

  Associates this element block with its material properties.

Parameter | Value | Default
--- | --- | ---
MatName | string | –

###### Max Energy Iterations

Syntax

  Max Energy Iterations {=} Mei

Summary

  Specifies the maximum number of iterations to take in solving the implicit internal energy update equation. Applicable when using EOS material models with extracted energy updates.

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

###### Membrane Hourglass

Syntax

  Membrane Hourglass {stiffness | viscosity} {=} Hgval

Summary

  Supplies the hourglass stiffness and viscosity parameters for membrane deformation in a shell or membrane element block.

Parameter | Value | Default
--- | --- | ---
Option | {stiffness | viscosity} | –
{=} | {= | are | is} | –
Hgval | real | –

###### Minimum Effective Dilatational Moduli Ratio

Syntax

  Minimum Effective Dilatational Moduli Ratio {=} minEffectiveModuliRatio

Summary

  Specifies a minimum effective DILATATIONAL moduli ratio. This value keeps the effective moduli from dropping below minEffectiveModuliRatio*ElasticModulus. This can aid in keeping the corresponding time step and bulk viscosity terms dropping to zero

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

###### Minimum Effective Shear Moduli Ratio

Syntax

  Minimum Effective Shear Moduli Ratio {=} minEffectiveModuliRatio

Summary

  Specifies a minimum effective SHEAR moduli ratio. This value keeps the effective moduli from dropping below minEffectiveModuliRatio*ElasticModulus. This can aid in keeping the corresponding hourglass stiffness terms dropping to zero

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

###### Model

Syntax

  Model {=} ModelName

Summary

  Associates a solid mechanics material model with this element block. The material parameters for this block are specified in the material denoted by the MATERIAL command.

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

###### Nonlocal Regularization Kmeans Cell Size

Syntax

  Nonlocal Regularization Kmeans Cell Size {=} kmeans_cell_size

Summary

  This line command specifies the cell size used to construct the background grid for the computation of the centroidal Voronoi tessellation for the Kmeans partitioning scheme.

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

###### Nonlocal Regularization Kmeans Maximum Iterations

Syntax

  Nonlocal Regularization Kmeans Maximum Iterations {=} kmeans_maximum_iterations

Summary

  This line command specifies the maximum number of iterations to perform for Lloyd’s algorithm for the computation of the centroidal Voronoi tessellation for the Kmeans partitioning scheme.

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

###### Nonlocal Regularization Kmeans Tolerance

Syntax

  Nonlocal Regularization Kmeans Tolerance {=} kmeans_tolerance

Summary

  This line command specifies the relative tolerance for Lloyd’s algorithm. Iterations continue until the maximum number is reached or the L2 norm of a vector of all the center steps is less or equal than the tolerance times the cell size of the background grid.

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

###### Nonlocal Regularization On

Syntax

  Nonlocal Regularization On stateVariableName With Length Scale {=} lengthScale [ And Staggering ]

Summary

  This line command will cause the mesh to be partitioned into sub domains where each sub domain volume is on the order of and regularizes the governing PDE by averaging the material state variable stateVariableName over the sub domain.

Parameter | Value | Default
--- | --- | ---
stateVariableName | string | –
{=} | {= | are | is} | –
lengthScale | real | –

###### Nonlocal Regularization Partitioning Scheme

Syntax

  Nonlocal Regularization Partitioning Scheme {=} {kmeans | metis | zoltan_hypergraph | zoltan_rcb | zoltan_rib}

Summary

  This line command specifies the type of partitioning algorithm used to perform the domain decomposition for the nonlocal regularization method

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
PartitioningScheme | {kmeans | metis | zoltan_hypergraph | zoltan_rcb | zoltan_rib} | –

###### Phase

Syntax

  Phase PhaseLabel {=} MaterialName

Summary

  Associate phase PhaseLabel with material Material_Name on this block.

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

###### Quadratic Bulk Viscosity

Syntax

  Quadratic Bulk Viscosity {=} Qbv

Summary

  Supplies the quadratic coefficient for the bulk viscosity computations.

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

###### Remove Block

Syntax

  Remove Block {=} ExcludeBlockList…

Summary

  List of blocks to exclude.

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

###### Section

Syntax

  Section {=} SectionName

Summary

  Specifies the section to use for this element block.

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

###### Solid Mechanics Use Model

Syntax

  Solid Mechanics Use Model ModelName

Summary

  Associates a solid mechanics material model with this element block. The material parameters for this block are specified in the material denoted by the MATERIAL command.

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

###### Transverse Shear Hourglass

Syntax

  Transverse Shear Hourglass {stiffness | viscosity} {=} Hgval

Summary

  Supplies the hourglass stiffness and viscosity parameters for transverse shear deformation in a shell element block.

Parameter | Value | Default
--- | --- | ---
Option | {stiffness | viscosity} | –
{=} | {= | are | is} | –
Hgval | real | –

## 6.1.6. Global Constants

Scope

  Sierra

Summary

  Set of universal constants for a simulation.

    begin Global Constants empty

       Faradays Constant {=} Faraday

       Gravity Vector {=} Gravity1 Gravity2 Gravity3

       Ideal Gas Constant {=} Sigma

       K-E Turbulence Model Parameter Param {=} Value

       K-W Turbulence Model Parameter Param {=} Value

       Les Turbulence Model Parameter Param {=} Value

       Light Speed {=} LightSpeed

       Planck Constant {=} PlanckConstant

       Stefan Boltzmann Constant {=} Sigma

       Turbulence Model Param Number {=} Value

    end Global Constants empty

### 6.1.6.1. Line Commands

###### Faradays Constant

Syntax

  Faradays Constant {=} Faraday

Summary

  Faraday’s Constant. NOTE: Another Faraday’s constant value can be specified while using certain code capabilities. This global constants value will be discarded for any other specified Faraday’s constant values.

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

###### Gravity Vector

Syntax

  Gravity Vector {=} Gravity1 Gravity2 Gravity3

Summary

  Gravity constant in vector form, acceleration components.

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

###### Ideal Gas Constant

Syntax

  Ideal Gas Constant {=} Sigma

Summary

  Ideal gas constant. NOTE: Another ideal gas constant value can be specified while using certain code capabilities. This global constants value will be discarded for any other specified ideal gas constant values.

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

###### K-E Turbulence Model Parameter

Syntax

  K-E Turbulence Model Parameter Param {=} Value

Summary

  RANS turbulence model parameters.

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

###### K-W Turbulence Model Parameter

Syntax

  K-W Turbulence Model Parameter Param {=} Value

Summary

  RANS turbulence model parameters.

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

###### Les Turbulence Model Parameter

Syntax

  Les Turbulence Model Parameter Param {=} Value

Summary

  LES turbulence model parameters.

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

###### Light Speed

Syntax

  Light Speed {=} LightSpeed

Summary

  Speed of Light. Depending on the units involved in the specific problem by the user, this value will differ.

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

###### Planck Constant

Syntax

  Planck Constant {=} PlanckConstant

Summary

  Planck Constant. Depending on the units involved in the specific problem by the user, this value will differ.

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

###### Stefan Boltzmann Constant

Syntax

  Stefan Boltzmann Constant {=} Sigma

Summary

  Stefan-Boltzmann constant. Depending on the units involved in the specific problem by the user, this value will differ.

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

###### Turbulence Model

Syntax

  Turbulence Model Param Number {=} Value

Summary

  Turbulence model Schmidt and Prandtl numbers

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

## 6.1.7. Output Scheduler

Scope

  Sierra

Summary

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

    begin Output Scheduler Label

       Additional Steps {=} List_of_steps...

       Additional Times {=} List_of_times...

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

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

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

       Start Time {=} Start_time

       Synchronize Output

       Termination Time {=} Final_time

       Timestep Adjustment Interval {=} Nsteps

       Use Output Scheduler Timer_name

    end Output Scheduler Label

### 6.1.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… | –

###### At Step

Syntax

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

Summary

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

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

###### At Time

Syntax

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

Summary

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

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

###### Output On Signal

Syntax

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

Summary

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

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

###### Start Time

Syntax

  Start Time {=} Start_time

Summary

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

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

###### Synchronize Output

Syntax

  Synchronize Output

Summary

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

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

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

###### Termination Time

Syntax

  Termination Time {=} Final_time

Summary

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

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

###### Timestep Adjustment Interval

Syntax

  Timestep Adjustment Interval {=} Nsteps

Summary

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

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

###### Use Output Scheduler

Syntax

  Use Output Scheduler Timer_name

Summary

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

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

## 6.1.8. Property Specification For Fuego Material

Scope

  Sierra

Summary

  Contains the commands to describe the property evaluation scheme for Fuego materials.

    begin Property Specification For Fuego Material MaterialName

        {absorption | absorption_coefficient | density | density_pressure_derivative | emissivity | enthalpy | heat_production_rate | interface_absorption | scattering_coefficient | specific_heat | surface_tension | thermal_conductivity | viscosity} {=} Value

       Bulk Chemistry Description {=} Value

       Cantera Xml File {=} FileName

       Chemkin Linking File {=} FileName

       Chemkin Transport File {=} FileName

       Datum Pressure {=} Value

       Do Not Clip Mixture Fraction Variables

       Function For {absorption | absorption_coefficient | density | density_pressure_derivative | emissivity | enthalpy | heat_production_rate | interface_absorption | scattering_coefficient | specific_heat | surface_tension | thermal_conductivity | viscosity} {=} FuncName

       Function For Mass_Diffusivity SpeciesName {=} FuncName

       Function For Species_Density SpeciesName {=} FuncName

       Function For Species_Emissivity SpeciesName {=} FuncName

       Function For Species_Enthalpy SpeciesName {=} FuncName

       Function For Species_Production_Rate SpeciesName {=} FuncName

       Function For Species_Specific_Heat SpeciesName {=} FuncName

       Function For Species_Thermal_Conductivity SpeciesName {=} FuncName

       Input Variables For SubName {=} Variable_list...

       Mass_Diffusivity SpeciesName {=} Value

       Molecular_Weight SpeciesName {=} Value

       Prandtl_Number {=} Value

       Real Data For SubName {=} Parameter_list...

       Reference Variable {=} Value

       Reference Mass_Fraction SpeciesName {=} Value

       Reference Mole_Fraction SpeciesName {=} Value

       Reference Progress_Variable ProgressVariableName With Lower Bound LowerBound And Upper Bound UpperBound

       Set Schmidt Number For Progress Variable ProgressVariableName {=} Value

       Set Thermophoresis Coefficient For Progress Variable ProgressVariableName {=} Value

       Subroutine For PropertyName {=} SubName

       Schmidt_Number {=} Value

       Species_Density SpeciesName {=} Value

       Species_Emissivity SpeciesName {=} Value

       Species_Enthalpy SpeciesName {=} Value

       Species_Production_Rate SpeciesName {=} Value

       Species_Specific_Heat SpeciesName {=} Value

       Species_Thermal_Conductivity SpeciesName {=} Value

       Turbulent Mixing Model {=} {none | parente} [ModelArgs]...

       Use Consistently Volume Averaged Properties [ With Postsmoothing SmoothingIterations  ]

       Vof Gas Material {=} GasMaterial

       Vof Liquid Material {=} LiquidMaterial

       begin Chemistry Description ChemistryDescName
       end

       begin Ode Solver Parameters SolverName
       end

       begin Tabular Property Library LibNameTag
       end

    end Property Specification For Fuego Material MaterialName

### 6.1.8.1. Line Commands

###### Properties

Syntax

  Properties {absorption | absorption_coefficient | density | density_pressure_derivative | emissivity | enthalpy | heat_production_rate | interface_absorption | scattering_coefficient | specific_heat | surface_tension | thermal_conductivity | viscosity} {=} Value

Summary

  Specify a constant or string function value for the property, in consistent units. For example, viscosity = 1.0e-3

Description

  When using a string function, the function may depend on pressure, temperature, mass fraction, or most other properties. When using mass fractions in the string function, use the species name as a suffix, as in

      Density = "300/temperature + mass_fraction_n2"

  The function string must be enclosed in quotes if it has spaces or commas. The variable names are not case-sensitive.

Parameter | Value | Default
--- | --- | ---
Properties | {absorption | absorption_coefficient | density | density_pressure_derivative | emissivity | enthalpy | heat_production_rate | interface_absorption | scattering_coefficient | specific_heat | surface_tension | thermal_conductivity | viscosity} | –
{=} | {= | are | is} | –
Value | “string” | –

###### Bulk Chemistry Description

Syntax

  Bulk Chemistry Description {=} Value

Summary

  Chemistry description to apply to the bulk region of the material being defined

Description

  When multiple chemistry descriptions are included in a material they must apply to different portions of the material i.e. bulk and surface. A bulk description is mandatory in this case and this variable is used to define which description should be referenced. This is only necessary when there are multiple chemistry descriptions for a material.

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

###### Cantera Xml File

Syntax

  Cantera Xml File {=} FileName

Summary

  Name of the Cantera XML file

Description

  Cantera XML files can be generated from CHEMKIN input files or from *.cti files using Cantera’s preprocessing utilities. See Chapter 20 for instructions on how to create a Cantera XML file.

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

###### Chemkin Linking File

Syntax

  Chemkin Linking File {=} FileName

Summary

  specify the file name for the CHEMKIN linking file, in ASCII format

Description

  NOTE: CHEMKIN is no longer supported for property evaluation. Please use Cantera instead.

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

###### Chemkin Transport File

Syntax

  Chemkin Transport File {=} FileName

Summary

  specify the file name for the CHEMKIN transport linking file, in ASCII format

Description

  NOTE: CHEMKIN is no longer supported for property evaluation. Please use Cantera instead.

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

###### Datum Pressure

Syntax

  Datum Pressure {=} Value

Summary

  Specify the datum value for pressure

Description

  When running with the acoustic compressibility model, the output pressure can have an arbitrary datum value. If the datum is set equal to the reference (ambient) value, then pressure will be a “gauge” pressure. If the datum is set to zero, then an absolute pressure will result. This is ignored for incompressible flow, where the thermodynamic pressure is always equal to the reference. The datum defaults to the reference pressure for compressible flow.

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

###### Do Not Clip Mixture Fraction Variables

Syntax

  Do Not Clip Mixture Fraction Variables

Summary

  Turns off clipping for mixture fraction EOS input variables. EOS may still clip the variables

Description

  Fuego does not clip transported variables, relying on the equation to handle unrealizable values of its input parameters

###### Function For

Syntax

  Function For {absorption | absorption_coefficient | density | density_pressure_derivative | emissivity | enthalpy | heat_production_rate | interface_absorption | scattering_coefficient | specific_heat | surface_tension | thermal_conductivity | viscosity} {=} FuncName

Summary

  Specify a function to use for evaluation of this property.

Description

  When specifying a function, you should also specify the name of the independent variable (abscissa). If no abscissa is specified, the temperature will be used.

Parameter | Value | Default
--- | --- | ---
Properties | {absorption | absorption_coefficient | density | density_pressure_derivative | emissivity | enthalpy | heat_production_rate | interface_absorption | scattering_coefficient | specific_heat | surface_tension | thermal_conductivity | viscosity} | –
{=} | {= | are | is} | –
FuncName | string | –

###### Function For Mass_Diffusivity

Syntax

  Function For Mass_Diffusivity SpeciesName {=} FuncName

Summary

  Specify a function to use for evaluating the molecular mass diffusivity for the given species

Description

  For the textit{SpeciesName} parameter, you can either specify the actual species name (O2, N2, CH4, etc.) or the word DEFAULT for a global function applied to all unlisted species. Any species-specific functions, if present, will override the DEFAULT function.

  If this is a turbulent simulation with species transport, then the same mass diffusivity function must be used for all species. You may optionally supply just a Schmidt number.

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

###### Function For Species_Density

Syntax

  Function For Species_Density SpeciesName {=} FuncName

Summary

  Specify a function to use for evaluating the species enthalpy for the given species

Description

  For the textit{SpeciesName} parameter, you can either specify the actual species name (O2, N2, CH4, etc.) or the word DEFAULT for a global function applied to all unlisted species. Any species-specific functions, if present, will override the DEFAULT function.

  This command is only applicable when not using an external third-party library (e.g. Cantera) for property evaluation.

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

###### Function For Species_Emissivity

Syntax

  Function For Species_Emissivity SpeciesName {=} FuncName

Summary

  Specify a function to use for evaluating the species emissivity

Description

  For the textit{SpeciesName} parameter, you can either specify the actual species name (O2, N2, CH4, etc.) or the word DEFAULT for a global function applied to all unlisted species. Any species-specific functions, if present, will override the DEFAULT function.

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

###### Function For Species_Enthalpy

Syntax

  Function For Species_Enthalpy SpeciesName {=} FuncName

Summary

  Specify a function to use for evaluating the species enthalpy for the given species

Description

  For the textit{SpeciesName} parameter, you can either specify the actual species name (O2, N2, CH4, etc.) or the word DEFAULT for a global function applied to all unlisted species. Any species-specific functions, if present, will override the DEFAULT function.

  This command is only applicable when not using an external third-party library (e.g. Cantera) for property evaluation.

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

###### Function For Species_Production_Rate

Syntax

  Function For Species_Production_Rate SpeciesName {=} FuncName

Summary

  warning{This command is deprecated and will be removed in the 5.18 release. It has not had an effect for several releases.}

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

###### Function For Species_Specific_Heat

Syntax

  Function For Species_Specific_Heat SpeciesName {=} FuncName

Summary

  Specify a function to use for evaluating the species specific heat

Description

  For the textit{SpeciesName} parameter, you can either specify the actual species name (O2, N2, CH4, etc.) or the word DEFAULT for a global function applied to all unlisted species. Any species-specific functions, if present, will override the DEFAULT function.

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

###### Function For Species_Thermal_Conductivity

Syntax

  Function For Species_Thermal_Conductivity SpeciesName {=} FuncName

Summary

  Specify a function to use for evaluating the species thermal conductivity

Description

  For the textit{SpeciesName} parameter, you can either specify the actual species name (O2, N2, CH4, etc.) or the word DEFAULT for a global function applied to all unlisted species. Any species-specific functions, if present, will override the DEFAULT function.

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

###### Input Variables For

Syntax

  Input Variables For SubName {=} Variable_list…

Summary

  Requests that the given variables be passed to the specified user subroutine as inputs.

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

###### Mass_Diffusivity

Syntax

  Mass_Diffusivity SpeciesName {=} Value

Summary

  Specify the molecular mass diffusivity for the given species

Description

  For the SpeciesName parameter, you can either specify the actual species name (O2, N2, CH4, etc.) or the word DEFAULT for a global value applied to all unlisted species. Any species-specific values, if present, will override the DEFAULT value.

  If this is a turbulent simulation with species transport, then the mass diffusivity for all species must be identical. You may optionally supply just a Schmidt number.

  When using a string function, the function may depend on pressure, temperature, mass fraction, or most other properties. When using mass fractions in the string function, use the species name as a suffix, as in

      mass_diffusivity N2 = "0.01*mass_fraction_n2"

  The function string must be enclosed in quotes if it has spaces or commas. The variable names are not case-sensitive.

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

###### Molecular_Weight

Syntax

  Molecular_Weight SpeciesName {=} Value

Summary

  Specify the molecular weight for the given species

Description

  For the textit{SpeciesName} parameter, you can either specify the actual species name (O2, N2, CH4, etc.) or the word DEFAULT for a global value applied to all unlisted species. Any species-specific values, if present, will override the DEFAULT value.

  This command is only applicable when not using a material model (e.g. Cantera, Tabular, etc.).

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

###### Prandtl_Number

Syntax

  Prandtl_Number {=} Value

Summary

  Specify the Prandtl number (Pr=mu*cp/k) to calculate thermal conductivity as a function of viscosity and specific heat.

Description

  If transporting both an energy equation and a species equation in turbulent flow, it is mandatory that this be specified and that it be identical to the Schmidt number, to enforce unity Lewis number (Le=Sc/Pr). In all other cases, this is optional.

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

###### Real Data For

Syntax

  Real Data For SubName {=} Parameter_list…

Summary

  Specifies a list of parameters that should be passed to the specified user subroutine.

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

###### Reference

Syntax

  Reference Variable {=} Value

Summary

  Specify the reference value for the given variable

Description

  A reference value must be specified for all input variables required by the particular material model for property evaluation. In the typical case where Cantera is used for property evaluation, then reference properties must be specified for “temperature”, “pressure”, and “mass_fraction”. Other material models may have different dependencies.

  These values will be used for reporting property values at the reference state during startup, and for property evaluation at run-time when a transport equation is not being solved for the required variable or when a reference state is needed for calculating “ambient” properties for entrainment purposes.

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

###### Reference Mass_Fraction

Syntax

  Reference Mass_Fraction SpeciesName {=} Value

Summary

  Specify the reference mass fraction for the given species

Description

  A reference value must be specified for all input variables required by the particular material model for property evaluation. In the typical case where Cantera is used for property evaluation, then reference properties must be specified for “temperature”, “pressure”, and “mass_fraction”. Other material models may have different dependencies.

  These values will be used for reporting property values at the reference state during startup, and for property evaluation at run-time when a transport equation is not being solved for the required variable or when a reference state is needed for calculating “ambient” properties for entrainment purposes.

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

###### Reference Mole_Fraction

Syntax

  Reference Mole_Fraction SpeciesName {=} Value

Summary

  Specify the reference mole fraction for the given species

Description

  A reference value must be specified for all input variables required by the particular material model for property evaluation. In the typical case where Cantera is used for property evaluation, then reference properties must be specified for “temperature”, “pressure”, and “mass_fraction”. Other material models may have different dependencies.

  These values will be used for reporting property values at the reference state during startup, and for property evaluation at run-time when a transport equation is not being solved for the required variable or when a reference state is needed for calculating “ambient” properties for entrainment purposes.

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

###### Reference Progress_Variable

Syntax

  Reference Progress_Variable ProgressVariableName With Lower Bound LowerBound And Upper Bound UpperBound

Summary

  Specify the upper and lower bound of a progress variable, in that order

Description

  A lower and upper bound must be specified for all progress variables.

Parameter | Value | Default
--- | --- | ---
ProgressVariableName | string | –
LowerBound | real | –
UpperBound | real | –

###### Set Schmidt Number For Progress Variable

Syntax

  Set Schmidt Number For Progress Variable ProgressVariableName {=} Value

Summary

  Specify Schmidt numbers for Progress Variable

Description

  Specify Schmidt numbers for Progress Variable

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

###### Set Thermophoresis Coefficient For Progress Variable

Syntax

  Set Thermophoresis Coefficient For Progress Variable ProgressVariableName {=} Value

Summary

  Set thermophoresis coefficient for progress variable

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

###### Subroutine For

Syntax

  Subroutine For PropertyName {=} SubName

Summary

  Set the value of the specified variable using a subroutine. If the subroutine should be passed other properties as variables or be given real data, the INPUT VARIABLES FOR and REAL DATA FOR line commands below should be used.

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

###### Schmidt_Number

Syntax

  Schmidt_Number {=} Value

Summary

  Specify the Schmidt number (Sc=mu/rho*D) to calculate mass diffusivity as a function of viscosity and density.

Description

  If transporting both an energy equation and a species equation in turbulent flow, it is mandatory that this be specified and that it be identical to the Prandtl number, to enforce unity Lewis number (Le=Sc/Pr). If transporting turbulent species without an energy equation, then either the Schmidt number or an identical mass diffusivity for all species must be specified. In all other cases, this is optional.

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

###### Species_Density

Syntax

  Species_Density SpeciesName {=} Value

Summary

  Specify the species density for the given species

Description

  For the SpeciesName parameter, you can either specify the actual species name (O2, N2, CH4, etc.) or the word DEFAULT for a global value applied to all unlisted species. Any species-specific values, if present, will override the DEFAULT value.

  This command is only applicable when not using an external third-party library (e.g. Cantera) for property evaluation.

  When using a string function, the function may depend on pressure, temperature, mass fraction, or most other properties. When using mass fractions in the string function, use the species name as a suffix, as in

      Species_Density N2 = "300/temperature + mass_fraction_n2"

  The function string must be enclosed in quotes if it has spaces or commas. The variable names are not case-sensitive.

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

###### Species_Emissivity

Syntax

  Species_Emissivity SpeciesName {=} Value

Summary

  Specify the emissivity for the given species

Description

  For the SpeciesName parameter, you can either specify the actual species name (O2, N2, CH4, etc.) or the word DEFAULT for a global value applied to all unlisted species. Any species-specific values, if present, will override the DEFAULT value.

  When using a string function, the function may depend on pressure, temperature, mass fraction, or most other properties. When using mass fractions in the string function, use the species name as a suffix, as in

      Species_Emissivity char = "0.9 - 0.01*mass_fraction_epoxy"

  The function string must be enclosed in quotes if it has spaces or commas. The variable names are not case-sensitive.

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

###### Species_Enthalpy

Syntax

  Species_Enthalpy SpeciesName {=} Value

Summary

  Specify the species enthalpy for the given species

Description

  For the SpeciesName parameter, you can either specify the actual species name (O2, N2, CH4, etc.) or the word DEFAULT for a global value applied to all unlisted species. Any species-specific values, if present, will override the DEFAULT value.

  This command is only applicable when not using an external third-party library (e.g. Cantera) for property evaluation.

  When using a string function, the function may depend on pressure, temperature, mass fraction, or most other properties. When using mass fractions in the string function, use the species name as a suffix, as in

      Species_enthalpy N2 = "300/temperature + mass_fraction_n2"

  The function string must be enclosed in quotes if it has spaces or commas. The variable names are not case-sensitive.

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

###### Species_Production_Rate

Syntax

  Species_Production_Rate SpeciesName {=} Value

Summary

  warning{This command is deprecated and will be removed in the 5.18 release. It has not had an effect for several releases.}

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

###### Species_Specific_Heat

Syntax

  Species_Specific_Heat SpeciesName {=} Value

Summary

  Specify the specific heat for the given species

Description

  For the SpeciesName parameter, you can either specify the actual species name (O2, N2, CH4, etc.) or the word DEFAULT for a global value applied to all unlisted species. Any species-specific values, if present, will override the DEFAULT value.

  When using a string function, the function may depend on pressure, temperature, mass fraction, or most other properties. When using mass fractions in the string function, use the species name as a suffix, as in

      Species_Specific_Heat Al = "300/temperature + mass_fraction_n2"

  The function string must be enclosed in quotes if it has spaces or commas. The variable names are not case-sensitive.

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

###### Species_Thermal_Conductivity

Syntax

  Species_Thermal_Conductivity SpeciesName {=} Value

Summary

  Specify the thermal conductivity for the given species

Description

  For the SpeciesName parameter, you can either specify the actual species name (O2, N2, CH4, etc.) or the word DEFAULT for a global value applied to all unlisted species. Any species-specific values, if present, will override the DEFAULT value.

  When using a string function, the function may depend on pressure, temperature, mass fraction, or most other properties. When using mass fractions in the string function, use the species name as a suffix, as in

      Species_Thermal_Conductivity Al = "300/temperature + mass_fraction_n2"

  The function string must be enclosed in quotes if it has spaces or commas. The variable names are not case-sensitive.

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

###### Turbulent Mixing Model

Syntax

  Turbulent Mixing Model {=} {none | parente} [ModelArgs]…

Summary

  Specify turbulent mixing model to limit reaction chemistry

Description

  Use turbulent mixing time scale to determine rate of reaction in chemistry model using EDC 2016 Model (Parente et al. Fuel 2016). Optional model arguments for the Parente turbulent mixing model can be specified on the same line as follow:

      Turbulent Mixing Model = PARENTE c1 = val1 c2 = val2

  The gas constants and are optional arguments, and have a default value of and .

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
TurbulentMixingModel | {none | parente} | –
ModelArgs | [string]… | –

###### Use Consistently Volume Averaged Properties

Syntax

  Use Consistently Volume Averaged Properties [ With Postsmoothing SmoothingIterations ]

Summary

  Use a wider stencil to evaluate nodal properties, like density

Description

  Interpolates input fields to subcontrol volume centers to evaluate a volume average, instead of just using the nodal value. Optionally smooth the result with nodal filter iterations.

###### Vof Gas Material

Syntax

  Vof Gas Material {=} GasMaterial

Summary

  Name of the material to use for the gas phase in a VOF simulation

Description

  Name of the material to use for the gas phase in a VOF simulation.

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

###### Vof Liquid Material

Syntax

  Vof Liquid Material {=} LiquidMaterial

Summary

  Name of the material to use for the liquid phase in a VOF simulation

Description

  Name of the material to use for the liquid phase in a VOF simulation.

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

## 6.1.9. Tabular Property Library

Scope

  Property Specification For Fuego Material

Summary

  Begin specification for tabular properties

    begin Tabular Property Library LibNameTag

       Allow Positive Enthalpy Reconstruction

       Auxiliary Variable AuxVarName Expression {=} Expr

       Evaluation Caching Mode {=} {cached | none}

       Ignition Blending Time {=} Value

       Ignition Time {=} Value

       Library Hdf5 File {=} FileName

       Number Of Logged Input Clipping Events {=} Number

       Output Caching Diagnostics

       Output Library Variable LibraryVariable As OutputName [ On Output Block BlockName  ]

       Property For Clipping Events Table {=} PropertyName

       Source Term For ProgressVariableName Expression {=} Expr

       Table Interpolation Method {=} Value

       Table Units Are In {cgs | mks}

       Use Aerosol Model {aksit_moss_snl | none}

       Use Approximate Flamelet Enthalpy Reconstruction

       Use Consistently Volume Averaged Properties

       Use Field FuegoField For Library Input LibraryInput

       Use Library Source LibrarySource As SourceName

       Use Library Variable LibraryVariable For Property {absorption_coef | conserved_enthalpy | density | density_pressure_derivative | emissivity | enthalpy | heat_production_rate | mass_diffusivity | molecular_weight | scattering_coef | species_density | species_emissivity | species_enthalpy | species_production_rate | species_specific_heat | species_thermal_conductivity | specific_heat | temperature | thermal_conductivity | viscosity}

    end Tabular Property Library LibNameTag

### 6.1.9.1. Line Commands

###### Allow Positive Enthalpy Reconstruction

Syntax

  Allow Positive Enthalpy Reconstruction

Summary

  Allow consistent enthalpy reconstruction to produce positive defect values

Description

  If active, the enthalpy defect reconstruction can produce positive values for the reconstruction. Otherwise, positive values are clipped to zero.

###### Auxiliary Variable

Syntax

  Auxiliary Variable AuxVarName Expression {=} Expr

Summary

  Specifies the expression to evaluate for an auxiliary variable.

Description

  Specifies the expression to evaluate for an auxiliary variable.

Parameter | Value | Default
--- | --- | ---
AuxVarName | string | –
{=} | {= | are | is} | –
Expr | (expression) | –

###### Evaluation Caching Mode

Syntax

  Evaluation Caching Mode {=} {cached | none}

Summary

  Set property caching mode in property evaluators

Description

  If NONE, do not employ caching in the property evaluators. If CACHED, employ caching in the property evaluators.

Parameter | Value | Default
--- | --- | ---
{=} | {= | are | is} | –
PropertyCachingMode | {cached | none} | –

###### Ignition Blending Time

Syntax

  Ignition Blending Time {=} Value

Summary

  Length of time to blend flamelet model from non-ignited to igniting states

Description

  If an ignition time is specified for the flamelet model, it begins at the specified time and is gradually introduced over a finite blending time (this parameter). By “ignition time” + “blending time” all blending effects have been removed.

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

###### Ignition Time

Syntax

  Ignition Time {=} Value

Summary

  Time to begin flamelet ignition

Description

  By default ignition is immediate with the flamelet model. This option lets you delay the ignition until a specified time. Prior to that time, the mixture fraction values used in property evaluation are clamped to 0 or 1.

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

###### Library Hdf5 File

Syntax

  Library Hdf5 File {=} FileName

Summary

  Specify the name (with optional path) for the HDF5 property library generated by fuego_tabular_props

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

###### Number Of Logged Input Clipping Events

Syntax

  Number Of Logged Input Clipping Events {=} Number

Summary

  warning{ This command is deprecated and will no longer have any effect. It will be completely removed in a future version of Fuego. }

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

###### Output Caching Diagnostics

Syntax

  Output Caching Diagnostics

Summary

  Display caching statistics in the logfile.

Description

  If set, display caching statistics in the logfile. Otherwise, no output is displayed in the logfile.

###### Output Library Variable

Syntax

  Output Library Variable LibraryVariable As OutputName [ On Output Block BlockName ]

Summary

  Generates output for the requested library variable.

Description

  Provide output of the requested property library variable. If the optional output block name is specified, then the variable will only be written to that output block.

Parameter | Value | Default
--- | --- | ---
LibraryVariable | string | –
OutputName | string | –

###### Property For Clipping Events Table

Syntax

  Property For Clipping Events Table {=} PropertyName

Summary

  Set property for displaying clipping event warning log. Default: Use density for clipping event log.

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

###### Source Term For

Syntax

  Source Term For ProgressVariableName Expression {=} Expr

Summary

  Specifies the expression to evaluate.

Description

  Specifies the expression to evaluate.

Parameter | Value | Default
--- | --- | ---
ProgressVariableName | string | –
{=} | {= | are | is} | –
Expr | (expression) | –

###### Table Interpolation Method

Syntax

  Table Interpolation Method {=} Value

Summary

  Which interpolation backend to use (BSPLINE or LAGRANGE)

Description

  One may either choose a general B-spline formulation or a Lagrange polynomial as the interpolant for table lookups. The B-spline formulation has better guarantees on continuity and smoothness but is is between two to ten times more expensive to evaluate than the Lagrange basis. Lagrange polynomials are likely sufficient for tables with enough resolution for accurate reconstruction of tabulated properties.

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

###### Table Units Are In

Syntax

  Table Units Are In {cgs | mks}

Summary

  Describe the length-mass-time unit system used by the table (CGS or MKS)

Description

  Shortcut to select meter-kilogram-second (MKS) or centimeter-gram-second unit (CGS) system. This should correspond to the units your table was generated in.

Parameter | Value | Default
--- | --- | ---
UnitSystem | {cgs | mks} | –

###### Use Aerosol Model

Syntax

  Use Aerosol Model {aksit_moss_snl | none}

Summary

  Use preset aerosol model with progress variables

Description

  Activate a preset aerosol model for use with tabulated source terms, e.g. for soot modeling.

Parameter | Value | Default
--- | --- | ---
AerosolModel | {aksit_moss_snl | none} | –

###### Use Approximate Flamelet Enthalpy Reconstruction

Syntax

  Use Approximate Flamelet Enthalpy Reconstruction

Summary

  Use an inexact method of reconstructing the enthalpy defect of nonadiabatic flamelet models.

Description

  Uses an inexact method of obtaining the stoichiometric enthalpy defect for nonadiabatic strained laminar flamelet models. In cases with strong heat loss this leads to a large, persistent error and should not be used.

###### Use Consistently Volume Averaged Properties

Syntax

  Use Consistently Volume Averaged Properties

Summary

  Use a wider stencil to evaluate nodal properties, like density

Description

  Interpolates input fields to subcontrol volume centers to evaluate a volume average, instead of just using the nodal value

###### Use Field

Syntax

  Use Field FuegoField For Library Input LibraryInput

Summary

  Link a Fuego field to the specified property library input variable

Parameter | Value | Default
--- | --- | ---
FuegoField | string | –
LibraryInput | string | –

###### Use Library Source

Syntax

  Use Library Source LibrarySource As SourceName

Summary

  Link property library variable to a tabulated source term

Description

  Provide a connection between a tabular property library variable and a source term. The library will be used to evaluate the source term.

Parameter | Value | Default
--- | --- | ---
LibrarySource | string | –
SourceName | string | –

###### Use Library Variable

Syntax

  Use Library Variable LibraryVariable For Property {absorption_coef | conserved_enthalpy | density | density_pressure_derivative | emissivity | enthalpy | heat_production_rate | mass_diffusivity | molecular_weight | scattering_coef | species_density | species_emissivity | species_enthalpy | species_production_rate | species_specific_heat | species_thermal_conductivity | specific_heat | temperature | thermal_conductivity | viscosity}

Summary

  Link property library variable to a Fuego property

Description

  Provide a connection between a tabular property library variable and a Fuego property. The library will be used to evaluate the property.

  For adiabatic flamelet simulations, the following properties are required: Density and Viscosity.

  For non-adiabatic flamelet simulations, the following properties are required: Density, Viscosity, Temperature, Specific_Heat, Enthalpy, and Conserved_Enthalpy. You must also activate both the Enthalpy and Conserved_Enthalpy equations.

Parameter | Value | Default
--- | --- | ---
LibraryVariable | string | –
FuegoProperties | {absorption_coef | conserved_enthalpy | density | density_pressure_derivative | emissivity | enthalpy | heat_production_rate | mass_diffusivity | molecular_weight | scattering_coef | species_density | species_emissivity | species_enthalpy | species_production_rate | species_specific_heat | species_thermal_conductivity | specific_heat | temperature | thermal_conductivity | viscosity} | –

## 6.1.10. Property Specification For Material

Scope

  Sierra

Summary

  A set of material properties for a named material.

    begin Property Specification For Material MaterialName

       Density {=} Density

       Density Function {=} FunctionName

    end Property Specification For Material MaterialName

### 6.1.10.1. Line Commands

###### Density

Syntax

  Density {=} Density

Summary

  Material or mixture density.

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

###### Density Function

Syntax

  Density Function {=} FunctionName

Summary

  Material or mixture density function.

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