Inputs

The Inputs package defines a set of classes used to configure and import all the necessary parameters for running OpenSTREAM simulations. This includes:

These input definitions form the backbone of each simulation setup, ensuring consistency, flexibility, and clarity across different solver frameworks.

class Inputs.FluidProperties(P, modelObj)

FLUIDPROPERTIES Class for managing thermophysical properties of a fluid

This class encapsulates saturated and generic fluid properties used in thermal-hydraulic simulations. Saturated properties are computed based on system pressure and stored as class properties. Generic properties (e.g., temperature, density, viscosity) are computed dynamically using enthalpy and pressure.

Constructor Summary
FluidProperties(P, modelObj)

FLUIDPROPERTIES Constructor for FluidProperties class

Initializes fluid properties at given pressure(s) using CoolProp. Saturated properties are computed and assigned to each object instance.

Inputs:

  • P — Vector of system pressures [Pa]

  • modelObj — Model object containing fluid name and property assumptions

Property Summary
ALPHAF = 1

Saturated liquid thermal diffusivity [m^2/s]

ALPHAG = 1

Saturated vapor thermal diffusivity [m^2/s]

CPF = 1

Saturated liquid constant pressure specific heat [J/kg/K]

CPG = 1

Saturated vapor constant pressure specific heat [J/kg/K]

FLUID = 'WATER'

Coolprop fluid identifier

HF = 1

Saturated liquid enthalpy [J/kg]

HFG = 0

Latent heat of evaporation [J/kg]

HG = 1

Saturated vapor enthalpy [J/kg]

KF = 1

Saturated liquid thermal conductivity [W/m/K]

KG = 1

Saturated vapor thermal conductivity [W/m/K]

MUF = 1

Saturated liquid viscosity [Pa.s]

MUG = 1

Saturated vapor viscosity [Pa.s]

PCRIT = 1

Critical pressure [-]

PRANDTLF = 1

Saturated liquid Prandtl number [-]

PRANDTLG = 1

Saturated vapor Prandtl number [-]

PRESSURE = 1

System pressure [Pa]

PROPERTIES = 'SATURATED'

Fluid property assumptions from Inputs.Model.PROPERTIES

RHOF = 1

Saturated liquid mass density [kg/m^3]

RHOG = 1

Saturated vapor mass density [kg/m^3]

SIGMA = 1

Surface tension [N/m]

TSAT = 1

Saturated fluid temperature [K]

Method Summary
ALPHAL(H)

ALPHAL Liquid thermal diffusivity [m^2/s]

Behavior depends on property assumption model (Inputs.Model.PROPERTIES)

ALPHAV(H)

ALPHAV Vapor thermal diffusivity [m^2/s]

Behavior depends on property assumption model (Inputs.Model.PROPERTIES)

CPL(H)

CPL Liquid constant pressure specific heat [J/kg/K]

Behavior depends on property assumption model (Inputs.Model.PROPERTIES)

CPV(H)

CPV Vapor constant pressure specific heat [J/kg/K]

Behavior depends on property assumption model (Inputs.Model.PROPERTIES)

H(T)

H Fluid enthalpy at given temperature and system pressure [J/kg]

KL(H)

KL Liquid thermal conductivity [W/m/K]

Behavior depends on property assumption model (Inputs.Model.PROPERTIES)

KV(H)

KV Vapor thermal conductivity [W/m/K]

Behavior depends on property assumption model (Inputs.Model.PROPERTIES)

MUL(H)

MUL Liquid dynamic viscosity [Pa.s]

Behavior depends on property assumption model (Inputs.Model.PROPERTIES)

MUV(H)

MUV Vapor dynamic viscosity [Pa.s]

Behavior depends on property assumption model (Inputs.Model.PROPERTIES)

PRANDTLL(H)

PRANDTLL Liquid Prandtl number [-]

Behavior depends on property assumption model (Inputs.Model.PROPERTIES)

PRANDTLV(H)

PRANDTLV Vapor Prandtl number [-]

Behavior depends on property assumption model (Inputs.Model.PROPERTIES)

RHOL(H)

RHOL Liquid mass density [kg/m^3]

Behavior depends on property assumption model (Inputs.Model.PROPERTIES)

RHOV(H)

RHOV Vapor mass density [kg/m^3]

Behavior depends on property assumption model (Inputs.Model.PROPERTIES)

T(H)

T Fluid temperature at given enthalpy and system pressure [K]

Enthalpy is clamped between HMIN and HMAX to ensure valid CoolProp input

