Submodels Library

BeggsAndBrill

Submodel

Provides the Beggs-Brill calculations for the slip, liquid holdup, and two-phase friction factor.

BeggsAndBrillV2

Submodel

Provides the Beggs-Brill calculations for the slip, liquid holdup, and two-phase friction factor. This submodel differs from BeggsAndBrill submodel by adding a tear function to the Fratio in the calculations of the two-phase friction factor.

CheckState

Submodel

Performs an independent pressure-temperature (PT) or pressure-enthalpy (PH) flash by using the pressure, composition, and temperature or enthalpy results from the original flash. If the independent CheckState results differ by more than 0.1% from the original flash solution, an error badge appears over the impacted model.

CO2State

Submodel

Serves as the Carbon Dioxide Fluid State submodel. When configuring your fluid in the Fluid Editor, you can use this model as the State Model when you set the Thermo Type for the fluid to CarbonDioxide.

CoefTable

Submodel

Interpolates the value of a y variable from a coefficient table by using z and x as independent variables. The coefficient table is stored in an external dynamic-link library (DLL). The Table parameter selects which coefficient table to use. The submodel uses linear interpolation to find the coefficient and does not extrapolate any values.

Colebrook

Submodel

Provides calculations for the Colebrook friction factor.

CompMap

Submodel

Provides a curve map for multiple curves at various Speed or IGV positions (for compressors) or Speed and Impeller diameters (for pumps).

CompositionalState

Submodel

Serves as the Compositional Fluid State submodel. When configuring your fluid in the Fluid Editor, you can use this model as the State Model when you set the Thermo Type for the fluid to Compositional.

CpCvRatio

Submodel

Provides the calculations for the isentropic exponent (Cp/Cv ratio) for various models.

CritRate

Submodel

Provides the critical mass flux for single-phase and two-phase flow.

CurveState

Submodel

Serves as the Curve State submodel. This submodel provides generalized calculations for attaining values from a curve.

DataRegress

Submodel

Provides regression analysis to identify fifth-order polynomial coefficients.

DefEQ

Submodel

Serves as the default replaceable submodel for equilibrium reactions. The EQR and CNVR models use this submodel as the default value for the RxnModelType parameter.

DefStream

Submodel

Serves as the default replaceable submodel for the PropModelType parameter in the Stream model.

DINTable

Submodel

Provides the inside pipe diameter based on the selected nominal pipe size and schedule submodels.

DistCurve

Submodel

Reports assay curve data for true boiling point (TBP), American Society of Testing and Materials (ASTM) D86, ASTM D1160, and ASTM D2887 curves. This submodel is used by the RefineryTests model from the Process Library.

DNTable

Submodel

Provides the inside pipe diameter and wall thickness based on the specified nominal pipe size, schedule, and standard. This submodel allows you to select nominal pipe sizes based on the DN (diamètre nominal) standard.

DrumGeometry

Submodel

Provides the head volume and level calculations for the Drum model.

DrumMetal

Submodel

Provides the heat loss from a fluid to the metal of its container as a heat duty. This submodel expects the metal wall geometry, temperature, and other fluid properties (such as viscosity and thermal conductivity) as inputs. You can use this submodel for the metal wall energy balance for any parent model with stagnant fluid holdup as long as the parent model has a metal wall.

Fittings

Submodel

Provides the pipe fittings based on the fully turbulent friction factor.

FlareGas

Submodel

Provides the fluid calculations based on the simple, averaged molecular weight for Flare simulations.

FlareGasState

Submodel

Serves as the Flare Gas Fluid State submodel. This submodel uses fluid calculations based on the simple, averaged molecular weight. Typically, you use this submodel with Flare simulations. When configuring your fluid in the Fluid Editor, you can use this model as the State Model when the Thermo Type for the fluid is FlareGas.

FluidState

Submodel

Serves as the thermodynamic Fluid State submodel. The standard Model Libraries no longer use this Model Type. This submodel appears in the Submodels Library for backward compatibility only. New Model Types should use the <FluidType>.StateModel to define the submodel used for thermodynamic calculations, where <FluidType> is the name of the Fluid Type parameter.

GOSTTable

Submodel

Provides the inside pipe diameter and wall thickness based on the specified nominal pipe size, schedule, and standard. This submodel allows you to select nominal pipe sizes based on the Russian governmental standard (GOST).

H2State

Submodel

Serves as the Hydrogen Fluid State submodel. When configuring your fluid in the Fluid Editor, you can use this model as the State Model when you set the Thermo Type for the fluid to IsomericHydrogen.

HeaderMetal

Submodel

Provides the heat loss from a fluid to the metal of its container as a heat duty. It expects the metal mass, equipment geometry, insulation, and fluid temperature as inputs from the parent model and the film heat transfer coefficient as an input from its submodel (typically, MovingFluidHTC). We have designed this submodel for use with headers and pipes. You can use this submodel for the metal wall energy balance for a variety of parent models with non-stagnant fluid holdup as long as the parent model has a metal wall.

HeatLoss

Submodel

Provides heat loss calculations for various models.

HeatLossV2

Submodel

You should use this model with a holdup that includes metal wall dynamics as a parent model. This submodel expects the metal wall temperature as an input and returns the heat loss as a heat duty to be used with the metal wall energy balance in the parent holdup. This way, you can apply this submodel to a variety of models as long as they have a metal wall.

