BoundaryCondition Class
The BoundaryCondition class contains methods and properties for defining boundary condition values and directions. Note that some properties and methods are not applicable to all boundary condition types.
Note that boundary conditions are applied using the Scenario method “applyBoundaryCondition(bc object)”.
BoundaryCondition Class Properties
BoundaryCondition Properties | Type | Values |
type | String | “Velocity”, “Normal Velocity”, “Pressure”, “Volume Flow Rate”, “Mass Flow Rate”, “Temperature”, “Slip/Symmetry”, “Unknown”, “Scalar”, “Humidity”, “Quality”, “Heat Flux”, “Total Heat Flux”, “Film Coefficient”, “Radiation”, “Current”, “Voltage”, “Transparent” |
value | Number | |
units | String | examples are: “in/s”, “Pa”, “W/m2”; see interface for available units for each boundary condition |
direction | String | “Vx”, “Vy”, “Vz” (applies to velocity components) |
pressureType | String | “Gage”, “Absolute” |
referenceTemperature | Number | |
referenceTemperatureUnits | String | “Fahrenheit”, “Celsius”, “Rankine”, “Kelvin” |
backgroundTemperature | Number | |
backgroundTemperatureUnits | String | “Fahrenheit”, “Celsius”, “Rankine”, “Kelvin” |
emissivity | Number | |
rotationalSpeed | Number | |
slipFactor | Number | |
pairID | Integer | |
sideID | Integer | |
setBackgroundTemperature | Number | |
BoundaryCondition Class Methods
BoundaryCondition Methods | Description | data return |
bc = new BoundaryCondition(type) | creates a boundary condition object of name bc (can be anything); type = string | no |
setValue(value, units) | sets value and units; value = number, units = string | no |
setReferenceTemperature(value, units) | Sets reference temperature for film coefficient | no |
setPointOnAxis(x,y,z) setAxisDirection(x,y,z) | sets axis properties for rotational velocity; x, y, and z are numbers | no |
setTimeCurve(tc) | sets transient boundary condition; tc = time curve object | no |
setBackgroundTemperature(value, units) | sets transparency background temperature; value = number; units = string | no |
getFanCurve() | Returns fan curve for an external fan curve BC | yes |