plot(H)

PLOT Plot properties for given enthalpy vector

transient(param, opt)

TRANSIENT Generate transient distribution array for parameter param

class Inputs.Input(inputFilePath, key, val)

Bases: dynamicprops, matlab.mixin.Copyable

INPUT Abstract superclass for input-handling classes

Provides core functionality for reading, validating, and managing structured input data. Supports dynamic property creation, default value handling, and solver-dependent customization.

Constructor Summary
Input(inputFilePath, key, val)

INPUT Constructor for Input class

Parses input file and optionally filters entries by key-value pair. Adds dynamic property ‘inputStruct’ to hold parsed data.

Inputs:

  • inputFilePath — Path to input file (string)

  • key — Field name to filter by (optional)

  • val — Value to match for filtering (optional)

Property Summary
extra = struct.empty()

Stores unused input entries for reference or debugging

warnings = struct.empty()

Stores warning messages generated during input parsing

Method Summary
applySolverDependentProperties(solverName)

APPLYSOLVERDEPENDENTPROPERTIES Applies solver-specific property values based on dependency flags

Returns a copy of the object with updated properties

static convert2JSON(inputFilePath)

CONVERT2JSON Converts input file contents to JSON-formatted string

defaultValueUsedReport(propNames, propValues)

DEFAULTVALUEUSEDREPORT Generates report of properties for which default values were used

Can print or return formatted string array

listInputProperties(opts)

LISTINPUTPROPERTIES Returns list of protected property names for the object

Optionally excludes specified properties

static validateFunctionHandleInput(handleString)

VALIDATEFUNCTIONHANDLEINPUT Validates safety of function handle string

Throws error if restricted keywords are detected

validateInputEntry(objPropname, opts)

VALIDATEINPUTENTRY Validates whether a property entry is specified or defaulted

Throws error if required entry is missing or empty Returns flags and default value if applicable

static writeInputFile(filePathName, fidMode, varargin)

WRITEINPUTFILE Writes input data to file in standard format

Accepts name-value pairs and optional file mode

class Inputs.BoundaryConditions(filePath, geometryObjInput)

Bases: Inputs.Input

BOUNDARYCONDITIONS Class for defining and managing boundary condition parameters

This class provides access to boundary condition inputs and saturated fluid properties at system pressure. It is used by the solvers to initialize and manage inlet conditions, power distributions, and fluid state calculations.

Key Features:

  • Parses input files and assigns values to boundary condition fields.

  • Interfaces with fluid property libraries to compute saturation and inlet thermodynamic states.

  • Validates consistency between geometry and power mesh definitions.

  • Supports plotting of boundary condition time series.

Constructor Summary
BoundaryConditions(filePath, geometryObjInput)

BOUNDARYCONDITIONS Constructor for BoundaryConditions class

Parses input file and initializes boundary condition parameters. Validates consistency with geometry and applies default values if needed.

Inputs:

  • filePath — Path to input file (optional)

  • geometryObjInput — Geometry object for validation

Property Summary
HIN = []

Inlet enthalpy [J/kg]

MFLOW = []

Mass flow rate [kg/s]

POWER = 0

Total power [W]

PRESSURE = []

System pressure [Pa]

TIME

Simulation time [s]

WMESH = 1

Relative power node size distribution [m]

WPOWER = 1

Relative power distribution(s) [-]

Method Summary
DHIN(fluidObj)

DHIN Inlet subcooling enthalpy (HF - HIN) [J/kg]

DTIN(fluidObj)

DTIN Inlet subcooling temperature (TSAT - TIN) [K]

HF(fluidObj)

HF Liquid saturated enthalpy at system pressure using fluid object [J/kg]

HG(fluidObj)

HG Vapor saturated enthalpy at system pressure using fluid object [J/kg]

TIN(fluidObj)

TIN Inlet temperature based on inlet enthalpy and pressure [K]

TSAT(fluidObj)

TSAT Saturation temperature at system pressure using fluid object [K]

XIN(fluidObj)

XIN Inlet equilibrium quality [-]

plot(fluidObj, opt)

PLOT Generates plots of boundary condition parameters over time

Inputs:

  • fluidObj — FluidProperties object

  • opt — Struct with fields:

    • display — Cell array of parameters to plot

    • tIdx — Time indices to include

    • unitTemp — Temperature unit (‘K’ or ‘C’)

static writeInputFile(filePathName, TIME, PRESSURE, HIN, MFLOW, varargin)

WRITEINPUTFILE Writes boundary condition data to input file

