This section is referenced in the following other sections
7.12.10. Composite Boundary Condition On Surface
- Scope
Fuego Region
- Summary
Defines a thermally-decomposing composite material wall boundary condition that outgasses flammable species when heated sufficiently.
begin Composite Boundary Condition On Surface Surfacename Value Activate Backside Convection Activate Backside Radiation Activate Particle Deposition Calculate Convection Coefficient Using Tref Tref ([Dt_Min DTmin] | []) Composite value Composite Initial_Mass_Fraction Species value Composite Material material_name Emissivity Spectral File Name Name External Field For VariableName [ Species] ExtFieldName [ Of Size Value With Multiplier Multiplier ] External Field For Composite ExtFieldName Emissivity value Function For FuncName [ In The Direction ] Function For Composite functionName [ In The Direction ] Function For Composite Initial_Mass_Fraction funcName In The Direction Function For Emissivity functionName [ In The Direction ] Function For Mass_Fraction FuncName In The Direction Function For Mole_Fraction FuncName In The Direction Function For Radiation Boundary Temperature functionName Function For Radiation Environment Temperature functionName Function For Transmissivity functionName [ In The Direction ] Function For Transparent Band Emissivity functionName [ In The Direction ] Function For Wall Temperature functionName [ In The Direction ] Inline Function For FuncStr Integer Data For Subroutine SubName Values... Interface Boundary Mass_Fraction Species Mass fraction Mole_Fraction Species Mole fraction Particle Species species_name... Post Process Yplus Postprocess FluxType Flux Of [ As aliases... ] Project Nodes Progress_Variable ProgressVariableName Value Real Data For Subroutine SubName Values... Radiation Boundary Temperature value Radiation Boundary Temperature Field FieldName Radiation Environment Temperature value Radiation Environment Temperature Field FieldName Subroutine For Subroutine Subroutine For Composite subroutineName Subroutine For Emissivity subroutineName Subroutine For Mass_Fraction Subroutine Subroutine For Mole_Fraction Subroutine Subroutine For Radiation Boundary Temperature subroutineName Subroutine For Radiation Environment Temperature subroutineName Subroutine For Transmissivity subroutineName Subroutine For Transparent Band Emissivity subroutineName Subroutine For Wall Temperature subroutineName Transparent Band Emissivity value Transmissivity value Use Equilibrium Production Model Wall Temperature value Law_Of_Wall_Roughness_Parameter Law of the Wall Roughness parameter end Composite Boundary Condition On Surface Surfacename
7.12.10.1. Line Commands
Primitivevariable
- Syntax
Primitivevariable Value
- Summary
Value for the specified variable (in consistent units). Value can be a constant or a string function of position (x,y,z), time (t), and any global variable.
The function string must be enclosed in quotes if it has spaces or commas. For example: x_velocity = “min(1, 0.1*t)”
Parameter |
Value |
Default |
|---|---|---|
{contact_angle | edc_product | gas_volume_fraction | mixture_fraction | pressure | progress_variable | scalar_variance | second_mixture_fraction | solid_volume_fraction | soot_mass_fraction | soot_nuclei_mass_fraction | temperature | turbulent_dissipation | turbulent_frequency | turbulent_helmholtz_function | turbulent_kinetic_energy | turbulent_v2 | volume_of_fluid | x_solid_velocity | x_velocity | y_solid_velocity | y_velocity | z_solid_velocity | z_velocity} |
– |
|
{= | are | is} |
– |
|
Value |
“string” |
– |
Activate Backside Convection
- Syntax
Activate Backside Convection
- Summary
Turn on model for convective heat transfer on the back side of the composite material. A convection coefficient and reference temperature must also be specified.
Activate Backside Radiation
- Syntax
Activate Backside Radiation
- Summary
Turn on model for radiative heat transfer on the back side of the composite material. A reference temperature must also be specified.
Activate Particle Deposition
- Syntax
Activate Particle Deposition
- Summary
Turn on deposition of material from the accumulation of particles on the composite material. A species name for the particles must also be supplied. Currently only one species is supported.
Calculate Convection Coefficient
- Syntax
Calculate Convection Coefficient Using Tref Tref ([Dt_Min DTmin] | [])
- Summary
Calculates the convection coefficient on the wall using a user-specified value for the reference temperature. This calculates
.
can be a constant, or a string function of time and global variables.
By default,
is set to 0 if
however a different tolerance can be supplied with
.
The optional ‘clip’ argument will clip the calculated value of
to be non-negative.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
Tref |
“string” |
– |
{= | are | is} |
– |
|
DTmin |
real |
– |
{clip} |
– |
Composite
- Syntax
Composite value
- Summary
Parameters for composite fire model.
Parameter |
Value |
Default |
|---|---|---|
{backside_convection_coefficient | backside_reference_temperature | initial_temperature | max_nonlinear_iterations | max_thickness | min_nonlinear_iterations | nodes | residual_tolerance | subcycle_safety_factor | thickness} |
– |
|
{= | are | is} |
– |
|
value |
real |
– |
Composite Initial_Mass_Fraction
- Syntax
Composite Initial_Mass_Fraction Species value
- Summary
Constant value for the initial mass fraction of selected species in the composite.
Parameter |
Value |
Default |
|---|---|---|
Species |
string |
– |
{= | are | is} |
– |
|
value |
“string” |
– |
Composite Material
- Syntax
Composite Material material_name
- Summary
Name of the Fuego material to use for the composite BC.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
material_name |
string |
– |
Emissivity Spectral File Name
- Syntax
Emissivity Spectral File Name Name
- Summary
Specify the file name for defining spectral radiation properties on a surface.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
Name |
string |
– |
External Field For
- Syntax
External Field For VariableName [ Species] ExtFieldName [ Of Size Value With Multiplier Multiplier ]
- Summary
Name of the field that is to be transferred in. For species equation, specify variable as “mass fraction of” followed by the species name for transfers associated with separated individual species field names.
Parameter |
Value |
Default |
|---|---|---|
VariableName |
string |
– |
Species |
string |
– |
{= | are | is} |
– |
|
ExtFieldName |
string |
– |
External Field For Composite
- Syntax
External Field For Composite ExtFieldName
- Summary
Name of an external field to use for composite variable.
Parameter |
Value |
Default |
|---|---|---|
{backside_convection_coefficient | backside_reference_temperature | initial_temperature | max_nonlinear_iterations | max_thickness | min_nonlinear_iterations | nodes | residual_tolerance | subcycle_safety_factor | thickness} |
– |
|
{= | are | is} |
– |
|
ExtFieldName |
string |
– |
Emissivity
- Syntax
Emissivity value
- Summary
Constant value for emissivity variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
value |
“string” |
– |
Function For
- Syntax
Function For FuncName [ In The Direction ]
- Summary
Name of function to use for the given variable, in the specified direction.
Parameter |
Value |
Default |
|---|---|---|
{contact_angle | edc_product | gas_volume_fraction | mixture_fraction | pressure | progress_variable | scalar_variance | second_mixture_fraction | solid_volume_fraction | soot_mass_fraction | soot_nuclei_mass_fraction | temperature | turbulent_dissipation | turbulent_frequency | turbulent_helmholtz_function | turbulent_kinetic_energy | turbulent_v2 | volume_of_fluid | x_solid_velocity | x_velocity | y_solid_velocity | y_velocity | z_solid_velocity | z_velocity} |
– |
|
{= | are | is} |
– |
|
FuncName |
string |
– |
Function For Composite
- Syntax
Function For Composite functionName [ In The Direction ]
- Summary
Name of function to use for the given composite fire variable, in the specified direction.
Parameter |
Value |
Default |
|---|---|---|
{backside_convection_coefficient | backside_reference_temperature | initial_temperature | max_nonlinear_iterations | max_thickness | min_nonlinear_iterations | nodes | residual_tolerance | subcycle_safety_factor | thickness} |
– |
|
{= | are | is} |
– |
|
functionName |
string |
– |
Function For Composite Initial_Mass_Fraction
- Syntax
Function For Composite Initial_Mass_Fraction funcName In The Direction
- Summary
Name of the mass fraction function to use for all species in the composite in a given direction. Note that this must be a Multicolumn function
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
funcName |
string |
– |
{t | x | y | z} |
– |
Function For Emissivity
- Syntax
Function For Emissivity functionName [ In The Direction ]
- Summary
Name of the function to use for the emissivity in the given direction (default direction = time).
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
functionName |
string |
– |
Function For Mass_Fraction
- Syntax
Function For Mass_Fraction FuncName In The Direction
- Summary
Name of the mass fraction function to use for all species in the given direction. Note that this must be a Multicolumn function
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
FuncName |
string |
– |
{t | x | y | z} |
– |
Function For Mole_Fraction
- Syntax
Function For Mole_Fraction FuncName In The Direction
- Summary
Name of the mass fraction function to use for all species in the given direction. Note that this must be a Multicolumn function
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
FuncName |
string |
– |
{t | x | y | z} |
– |
Function For Radiation Boundary Temperature
- Syntax
Function For Radiation Boundary Temperature functionName
- Summary
Name of function to use for the radiation_boundary_temperature variable
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
functionName |
string |
– |
Function For Radiation Environment Temperature
- Syntax
Function For Radiation Environment Temperature functionName
- Summary
Name of function to use for the radiation_environment_temperature variable
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
functionName |
string |
– |
Function For Transmissivity
- Syntax
Function For Transmissivity functionName [ In The Direction ]
- Summary
Name of function to use for the transmissivity variable
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
functionName |
string |
– |
Function For Transparent Band Emissivity
- Syntax
Function For Transparent Band Emissivity functionName [ In The Direction ]
- Summary
Name of function to use for the transparent emissivity band for spectral emissivity on surfaces.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
functionName |
string |
– |
Function For Wall Temperature
- Syntax
Function For Wall Temperature functionName [ In The Direction ]
- Summary
Name of function to use for the wall_temperature variable, in the specified direction.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
functionName |
string |
– |
Inline Function For
- Syntax
Inline Function For FuncStr
- Summary
warning{This command is deprecated. Regular BCs now support using string functions directly}
Parameter |
Value |
Default |
|---|---|---|
{contact_angle | edc_product | gas_volume_fraction | mixture_fraction | pressure | progress_variable | scalar_variance | second_mixture_fraction | solid_volume_fraction | soot_mass_fraction | soot_nuclei_mass_fraction | temperature | turbulent_dissipation | turbulent_frequency | turbulent_helmholtz_function | turbulent_kinetic_energy | turbulent_v2 | volume_of_fluid | x_solid_velocity | x_velocity | y_solid_velocity | y_velocity | z_solid_velocity | z_velocity} |
– |
|
{= | are | is} |
– |
|
FuncStr |
“string” |
– |
Integer Data For Subroutine
- Syntax
Integer Data For Subroutine SubName Values…
- Summary
List of integer data values to be passed down in to the user subroutine. These values may be changed by the user subroutine.
Parameter |
Value |
Default |
|---|---|---|
SubName |
string |
– |
{= | are | is} |
– |
|
integer… |
– |
Interface Boundary
- Syntax
Interface Boundary
- Summary
Mark this fluids boundary as an interface between two physical regions. Data will be interpolated across this boundary.
Mass_Fraction
- Syntax
Mass_Fraction Species Mass fraction
- Summary
Value for the mass fraction of selected species. Can be a constant value or a string function of space (x,y,z), time (t), and any global variable.
Parameter |
Value |
Default |
|---|---|---|
Species |
string |
– |
{= | are | is} |
– |
|
Mass fraction |
“string” |
– |
Mole_Fraction
- Syntax
Mole_Fraction Species Mole fraction
- Summary
Value for the mole fraction of selected species. Can be a constant value or a string function of space (x,y,z), time (t), and any global variable.
Parameter |
Value |
Default |
|---|---|---|
Species |
string |
– |
{= | are | is} |
– |
|
Mole fraction |
“string” |
– |
Particle Species
- Syntax
Particle Species species_name…
- Summary
Names of the particle species that can accumulate on the composite BC (this must be the complete list of species in the particle definition, listed in the same order as defined in the particle definition).
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
string… |
– |
Post Process Yplus
- Syntax
Post Process Yplus
- Summary
Request post processing of yplus on this mesh part.
- Description
The normalized distance to the wall (
) can be post-processed on any wall (laminar or turbulent). Yplus is calculated in a manner consistent with how it is calculated in the solution procedure. Max/min
values are provided as output at every wall. This option computes and stores the entire
field along the wall. Since this option computes
using the most recent values for all solution variables, the max/min written to the log may differ from the max/min of this field. However, these will become identical at convergence.
Note that this line command does not automatically output this field to a results file. For that, one must use the standard output line command for a nodal field using the string name,
yplus.
Postprocess
- Syntax
Postprocess FluxType Flux Of [ As aliases… ]
- Summary
Enable nodal flux post-processing for a given equation. Flux types can be “total”, “advective”, or “diffusive”. Integrated fluxes will also be output to global variables for post-processing or use in other string functions.
By default the variables will be named based on the equation and sideset they are applied to as bc_FluxType_EquationName_flux_SurfaceName. However, if you want to assign a more compact or descriptive name you can provide it with
POSTPROCESS TOTAL FLUX OF Continuity AS mdot1
When post-processing enthalpy, the average temperature is also output as a global variable. If you provide only one alias the enthalpy flux uses your alias and the average temperature is automatically named. If you provide two aliases the first is used for enthalpy and the second is used for temperature.
POSTPROCESS TOTAL FLUX OF ENTHALPY AS hFlux POSTPROCESS TOTAL FLUX OF ENTHALPY AS hFlux Tavg
When post-processing species, the post-processor is run for each species that is solved for. This means that there is no post-processor run on the last species (which is determined by a fractional balance). If you provide aliases for the species post-processor you should provide one for each post-processed species. For example, in a problem with O2, CO2, and N2 (in that order) you could use:
POSTPROCESS TOTAL FLUX OF SPECIES AS mdotO2 mdotCO2
Parameter |
Value |
Default |
|---|---|---|
FluxType |
string |
– |
{conserved_enthalpy | continuity | edc_product | enthalpy | mixture_fraction | nuclei | progress_variable | scalar_variance | second_mixture_fraction | solid_volume_fraction | soot | species | temperature | turbulent_dissipation | turbulent_frequency | turbulent_helmholtz_function | turbulent_kinetic_energy | turbulent_v2 | volume_of_fluid | x_momentum | x_solid_momentum | y_momentum | y_solid_momentum | z_momentum | z_solid_momentum} |
– |
Project Nodes
- Syntax
Project Nodes
- Summary
Allow for nodal projection on the particular mesh part.
- Description
The nodal projection of velocity is defaulted to occur on open boundary conditions only. Wall and inflow BCs are defaulted to not be projected, even on flux inflow (i.e.,
USE FLUXES) and turbulent wall nodes. This option flags the particular mesh part to be included in the nodes to be projected.
Progress_Variable
- Syntax
Progress_Variable ProgressVariableName Value
- Summary
Constant value for the progress variable of selected scalars.
Parameter |
Value |
Default |
|---|---|---|
ProgressVariableName |
string |
– |
{= | are | is} |
– |
|
Value |
real |
– |
Real Data For Subroutine
- Syntax
Real Data For Subroutine SubName Values…
- Summary
List of real data values to be passed down in to the user subroutine. These values may be changed by the user subroutine.
Parameter |
Value |
Default |
|---|---|---|
SubName |
string |
– |
{= | are | is} |
– |
|
real… |
– |
Radiation Boundary Temperature
- Syntax
Radiation Boundary Temperature value
- Summary
Constant value for radiation_boundary_temperature variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
value |
“string” |
– |
Radiation Boundary Temperature Field
- Syntax
Radiation Boundary Temperature Field FieldName
- Summary
Name of the field to use for the radiation boundary temperature.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
FieldName |
string |
– |
Radiation Environment Temperature
- Syntax
Radiation Environment Temperature value
- Summary
Constant value for radiation_environment_temperature variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
value |
“string” |
– |
Radiation Environment Temperature Field
- Syntax
Radiation Environment Temperature Field FieldName
- Summary
Name of the field to use for the radiation environment temperature.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
FieldName |
string |
– |
Subroutine For
- Syntax
Subroutine For Subroutine
- Summary
Name of the subroutine to use for this variable.
Parameter |
Value |
Default |
|---|---|---|
{contact_angle | edc_product | gas_volume_fraction | mixture_fraction | pressure | progress_variable | scalar_variance | second_mixture_fraction | solid_volume_fraction | soot_mass_fraction | soot_nuclei_mass_fraction | temperature | turbulent_dissipation | turbulent_frequency | turbulent_helmholtz_function | turbulent_kinetic_energy | turbulent_v2 | volume_of_fluid | x_solid_velocity | x_velocity | y_solid_velocity | y_velocity | z_solid_velocity | z_velocity} |
– |
|
{= | are | is} |
– |
|
Subroutine |
string |
– |
Subroutine For Composite
- Syntax
Subroutine For Composite subroutineName
- Summary
Name of the user subroutine to use for the given composite fire variable.
Parameter |
Value |
Default |
|---|---|---|
{backside_convection_coefficient | backside_reference_temperature | initial_temperature | max_nonlinear_iterations | max_thickness | min_nonlinear_iterations | nodes | residual_tolerance | subcycle_safety_factor | thickness} |
– |
|
{= | are | is} |
– |
|
subroutineName |
string |
– |
Subroutine For Emissivity
- Syntax
Subroutine For Emissivity subroutineName
- Summary
Name of the user subroutine to use for the emissivity variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
subroutineName |
string |
– |
Subroutine For Mass_Fraction
- Syntax
Subroutine For Mass_Fraction Subroutine
- Summary
Name of the subroutine to use for the mass fraction. ALL species mass fractions must be assigned by this subroutine.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
Subroutine |
string |
– |
Subroutine For Mole_Fraction
- Syntax
Subroutine For Mole_Fraction Subroutine
- Summary
Name of the subroutine to use for the mole fractions. ALL species mole fractions must be assigned by this subroutine.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
Subroutine |
string |
– |
Subroutine For Radiation Boundary Temperature
- Syntax
Subroutine For Radiation Boundary Temperature subroutineName
- Summary
Name of the user subroutine to use for the radiation_boundary_temperature variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
subroutineName |
string |
– |
Subroutine For Radiation Environment Temperature
- Syntax
Subroutine For Radiation Environment Temperature subroutineName
- Summary
Name of the user subroutine to use for the radiation_environment_temperature variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
subroutineName |
string |
– |
Subroutine For Transmissivity
- Syntax
Subroutine For Transmissivity subroutineName
- Summary
Name of the user subroutine to use for the transmissivity variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
subroutineName |
string |
– |
Subroutine For Transparent Band Emissivity
- Syntax
Subroutine For Transparent Band Emissivity subroutineName
- Summary
Name of the user subroutine to use for the transparent emissivity band for spectral emissivity on surfaces.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
subroutineName |
string |
– |
Subroutine For Wall Temperature
- Syntax
Subroutine For Wall Temperature subroutineName
- Summary
Name of the user subroutine to use for the wall_temperature variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
subroutineName |
string |
– |
Transparent Band Emissivity
- Syntax
Transparent Band Emissivity value
- Summary
Constant value to use for the emissivity in the transparent band for spectral surfaces.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
value |
“string” |
– |
Transmissivity
- Syntax
Transmissivity value
- Summary
Constant value for transmissivity variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
value |
“string” |
– |
Use Equilibrium Production Model
- Syntax
Use Equilibrium Production Model
- Summary
Change near-wall turbulence production.
- Description
This option specifies that the near wall turb_ke production term is given by:
. Modifications are made for the KW and SST model. This model is suggested when using the standard KW and SST model when a Dirichlet condition is not placed on the wall node of turbulence kinetic energy.
Wall Temperature
- Syntax
Wall Temperature value
- Summary
Value for wall_temperature variable. Can be a constant or a string function of space (x,y,z), time (t) or global variables.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
value |
“string” |
– |
Law_Of_Wall_Roughness_Parameter
- Syntax
Law_Of_Wall_Roughness_Parameter Law of the Wall Roughness parameter
- Summary
Specify dimensionless roughness factor to be used in the law-of-the-wall formulation.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
Law of the Wall Roughness parameter |
real |
9.8 |
7.12.11. Composite Interface Boundary Condition On Surface
- Scope
Fuego Region
- Summary
Defines a wall interface boundary condition that outgasses flammable species when heated sufficiently. This boundary condition may be treated as a porous composite material wall where the heat flux, mass transfer and pressure are applied from a coupled region via a transfer. This boundary enforces Dirichlet-Robin coupling.
Sign Convention: If transferring a field for composite_mass_rate or composite_species_mass_rate, the expected sign convention is positive for flows into the Fuego domain. If the transferred field has the opposite convention use the multiplier option with a value of -1.
begin Composite Interface Boundary Condition On Surface Surfacename Value Calculate Convection Coefficient Using Tref Tref ([Dt_Min DTmin] | []) Composite Initial_Mass_Fraction Species value Emissivity Spectral File Name Name External Field For VariableName [ Species] ExtFieldName [ Of Size Value With Multiplier Multiplier ] Emissivity value Function For FuncName [ In The Direction ] Function For Composite Initial_Mass_Fraction funcName In The Direction Function For Emissivity functionName [ In The Direction ] Function For Mass_Fraction FuncName In The Direction Function For Mole_Fraction FuncName In The Direction Function For Radiation Boundary Temperature functionName Function For Radiation Environment Temperature functionName Function For Transmissivity functionName [ In The Direction ] Function For Transparent Band Emissivity functionName [ In The Direction ] Function For Wall Temperature functionName [ In The Direction ] Inline Function For FuncStr Integer Data For Subroutine SubName Values... Interface Boundary Mass_Fraction Species Mass fraction Mole_Fraction Species Mole fraction Post Process Yplus Postprocess FluxType Flux Of [ As aliases... ] Project Nodes Progress_Variable ProgressVariableName Value Real Data For Subroutine SubName Values... Radiation Boundary Temperature value Radiation Boundary Temperature Field FieldName Radiation Environment Temperature value Radiation Environment Temperature Field FieldName Subroutine For Subroutine Subroutine For Composite Initial_Mass_Fraction subName Subroutine For Emissivity subroutineName Subroutine For Mass_Fraction Subroutine Subroutine For Mole_Fraction Subroutine Subroutine For Radiation Boundary Temperature subroutineName Subroutine For Radiation Environment Temperature subroutineName Subroutine For Transmissivity subroutineName Subroutine For Transparent Band Emissivity subroutineName Subroutine For Wall Temperature subroutineName Transparent Band Emissivity value Transmissivity value Use Equilibrium Production Model Wall Temperature value Law_Of_Wall_Roughness_Parameter Law of the Wall Roughness parameter end Composite Interface Boundary Condition On Surface Surfacename
7.12.11.1. Line Commands
Primitivevariable
- Syntax
Primitivevariable Value
- Summary
Value for the specified variable (in consistent units). Value can be a constant or a string function of position (x,y,z), time (t), and any global variable.
The function string must be enclosed in quotes if it has spaces or commas. For example: x_velocity = “min(1, 0.1*t)”
Parameter |
Value |
Default |
|---|---|---|
{contact_angle | edc_product | gas_volume_fraction | mixture_fraction | pressure | progress_variable | scalar_variance | second_mixture_fraction | solid_volume_fraction | soot_mass_fraction | soot_nuclei_mass_fraction | temperature | turbulent_dissipation | turbulent_frequency | turbulent_helmholtz_function | turbulent_kinetic_energy | turbulent_v2 | volume_of_fluid | x_solid_velocity | x_velocity | y_solid_velocity | y_velocity | z_solid_velocity | z_velocity} |
– |
|
{= | are | is} |
– |
|
Value |
“string” |
– |
Calculate Convection Coefficient
- Syntax
Calculate Convection Coefficient Using Tref Tref ([Dt_Min DTmin] | [])
- Summary
Calculates the convection coefficient on the wall using a user-specified value for the reference temperature. This calculates
.
can be a constant, or a string function of time and global variables.
By default,
is set to 0 if
however a different tolerance can be supplied with
.
The optional ‘clip’ argument will clip the calculated value of
to be non-negative.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
Tref |
“string” |
– |
{= | are | is} |
– |
|
DTmin |
real |
– |
{clip} |
– |
Composite Initial_Mass_Fraction
- Syntax
Composite Initial_Mass_Fraction Species value
- Summary
Constant value for the initial mass fraction of selected species in the composite.
Parameter |
Value |
Default |
|---|---|---|
Species |
string |
– |
{= | are | is} |
– |
|
value |
“string” |
– |
Emissivity Spectral File Name
- Syntax
Emissivity Spectral File Name Name
- Summary
Specify the file name for defining spectral radiation properties on a surface.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
Name |
string |
– |
External Field For
- Syntax
External Field For VariableName [ Species] ExtFieldName [ Of Size Value With Multiplier Multiplier ]
- Summary
Name of the field that is to be transferred in. For species equation, specify variable as “mass fraction of” followed by the species name for transfers associated with separated individual species field names.
Parameter |
Value |
Default |
|---|---|---|
VariableName |
string |
– |
Species |
string |
– |
{= | are | is} |
– |
|
ExtFieldName |
string |
– |
Emissivity
- Syntax
Emissivity value
- Summary
Constant value for emissivity variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
value |
“string” |
– |
Function For
- Syntax
Function For FuncName [ In The Direction ]
- Summary
Name of function to use for the given variable, in the specified direction.
Parameter |
Value |
Default |
|---|---|---|
{contact_angle | edc_product | gas_volume_fraction | mixture_fraction | pressure | progress_variable | scalar_variance | second_mixture_fraction | solid_volume_fraction | soot_mass_fraction | soot_nuclei_mass_fraction | temperature | turbulent_dissipation | turbulent_frequency | turbulent_helmholtz_function | turbulent_kinetic_energy | turbulent_v2 | volume_of_fluid | x_solid_velocity | x_velocity | y_solid_velocity | y_velocity | z_solid_velocity | z_velocity} |
– |
|
{= | are | is} |
– |
|
FuncName |
string |
– |
Function For Composite Initial_Mass_Fraction
- Syntax
Function For Composite Initial_Mass_Fraction funcName In The Direction
- Summary
Name of the mass fraction function to use for all species in the composite in a given direction. Note that this must be a Multicolumn function
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
funcName |
string |
– |
{t | x | y | z} |
– |
Function For Emissivity
- Syntax
Function For Emissivity functionName [ In The Direction ]
- Summary
Name of the function to use for the emissivity in the given direction (default direction = time).
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
functionName |
string |
– |
Function For Mass_Fraction
- Syntax
Function For Mass_Fraction FuncName In The Direction
- Summary
Name of the mass fraction function to use for all species in the given direction. Note that this must be a Multicolumn function
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
FuncName |
string |
– |
{t | x | y | z} |
– |
Function For Mole_Fraction
- Syntax
Function For Mole_Fraction FuncName In The Direction
- Summary
Name of the mass fraction function to use for all species in the given direction. Note that this must be a Multicolumn function
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
FuncName |
string |
– |
{t | x | y | z} |
– |
Function For Radiation Boundary Temperature
- Syntax
Function For Radiation Boundary Temperature functionName
- Summary
Name of function to use for the radiation_boundary_temperature variable
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
functionName |
string |
– |
Function For Radiation Environment Temperature
- Syntax
Function For Radiation Environment Temperature functionName
- Summary
Name of function to use for the radiation_environment_temperature variable
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
functionName |
string |
– |
Function For Transmissivity
- Syntax
Function For Transmissivity functionName [ In The Direction ]
- Summary
Name of function to use for the transmissivity variable
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
functionName |
string |
– |
Function For Transparent Band Emissivity
- Syntax
Function For Transparent Band Emissivity functionName [ In The Direction ]
- Summary
Name of function to use for the transparent emissivity band for spectral emissivity on surfaces.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
functionName |
string |
– |
Function For Wall Temperature
- Syntax
Function For Wall Temperature functionName [ In The Direction ]
- Summary
Name of function to use for the wall_temperature variable, in the specified direction.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
functionName |
string |
– |
Inline Function For
- Syntax
Inline Function For FuncStr
- Summary
warning{This command is deprecated. Regular BCs now support using string functions directly}
Parameter |
Value |
Default |
|---|---|---|
{contact_angle | edc_product | gas_volume_fraction | mixture_fraction | pressure | progress_variable | scalar_variance | second_mixture_fraction | solid_volume_fraction | soot_mass_fraction | soot_nuclei_mass_fraction | temperature | turbulent_dissipation | turbulent_frequency | turbulent_helmholtz_function | turbulent_kinetic_energy | turbulent_v2 | volume_of_fluid | x_solid_velocity | x_velocity | y_solid_velocity | y_velocity | z_solid_velocity | z_velocity} |
– |
|
{= | are | is} |
– |
|
FuncStr |
“string” |
– |
Integer Data For Subroutine
- Syntax
Integer Data For Subroutine SubName Values…
- Summary
List of integer data values to be passed down in to the user subroutine. These values may be changed by the user subroutine.
Parameter |
Value |
Default |
|---|---|---|
SubName |
string |
– |
{= | are | is} |
– |
|
integer… |
– |
Interface Boundary
- Syntax
Interface Boundary
- Summary
Mark this fluids boundary as an interface between two physical regions. Data will be interpolated across this boundary.
Mass_Fraction
- Syntax
Mass_Fraction Species Mass fraction
- Summary
Value for the mass fraction of selected species. Can be a constant value or a string function of space (x,y,z), time (t), and any global variable.
Parameter |
Value |
Default |
|---|---|---|
Species |
string |
– |
{= | are | is} |
– |
|
Mass fraction |
“string” |
– |
Mole_Fraction
- Syntax
Mole_Fraction Species Mole fraction
- Summary
Value for the mole fraction of selected species. Can be a constant value or a string function of space (x,y,z), time (t), and any global variable.
Parameter |
Value |
Default |
|---|---|---|
Species |
string |
– |
{= | are | is} |
– |
|
Mole fraction |
“string” |
– |
Post Process Yplus
- Syntax
Post Process Yplus
- Summary
Request post processing of yplus on this mesh part.
- Description
The normalized distance to the wall (
) can be post-processed on any wall (laminar or turbulent). Yplus is calculated in a manner consistent with how it is calculated in the solution procedure. Max/min
values are provided as output at every wall. This option computes and stores the entire
field along the wall. Since this option computes
using the most recent values for all solution variables, the max/min written to the log may differ from the max/min of this field. However, these will become identical at convergence.
Note that this line command does not automatically output this field to a results file. For that, one must use the standard output line command for a nodal field using the string name,
yplus.
Postprocess
- Syntax
Postprocess FluxType Flux Of [ As aliases… ]
- Summary
Enable nodal flux post-processing for a given equation. Flux types can be “total”, “advective”, or “diffusive”. Integrated fluxes will also be output to global variables for post-processing or use in other string functions.
By default the variables will be named based on the equation and sideset they are applied to as bc_FluxType_EquationName_flux_SurfaceName. However, if you want to assign a more compact or descriptive name you can provide it with
POSTPROCESS TOTAL FLUX OF Continuity AS mdot1
When post-processing enthalpy, the average temperature is also output as a global variable. If you provide only one alias the enthalpy flux uses your alias and the average temperature is automatically named. If you provide two aliases the first is used for enthalpy and the second is used for temperature.
POSTPROCESS TOTAL FLUX OF ENTHALPY AS hFlux POSTPROCESS TOTAL FLUX OF ENTHALPY AS hFlux Tavg
When post-processing species, the post-processor is run for each species that is solved for. This means that there is no post-processor run on the last species (which is determined by a fractional balance). If you provide aliases for the species post-processor you should provide one for each post-processed species. For example, in a problem with O2, CO2, and N2 (in that order) you could use:
POSTPROCESS TOTAL FLUX OF SPECIES AS mdotO2 mdotCO2
Parameter |
Value |
Default |
|---|---|---|
FluxType |
string |
– |
{conserved_enthalpy | continuity | edc_product | enthalpy | mixture_fraction | nuclei | progress_variable | scalar_variance | second_mixture_fraction | solid_volume_fraction | soot | species | temperature | turbulent_dissipation | turbulent_frequency | turbulent_helmholtz_function | turbulent_kinetic_energy | turbulent_v2 | volume_of_fluid | x_momentum | x_solid_momentum | y_momentum | y_solid_momentum | z_momentum | z_solid_momentum} |
– |
Project Nodes
- Syntax
Project Nodes
- Summary
Allow for nodal projection on the particular mesh part.
- Description
The nodal projection of velocity is defaulted to occur on open boundary conditions only. Wall and inflow BCs are defaulted to not be projected, even on flux inflow (i.e.,
USE FLUXES) and turbulent wall nodes. This option flags the particular mesh part to be included in the nodes to be projected.
Progress_Variable
- Syntax
Progress_Variable ProgressVariableName Value
- Summary
Constant value for the progress variable of selected scalars.
Parameter |
Value |
Default |
|---|---|---|
ProgressVariableName |
string |
– |
{= | are | is} |
– |
|
Value |
real |
– |
Real Data For Subroutine
- Syntax
Real Data For Subroutine SubName Values…
- Summary
List of real data values to be passed down in to the user subroutine. These values may be changed by the user subroutine.
Parameter |
Value |
Default |
|---|---|---|
SubName |
string |
– |
{= | are | is} |
– |
|
real… |
– |
Radiation Boundary Temperature
- Syntax
Radiation Boundary Temperature value
- Summary
Constant value for radiation_boundary_temperature variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
value |
“string” |
– |
Radiation Boundary Temperature Field
- Syntax
Radiation Boundary Temperature Field FieldName
- Summary
Name of the field to use for the radiation boundary temperature.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
FieldName |
string |
– |
Radiation Environment Temperature
- Syntax
Radiation Environment Temperature value
- Summary
Constant value for radiation_environment_temperature variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
value |
“string” |
– |
Radiation Environment Temperature Field
- Syntax
Radiation Environment Temperature Field FieldName
- Summary
Name of the field to use for the radiation environment temperature.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
FieldName |
string |
– |
Subroutine For
- Syntax
Subroutine For Subroutine
- Summary
Name of the subroutine to use for this variable.
Parameter |
Value |
Default |
|---|---|---|
{contact_angle | edc_product | gas_volume_fraction | mixture_fraction | pressure | progress_variable | scalar_variance | second_mixture_fraction | solid_volume_fraction | soot_mass_fraction | soot_nuclei_mass_fraction | temperature | turbulent_dissipation | turbulent_frequency | turbulent_helmholtz_function | turbulent_kinetic_energy | turbulent_v2 | volume_of_fluid | x_solid_velocity | x_velocity | y_solid_velocity | y_velocity | z_solid_velocity | z_velocity} |
– |
|
{= | are | is} |
– |
|
Subroutine |
string |
– |
Subroutine For Composite Initial_Mass_Fraction
- Syntax
Subroutine For Composite Initial_Mass_Fraction subName
- Summary
Name of the subroutine to use for the mass fraction. ALL species mass fractions must be assigned by this subroutine.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
subName |
string |
– |
Subroutine For Emissivity
- Syntax
Subroutine For Emissivity subroutineName
- Summary
Name of the user subroutine to use for the emissivity variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
subroutineName |
string |
– |
Subroutine For Mass_Fraction
- Syntax
Subroutine For Mass_Fraction Subroutine
- Summary
Name of the subroutine to use for the mass fraction. ALL species mass fractions must be assigned by this subroutine.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
Subroutine |
string |
– |
Subroutine For Mole_Fraction
- Syntax
Subroutine For Mole_Fraction Subroutine
- Summary
Name of the subroutine to use for the mole fractions. ALL species mole fractions must be assigned by this subroutine.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
Subroutine |
string |
– |
Subroutine For Radiation Boundary Temperature
- Syntax
Subroutine For Radiation Boundary Temperature subroutineName
- Summary
Name of the user subroutine to use for the radiation_boundary_temperature variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
subroutineName |
string |
– |
Subroutine For Radiation Environment Temperature
- Syntax
Subroutine For Radiation Environment Temperature subroutineName
- Summary
Name of the user subroutine to use for the radiation_environment_temperature variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
subroutineName |
string |
– |
Subroutine For Transmissivity
- Syntax
Subroutine For Transmissivity subroutineName
- Summary
Name of the user subroutine to use for the transmissivity variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
subroutineName |
string |
– |
Subroutine For Transparent Band Emissivity
- Syntax
Subroutine For Transparent Band Emissivity subroutineName
- Summary
Name of the user subroutine to use for the transparent emissivity band for spectral emissivity on surfaces.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
subroutineName |
string |
– |
Subroutine For Wall Temperature
- Syntax
Subroutine For Wall Temperature subroutineName
- Summary
Name of the user subroutine to use for the wall_temperature variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
subroutineName |
string |
– |
Transparent Band Emissivity
- Syntax
Transparent Band Emissivity value
- Summary
Constant value to use for the emissivity in the transparent band for spectral surfaces.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
value |
“string” |
– |
Transmissivity
- Syntax
Transmissivity value
- Summary
Constant value for transmissivity variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
value |
“string” |
– |
Use Equilibrium Production Model
- Syntax
Use Equilibrium Production Model
- Summary
Change near-wall turbulence production.
- Description
This option specifies that the near wall turb_ke production term is given by:
. Modifications are made for the KW and SST model. This model is suggested when using the standard KW and SST model when a Dirichlet condition is not placed on the wall node of turbulence kinetic energy.
Wall Temperature
- Syntax
Wall Temperature value
- Summary
Value for wall_temperature variable. Can be a constant or a string function of space (x,y,z), time (t) or global variables.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
value |
“string” |
– |
Law_Of_Wall_Roughness_Parameter
- Syntax
Law_Of_Wall_Roughness_Parameter Law of the Wall Roughness parameter
- Summary
Specify dimensionless roughness factor to be used in the law-of-the-wall formulation.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
Law of the Wall Roughness parameter |
real |
9.8 |