This section is referenced in the following other sections
6.12.5. Open Boundary Condition On Surface
- Scope
Fuego Region
- Summary
Defines an open (specified pressure) boundary condition on a named surface of the mesh. Optionally, specify far-field entrainment values for scalars. Any primitive variable line command below is used to specify these far-field entrainment values. One may also specify a total pressure in which case, the dynamic component will be removed for use in the pressure gradient and mass flux routine. Lastly, for turbulent flows, if the turbulence quantities are not set, then one must specify at least a characteristic length or also specify a turbulence intensity (10% assumed). These values are used to determine an entrainment value for turbulence quantities.
begin Open Boundary Condition On Surface Surfacename Value Apply Pressure Penalty [ Of PenaltyValue ] Characteristic_Length Characteristic length Emissivity Spectral File Name Name Entrain Local Values External Field For VariableName [ Species] ExtFieldName [ Of Size Value With Multiplier Multiplier ] Emissivity value Flow Must Exit Domain Function For 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 Total_Pressure Pressure function In The Direction Function For Wall Temperature functionName [ In The Direction ] Inline Function For FuncStr Integer Data For Subroutine SubName Values... Momentum Entrainment Mass_Fraction Species Mass fraction Mole_Fraction Species Mole fraction Omit Diffusion Terms Post Process Delta Area Post Process Delta Mass Flow Rate Post Process Delta Pressure Post Process Delta Thrust Postprocess FluxType Flux Of [ As aliases... ] 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 Sponge Layer Blending Function Sponge Layer Thickness Value Sponge Layer Viscosity Value Sponge Layer Viscosity Type Subroutine For Subroutine 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 Total_Pressure Subroutine Subroutine For Wall Temperature subroutineName Transparent Band Emissivity value Total_Pressure Pressure Transmissivity value Turbulence_Intensity Turbulent intensity Use Sponge Layer Wall Temperature value end Open Boundary Condition On Surface Surfacename
6.12.5.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” |
– |
Apply Pressure Penalty
- Syntax
Apply Pressure Penalty [ Of PenaltyValue ]
- Summary
Apply a penalty term on the open boundary pressure.
- Description
Apply a DG-like penalty term to the open boundary pressure. This can improve stability for tets and non-orthogonal meshes on open boundaries.
Characteristic_Length
- Syntax
Characteristic_Length Characteristic length
- Summary
Specify characteristic length for possible entrainment on open pressure specified boundary.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
Characteristic length |
real |
1.0 |
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 |
– |
Entrain Local Values
- Syntax
Entrain Local Values
- Summary
If the flow re-circulates at the open, entrain the local values rather than specified far-field values. This is applied to scalars at the open (not to velocity or pressure) and if activated will entrain the local scalar value from the previous time step rather than the user-specified far-field value.
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” |
– |
Flow Must Exit Domain
- Syntax
Flow Must Exit Domain
- Summary
warning{This command is deprecated and will no longer have any effect. It will be completely removed in a future version of Fuego.}
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 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 Total_Pressure
- Syntax
Function For Total_Pressure Pressure function In The Direction
- Summary
total pressure function name
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
Pressure function |
string |
– |
{t | x | y | z} |
– |
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… |
– |
Momentum Entrainment
- Syntax
Momentum Entrainment
- Summary
Select how momentum is entrained at the open BC.
- Description
The available options are COMPUTED, TANGENTIAL, or SPECIFIED (default).
The default momentum entrainment (SPECIFIED) entrains the user-specified velocities at the open when flow enters the domain.
The computed momentum entrainment (COMPUTED) calculates a normal velocity component using the local mass flux and density, and a tangential component from the user specification on the boundary. This can have stability issues at high vorticity, but often gives better behavior for open BCs that are primarily inflowing or entraining.
It may be preferable to omit the normal component of entrained momentum at an open BC that is primarily exiting the domain (TANGENTIAL) or to simply entrain the user-specified velocities (SPECIFIED).
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
{computed | specified | tangential} |
– |
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” |
– |
Omit Diffusion Terms
- Syntax
Omit Diffusion Terms
- Summary
Deactivate the diffusion terms on an open boundary.
- Description
It may be preferable to omit the diffusion terms on open open boundaries, but retain them (default) on confined open boundaries such as duct flow. This is only applied to the momentum equation.
Post Process Delta Area
- Syntax
Post Process Delta Area
- Summary
Request post processing of delta area on this mesh part.
- Description
Area change can be post-processed on this mesh part for laminar or turbulent flows. This option calculates the absolute value of area change after each iteration of a time step, writes it to the log and stores the last value for a given step. The value can be accessed by solution control and used as a criterion in the evaluator. To access this value use
region_name.MaxDeltaArea(n)where for area change in the x-direction n=1, area change in the y-direction n=2, and area change in the z-direction n=3.Note that
MaxDeltaArea(1)will return the maximum area change in x-direction if the request to post process this value was made on more than one boundary in a given region.
Post Process Delta Mass Flow Rate
- Syntax
Post Process Delta Mass Flow Rate
- Summary
Request post processing of delta mass flow rate on this mesh part.
- Description
Mass flow rate change can be post-processed on this mesh part for laminar or turbulent flows. This option calculates the absolute value of mass flow rate change after each iteration of a time step, writes it to the log and stores the last value for a given step. The value can be accessed by solution control and used as a criterion in the evaluator. To access this variable use
region_name.MaxDeltaMassFlowRate(0).Note that
MaxDeltaMassFlowRate(0)will return the maximum mass flow rate change if the request to post process this value was made on more than one boundary in a given region.
Post Process Delta Pressure
- Syntax
Post Process Delta Pressure
- Summary
Request post processing of delta pressure on this mesh part.
- Description
Pressure change can be post-processed on this mesh part for laminar or turbulent flows. This option calculates the absolute value of pressure change after each iteration of a time step, writes it to the log and stores the last value for a given step. The value can be accessed by solution control and used as a criterion in the evaluator. To access this value use
region_name.MaxDeltaPressure(n)where for pressure change in the x-direction n=1, pressure change in the y-direction n=2, and pressure change in the z-direction n=3.Note that
MaxDeltaPressure(1)will return the maximum pressure change in x-direction if the request to post process this value was made on more than one boundary in a given region.
Post Process Delta Thrust
- Syntax
Post Process Delta Thrust
- Summary
Request post processing of delta thrust on this mesh part.
- Description
Thrust change can be post-processed on this mesh part for laminar or turbulent flows. This option calculates the absolute value of thrust change after each iteration of a time step, writes it to the log and stores the last value for a given step. The value can be accessed by solution control and used as a criterion in the evaluator. To access this value use
region_name.MaxDeltaThrust(n)where for thrust change in the x-direction n=1, thrust change in the y-direction n=2, and thrust change in the z-direction n=3.Note that
MaxDeltaThrust(1)will return the maximum thrust change in x-direction if the request to post process this value was made on more than one boundary in a given region.
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} |
– |
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 |
– |
Sponge Layer Blending Function
- Syntax
Sponge Layer Blending Function
- Summary
Options are Heaviside or Linear. Linear gradually applies the sponge forcing across the layer, and Heaviside applies the full sponge forcing across the entire sponge layer. Default is heaviside.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
{heaviside | linear} |
– |
Sponge Layer Thickness
- Syntax
Sponge Layer Thickness Value
- Summary
Distance the sponge layer will propagate into the domain normal to the open boundary condition’s surface
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
Value |
real |
– |
Sponge Layer Viscosity
- Syntax
Sponge Layer Viscosity Value
- Summary
Value of the viscosity applied within the sponge layer
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
Value |
real |
– |
Sponge Layer Viscosity Type
- Syntax
Sponge Layer Viscosity Type
- Summary
Options are multiple or absolute. The Multiple option uses the product of the molecular viscosity specified sponge layer viscosity to calculate the forcing term. The Absolute option just uses the specified sponge layer viscosity for calculating the forcing term. Multiple is the default
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
{absolute | multiple} |
– |
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 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 Total_Pressure
- Syntax
Subroutine For Total_Pressure Subroutine
- Summary
Name of the subroutine to use for pressure.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
Subroutine |
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” |
– |
Total_Pressure
- Syntax
Total_Pressure Pressure
- Summary
Constant value for the total pressure.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
Pressure |
real |
– |
Transmissivity
- Syntax
Transmissivity value
- Summary
Constant value for transmissivity variable.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
value |
“string” |
– |
Turbulence_Intensity
- Syntax
Turbulence_Intensity Turbulent intensity
- Summary
Specify turbulent intensity for use in the calculation for the entrainment value of turbulent kinetic energy when there is possible entrainment on open pressure specified boundary.
Parameter |
Value |
Default |
|---|---|---|
{= | are | is} |
– |
|
Turbulent intensity |
real |
– |
Use Sponge Layer
- Syntax
Use Sponge Layer
- Summary
Indicator that a sponge layer should be implemented next to this open boundary condition
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” |
– |