Inputs:

  • filePathName — Path to output file

  • TIME — Time value [s]

  • PRESSURE — Pressure value [Pa]

  • HIN — Enthalpy value [J/kg]

  • MFLOW — Mass flow rate [kg/s]

  • varargin — Additional name-value pairs

class Inputs.InputSet(opts)

INPUTSET Class for managing a complete set of input objects

This class initializes and stores all input components required for a simulation run. It handles model, options, geometry, and boundary condition inputs, and sets up logging via a Session object. It also supports applying solver-dependent property modifications.

Constructor Summary
InputSet(opts)

INPUTSET Constructor for InputSet class

Initializes all input objects and sets up logging session. Parses input files and handles warnings.

Inputs:

  • opts — Struct with fields:

    • modelFilePath, modelID

    • optionsFilePath, optionsID

    • geometryFilePath, geometryID

    • bcFilePath

    • LOGMODE, sessionName, sessionDirName

    • sessionParentDir, overwriteSessionFiles

Property Summary
bc

BoundaryConditions input object

geometry

Geometry input object

model

Model input object

options

Options input object

session

Session object for logging and file management

Method Summary
applySolverDependentProps(inputSet, solverName)

APPLYSOLVERDEPENDENTPROPS Applies solver-dependent property modifications to all input objects

Useful for customizing inputs based on selected solver

Inputs:

  • inputSet — InputSet object

  • solverName — Name of the solver to apply dependencies for

class Inputs.Geometry(filePath, geometryID)

Bases: Inputs.Input

GEOMETRY Class for defining and managing geometrical input parameters

This class reads and stores geometrical parameters from an input file. It supports calculations of derived quantities such as hydraulic diameter, area-based diameter, and wall perimeter ratios.

Constructor Summary
Geometry(filePath, geometryID)

GEOMETRY Constructor for Geometry class

Parses geometry input file and initializes properties. Applies default values if no input is provided.

Inputs:

  • filePath — Path to geometry input file

  • geometryID — Identifier for geometry configuration

Property Summary
ANGLE = 0

Inclination angle [rad]

AREA = 1

Coolant area [m^2]

ID

Channel identifier

LENGTH = 1

Axial length [m]

PERIM = 1

Perimeter(s) of the channel walls [m]

Method Summary
ADIAM()

ADIAM Diameter based on coolant cross-section area [m]

Formula: \(2 \sqrt{\frac{\text{AREA}}{\pi}}\)

HDIAM()

HDIAM Hydraulic diameter [m]

Formula: \(4 \frac{Area}{Total perimeter}\)

NWALL()

NWALL Number of wall segments defined by PERIM

RWALL()

RWALL Relative contribution of each wall segment to total perimeter [-]

static writeInputFile(filePathName, ID, varargin)

Writes geometry input data to file

Inputs:

  • filePathName — Path to output file

  • ID — Geometry identifier

  • varargin — Additional name-value pairs for geometry properties

class Inputs.Model(filePath, modelID)

Bases: Inputs.Input

MODEL Class for defining and managing physical model configuration

This class encapsulates all physical modeling parameters used in the simulations, including fluid properties, regime transitions, wall and interfacial exchange models for all solvers. It reads model data from input files and handles default values as well as input validation.

Constructor Summary
Model(filePath, modelID)

MODEL Constructor for Model class

Parses model input file and initializes properties. Applies default values and validates entries.

Inputs:

  • filePath — Path to model input file

  • modelID — Identifier for model configuration

Property Summary
ANGLE = 0

Flow axis angle from vertical [deg]

BASEEQTHICK = 'RISO'

Equilibrium base film thickness model selected from InputEnums.BASEEQTHICK

BASEEQTHICKCOEF = [5.37E-5-0.641.21]

Equilibrium base film thickness coefficients [-]

BASEYPLUS = 15

Equilibrium base film y+ value [-]

BTHTM = 'VAPOR'

Boiling transition wall heat transfer model selected from InputEnums.BTHTM

BTMTM = 'TPFM'

Boiling transition wall momentum transfer model selected from InputEnums.BTMTM

BUBBLEDRAG = 'STOKES'

Bubble drag model selected from InputEnums.BUBBLEDRAG

BUBBLEDRAGCOEF = 0.45

Bubble constant drag coefficient [-]

CBT = 'NONE'

Critical Boiling Transition model selected from InputEnums.CBT

CBTELEVATION = 1

Critical Boiling Transition Elevation [m]

CBTKEFFECT = [00]