Holdup

Submodel

Provides the holdup calculations for the heat exchanger models.

HorizDrumGeometry

Submodel

Provides the vessel volume, level, and surface area calculations for a vessel model (such as a Drum or Separator model) that has a horizontal orientation.

HXSide

Submodel

Provides the hot-side and cold-side variables for the heat exchanger models.

IdealGasState

Submodel

Serves as the Ideal Gas Fluid State submodel. When configuring your fluid in the Fluid Editor, you can use this model as the State Model when you set the Thermo Type for the fluid to IdealGas.

IncompLiquidState

Submodel

Serves as the Incompressible Liquid Fluid State submodel. When configuring your fluid in the Fluid Editor, you can use this model as the State Model when you set the Thermo Type for the fluid to IncompressibleLiquid.

Insulation

Submodel

Serves as the insulation submodel for the pipe models.

InsulationMaterial

Submodel

Provides a general thermal conductivity value for various types of insulation.

JISATable

Submodel

Provides the inside pipe diameter and wall thickness based on the specified nominal pipe size, schedule, and standard. This submodel allows you to select nominal pipe sizes based on the Japanese Industrial Standard (JIS) for civil engineering and architecture.

JISBTable

Submodel

Provides the inside pipe diameter and wall thickness based on the specified nominal pipe size, schedule, and standard. This submodel allows you to select nominal pipe sizes based on the Japanese Industrial Standard (JIS) for mechanical engineering.

KfactorBBHV

Submodel

Provides the calculations for the pressure drop acceleration factor (Ek) by using the Hewitt-Semeria critical mixture velocity method.

Lag

Submodel

Serves as the actuator lag submodel.

Latch

Submodel

Serves as the latch logic submodel for an on or off output.

LiqSonic

Submodel

Provides the rigorous calculations for the sonic velocity in liquid.

LMTD

Submodel

Provides the logarithmic mean temperature difference (LMTD) calculations for heat exchangers.

LMTDC

Submodel

Provides the LMTD calculations for heat exchangers with constant temperature (boiling or condensing).

MovingFluidHTC

Submodel

Provides the heat transfer coefficient to its parent model, which calculates the heat loss from a fluid to the metal of its container as a heat duty. We have designed this submodel to be a submodel of the HeaderMetal submodel. This submodel expects the equipment geometry, fluid flow rate, and fluid properties (such as viscosity and thermal conductivity) as inputs from the parent model.

Multiphase

Submodel

Provides multiphase flow parameters (transport property data) for various models.

NPSTable

Submodel

Provides the inside pipe diameter and wall thickness based on the specified nominal pipe size, schedule, and standard. This submodel allows you to select nominal pipe sizes based on the Nominal Pipe Size (NPS) standard.

PhaseProp

Submodel

Provides state-dependent phase properties.

PipeEntrance

Submodel

Serves as the internal inlet effect for the PipeRig model.

PipeExit

Submodel

Serves as the internal exit effect for the PipeRig model.

PipeFlow

Submodel

Serves as the compressible flow submodel for the pipe models.

PipeNode

Submodel

Serves as the PipeNode submdodel for the PipeRig model. This submodel performs fluid property calculations for the PipeSeg submodel. It accounts for the fluid accumulation for dynamics. The calculated properties are connected to the respective variables in the ports. The pipe ports should carry the calculation results to other connected submodels, such as the PipeSeg submodel, and the entrance and exit effects.

PipeRigElem

Submodel

Serves as the multiphase flow pipe segment that uses the Beggs-Brill correlation.

PipeSeg

Submodel

Serves as the pipe segment submodel for the PipeRig model. This submodel performs hydraulic calculations. The PipeNode submodel supplies the fluid properties that this submodel needs to perform the calculations.

PipeTable

Submodel

Provides the inside pipe diameter and wall thickness based on the specified nominal pipe size and schedule. This submodel supports only the NPS standard for pipe sizes.

PSVTable

Submodel

Provides the orifice area for a pressure relief value based on the orifice type.

PumpCurve

Submodel

Provides a simple curve representation submodel for the Pump model.

PVTProps

Submodel

Transfers variables and parameters from the segments to the holdups and vice versa for various models.

SphereGeometry

Submodel

Provides the vessel volume, level, and surface area calculations for a vessel model (such as a Drum or Separator model) that has a spherical orientation.

SteamState

Submodel

Serves as the Steam Fluid State submodel. When configuring your fluid in the Fluid Editor, you can use this model as the State Model when you set the Thermo Type for the fluid to Steam.

TeeCoeff

Submodel

Provides the calculations for the tee loss coefficients.

UserValveChar

Submodel

Provides calculations of Pos when the valve characteristic is set to UserDefined. You should use this submodel in tandem with the ValveChar submodel.

ValveChar

Submodel

Provides calculations of Pos based on the valve characteristic setting.

ValveCoeff

Submodel

Provides the line-sized valve Cvs for common valve types.

ValveFlowC

Submodel

Provides the compressible flow submodel for the Valve model.

ValveFlowI

Submodel

Provides the incompressible flow submodel for the Valve model.

VertDrumGeometry

Submodel

Provides the vessel volume, level, and surface area calculations for a vessel model (such as a Drum or Separator model) that has a vertical orientation.