Grid effect coefficients (\(1 + C(1) \exp(C(2) z)\)) [-]

CBTMULT = @(z)1

Critical boiling Heat flux multiplier function

CSTWAVEFREQ = 100

Imposed constant wave frequency [Hz]

DEPENHANCEMENT = 'NONE'

Drop deposition enhancement model due to local perturbations selected from InputEnums.DEPENHANCEMENT

DEPOSITION = 'OKAWA'

Drop deposition model selected from InputEnums.DEPOSITION

DITTUSBOELTERCOEF = [0.0230.80.4]

Dittus-Boelter coefficients [-]

DROPDIAM = 1E-3

Drop diameter [mm]

DROPDRAG = 'VISCOUS'

Drop drag model selected from InputEnums.DROPDRAG

DROPDRAGCOEF = 0.45

Drop constant drag coefficient [-]

DROPSLIP = 1.0

Drop/vapor velocity ratio [-]

DTMFB = 100

Minimum film boiling temperature from saturation [K]

ENTRAINMENT = 'OKAWA2003'

Film entrainment model selected from InputEnums.ENTRAINMENT

EQSTROUHAL = 'RISO'

Equilibrium wave Strouhal number model selected from InputEnums.EQSTROUHAL

EQSTROUHALCOEF = [1.1236E-40.50.0]

Equilibrium wave Strouhal number coefficients [-]

FLUID = 'WATER'

CoolProp fluid identifier

FRICTION = [0.2-0.20]

Wall friction coefficients [-]

G = 9.81

Gravitational acceleration [m/s^2]

ID

Identifier for the model configuration

INTAREA = 'DISPGAS2DISPLIQ'

Interfacial area model selected from InputEnums.INTAREA

INTLENGTH = 'CONSTANT'

Interfacial length scale model model selected from InputEnums.INTLENGTH

INTLENGTHLCST = 2E-3

Dispersed liquid constant interfacial length scale [m]

INTLENGTHVCST = 2E-3

Dispersed gas constant interfacial length scale [m]

INTNU = 'RELAXATION'

Interfacial heat transfer model selected from InputEnums.INTNU

INTNULCST = 2.0

Dispersed liquid constant interfacial Nusselt number [-]

INTNUVCST = 2.0

Dispersed gas constant interfacial Nusselt number [-]

INTTRANSH = 'BULK'

Interfacial enthalpy transfer model selected from InputEnums.INTTRANSH

KBLOCKRATIO = [00]

Blockage ratios of local perturbations [-]

KLOC = [00]

Elevation of local perturbations [m]

KLOSS = [00]

Pressure loss coefficients of local perturbations [-]

KTRELAX = NaN

Thermal relaxation time at local perturbations [s]

KTUNING = [00]

Drop deposition enhancement tuning coefficients [-]

LOCRELVEL = 'AREAMEAN'

Local relative phase velocity model selected from InputEnums.LOCRELVEL

MFBT = 'NONE'

Minimum Film Boiling Transition model selected from InputEnums.MFBT

MOMENTBASE = 'FULLNOP'

Base film momentum conservation model selected from InputEnums.MOMENTBASE

MOMENTDROP = 'SLIP'

Drop momentum conservation model selected from InputEnums.MOMENTDROP

MOMENTFILM = 'ALGEBRAIC'

Film momentum conservation model selected from InputEnums.MOMENTFILM

MOMENTGAS = 'MIXTURE'

Gas momentum conservation model selected from InputEnums.MOMENTGAS

MOMENTLIQUID = 'MIXTURE'

Liquid momentum conservation model selected from InputEnums.MOMENTLIQUID

MOMENTWAVE = 'FULL'

Wave momentum conservation model selected from InputEnums.MOMENTWAVE

NEARWALLEQOAF = false

Near-wall equilibrium at onset of annular two-phase flow

NEARWALLH = 'RATIO'

Near-wall equilibrium enthalpy model selected from InputEnums.NEARWALLH

NEARWALLHRATIO = 1.0

Near-wall equilibrium enthalpy ratio [-]

NEARWALLRATIO = 0.5

Near-wall mass flow distribution ratio [-]

NEARWALLRELAX = 'QUALITY'

Near-wall energy transfer time relaxation model selected from InputEnums.NEARWALLRELAX

NEARWALLRELAXCOEF = [0.1E-31/30.05]

Near-wall energy transfer time relaxation coefficients for void option

NEARWALLRELAXT = [1.00.50.30.10.1]

Near-wall energy transfer relaxation time array [s]

NEARWALLRELAXX = [-0.5-0.25-0.10.01.0]

Near-wall exchange relaxation time thermodynamic quality [-]

NNODES = 100

Number of axial nodes used in the simulation

OAF = 'WALLIS'

Onset of annular flow model selected from InputEnums.OAF

OAFBASERATIO = 0.5

Base/Film mass ratio at onset of annular flow [-]

OAFDROPRATIO = 0.7

Drop/Liquid mass ratio at onset of annular flow [-]

OAFENTRAINED = 'EQUILIBRIUM'

Entrained drop model at onset of annular flow selected from InputEnums.OAFENTRAINED

OAFFILMSPLIT = 'EQUILIBRIUM'

Film mass flow split model at onset of annular flow selected from InputEnums.OAFFILMSPLIT

OAFTRANSITION = [0.100.0]

Annular flow transition function parameters (sigmoid width/location wrt OAF) [m]

OKAWACOEFS = [3200.1114.79E-41]

Coefficients of Okawa entrainment model [-]

POSFILM = true

Positive film flow rate/thickness model

PROPERTIES = 'SATURATED'

Assumption model for fluid properties selected from InputEnums.FLUIDPROPERTIES

RANZMARSHALLLCST = [20.61/21/3]

Dispersed liquid Ranz-Marshall coefficients [-]

RANZMARSHALLVCST = [20.61/21/3]

Dispersed gas Ranz-Marshall coefficients [-]

RELAXCONDCOEF = [0.1E-31/30.050.0]

Interfacial condensation time relaxation coefficients for void option

RELAXEVAPCOEF = [0.1E-31/31E-50.0]

Interfacial evaporation time relaxation coefficients for void option

RELAXTB = 0.2

Base film / wave mass exchange relaxation time [s]

RELAXTCOND = [1.00.50.30.10.1]

Interfacial condensation relaxation time array [s]

RELAXTEVAP = [0.30.30.30.30.3]

Interfacial evaporation relaxation time array [s]

RELAXTW = 0.2

Wave number density relaxation time [s]

RELAXX = [-0.5-0.25-0.10.01.0]

Interfacial phase change relaxation time thermodynamic quality [-]

RELVELCST = 1.0

Multiplication factor to the local relative velocity [-]

SHAPEFACTORCOEF = [1.325E52]

Wave shape factor coefficients [-]

SLIP = 1

Phase velocity ratio [-]

SOLVERDEPENDENTPROPS = struct("VAPORFRIC", ... )

Mapping of solver-dependent properties and their values

SPHTM = 'DITTUSBOELTER'

Single-phase wall heat transfer model selected from InputEnums.SPHTM

SPMTM = 'BLASIUS'

Single-phase wall momentum transfer model selected from InputEnums.SPMTM

THERMALNONEQ = 'EQUILIBRIUM'

Thermal non-equilibrium model selected from InputEnums.THERMALNONEQ

THERMALRELAX = 'QUALITY'

Thermal non-equilibrium time relaxation model selected from InputEnums.THERMALRELAX

THINFILMFRIC = 'TURBULENT'

Thin film wall friction model selected from InputEnums.THINFILMFRIC

THINFILMTHICK = 1E-4

Minimum thin film thickness [m]

THINWAVETHICK = 1E-5

Minimum thin wave thickness [m]

TPFM = 'HOMOGENEOUS'

Two-phase friction multiplier model selected from InputEnums.TPFM

TPHTM = 'THOM'

Two-phase wall heat transfer model selected from InputEnums.TPHTM

TPKM = 'HOMOGENEOUS'

Two-phase local loss multiplier model selected from InputEnums.TPKM

VAPORFRIC = 'SOLVER_DEPENDENT'

Vapor friction model selected from InputEnums.VAPORFRIC

VAPORFRICCST = 0.005

Vapor friction constant [-]

VOID = 'HOMOGENEOUS'

Void fraction model selected from InputEnums.VOID

WAVEBASEINT = 'VAPORSHEAR'

Wave / base film interfacial momentum transfer model selected from InputEnums.WAVEBASEINT

WAVEDRAGCOEF = [0.021.350E50.437]

Wave drag coefficient [-]

WAVEFREQUENCY = 'RELAXATION'

Wave number density model selected from InputEnums.WAVEFREQUENCY

WAVEMIXCOEF = 2

Base film / wave turbulent mixing coefficient

WBOILINGN = 2

Wall boiling function exponent [-]

WBOILINGXSAT = 0

Equilibrium thermodynamic quality at onset of saturated wall boiling [-]

WBOILINGXSUB = -0.2

Equilibrium thermodynamic quality at onset of subcooled wall boiling [-]

Method Summary
static writeInputFile(filePathName, ID, varargin)

WRITEINPUTFILE Writes model configuration data to input file

Inputs: - filePathName — Path to output file - ID — Model identifier - varargin — Additional name-value pairs for model properties

class Inputs.Options(filePath, optionsID)

Bases: Inputs.Input

OPTIONS Class for defining and managing numerical solver options

This class encapsulates all numerical parameters used in the simulations, including time stepping, convergence criteria, and relaxation factors for all solvers. It reads options data from input files and handles default values as well as input validation.

Constructor Summary
Options(filePath, optionsID)

MODEL Constructor for Options class

Parses options input file and initializes properties. Applies default values and validates entries.

Inputs:

  • filePath — Path to options input file

  • optionsID — Identifier for options configuration

Property Summary
AXIALINTERP = 'next'

Method for interpolating axial power distribution

ERRORFW = 1E-1

Wave frequency error target in inner iterations [Hz]

ERRORH = 1E-1

Enthalpy error target in inner iterations [J/kg]

ERRORP = 1E-1

Pressure error target in inner iterations [Pa]

ERRORU = 1E-4

Velocity error target in inner iterations [m/s]

ERRORUD = 1E-2

Drop velocity error target in inner iterations [m/s]

ERRORUF = 1E-2

Film velocity error target in inner iterations [m/s]

ERRORW = 1E-3

Mass flow rate error target in inner iterations [kg/s]

ERRORWF = 1E-4

Film mass flow rate error target in inner iterations [kg/s/m]

ID

Identifier for the options configuration

MAXITER = 100

Maximum number of inner iterations per time step

RELAXFW = 0.5

Relaxation factor for the wave number conservation equation [-]

RELAXHL = 1

Relaxation factor for the liquid energy conservation equation [-]

RELAXHM = 1

Relaxation factor for the mixture energy conservation equation [-]

RELAXHV = 0.8

Relaxation factor for the vapor energy conservation equation [-]

RELAXPM = 1

Relaxation factor for the mixture momentum conservation equation [-]

RELAXUB = 0.2

Relaxation factor for the base momentum conservation equation [-]

RELAXUD = 0.2

Relaxation factor for the drop momentum conservation equation [-]

RELAXUF = 0.2

Relaxation factor for the film momentum conservation equation [-]

RELAXUL = 0.5

Relaxation factor for the liquid momentum conservation equation [-]

RELAXUV = 0.5

Relaxation factor for the vapor momentum conservation equation [-]

RELAXUW = 0.2

Relaxation factor for the wave momentum conservation equation [-]

RELAXWB = 0.5

Relaxation factor for the base mass conservation equation [-]

RELAXWF = 0.5

Relaxation factor for the film mass conservation equation [-]

RELAXWL = 1

Relaxation factor for the liquid mass conservation equation [-]

RELAXWM = 1

Relaxation factor for the mixture mass conservation equation [-]

RELAXWV = 0.8

Relaxation factor for the vapor mass conservation equation [-]

RELAXWW = 0.5

Relaxation factor for the wave mass conservation equation [-]

SSCONVFW = 1E-1

Wave frequency steady-state convergence criterion [Hz]

SSCONVH = 1E+0

Enthalpy steady-state convergence criterion [J/kg]

SSCONVP = 1E+0

Pressure steady-state convergence criterion [Pa]

SSCONVU = 1E-3

Velocity steady-state convergence criterion [m/s]

SSCONVUD = 1E-2

Drop velocity steady-state convergence criterion [m/s]

SSCONVUF = 1E-2

Film velocity steady-state convergence criterion [m/s]

SSCONVW = 1E-3

Mass flow rate steady-state convergence criterion [kg/s]

SSCONVWF = 1E-4

Film mass flow rate steady-state convergence criterion [kg/s/m]

SSMAXITER = 30

Maximum number of steady-state iterations

SSTSTEP = 1.0

Time step size for steady-state iterations [s]

TIMEINTERP = 'linear'

Method for interpolating time-dependent boundary conditions

TSTEP = 0.1

Time step size for transient simulations [s]

Method Summary
static writeInputFile(filePathName, ID, varargin)

Writes numerical options configuration to input file

Inputs:

  • filePathName — Path to output file

  • ID — Options identifier

  • varargin — Additional name-value pairs for options properties