Material Stream¶

Material stream: carries the conditions (temperature, pressure, flow), composition and phase properties of a multicomponent, multiphase process stream between unit operations. It runs the flash and property calculations through its property package, and implements the CAPE-OPEN 1.0 and 1.1 material object and thermodynamic interfaces so external components can use it.

DWSIM.Thermodynamics.Streams.MaterialStream
Assembly DWSIM.Thermodynamics.dll · Object ← BaseClass ← MaterialStream

At a glance¶

Material Stream in the example flowsheet

Port	Index	Connected in the example
Inlet, material	`0`
Outlet, material	`0`

Example¶

This code runs on every build of this site, and the output below is what it printed.

Python

fs = (Flowsheet.Create("StreamExample")
      .WithCompounds("Methane", "Ethane", "Propane", "N-butane", "N-pentane")
      .WithPropertyPackage(PropertyPackages.PengRobinson))

gas = (fs.AddMaterialStream("Gas")
       .At(Q.Celsius(5.0), Q.Bar(30.0))
       .SetCompoundMolarFlow("Methane", 70.0)       # mol/s
       .SetCompoundMolarFlow("Ethane", 12.0)
       .SetCompoundMolarFlow("Propane", 10.0)
       .SetCompoundMolarFlow("N-butane", 5.0)
       .SetCompoundMolarFlow("N-pentane", 3.0))

fs.Solve()

s = gas.Object
vapor = s.Phases[2].Properties.molarfraction
print(f"Vapor fraction  = {vapor:.4f}")
print(f"Mass flow       = {s.GetMassFlow():.3f} kg/s")
print(f"Density         = {s.Phases[0].Properties.density:.2f} kg/m3")
print(f"Enthalpy        = {s.Phases[0].Properties.enthalpy:.2f} kJ/kg")
print(f"Liquid propane  = {s.Phases[1].Compounds['Propane'].MoleFraction:.4f} (mole fraction)")

Output

Vapor fraction  = 0.8794
Mass flow       = 2.432 kg/s
Density         = 41.06 kg/m3
Enthalpy        = -163.76 kJ/kg
Liquid propane  = 0.2628 (mole fraction)

DWSIM 10.2.11.0, generated 2026-10-08.

Properties¶

IDs accepted by GetPropertyValue, SetPropertyValue, the sensitivity analysis, the optimizer, the Adjust block and dynamic events. Units are SI; pass another unit system to GetPropertyValue to get them converted.

All 433 properties

ID	Name	Unit (SI)	Input
`PROP_MS_0`	Temperature	K	yes
`PROP_MS_1`	Pressure	Pa	yes
`PROP_MS_2`	Mass Flow	kg/s	yes
`PROP_MS_3`	Molar Flow	mol/s	yes
`PROP_MS_4`	Volumetric Flow	m3/s	yes
`PROP_MS_5`	Density (Mixture)	kg/m3	result
`PROP_MS_6`	Molecular Weight (Mixture)	kg/kmol	result
`PROP_MS_7`	Specific Enthalpy (Mixture)	kJ/kg	yes
`PROP_MS_8`	Specific Entropy (Mixture)	kJ/[kg.K]	yes
`PROP_MS_9`	Molar Enthalpy (Mixture)	kJ/kmol	result
`PROP_MS_10`	Molar Entropy (Mixture)	kJ/[kmol.K]	result
`PROP_MS_11`	Thermal Conductivity (Mixture)	W/[m.K]	result
`PROP_MS_12`	Density (Vapor)	kg/m3	result
`PROP_MS_13`	Molecular Weight (Vapor)	kg/kmol	result
`PROP_MS_14`	Specific Enthalpy (Vapor)	kJ/kg	result
`PROP_MS_15`	Specific Entropy (Vapor)	kJ/[kg.K]	result
`PROP_MS_16`	Molar Enthalpy (Vapor)	kJ/kmol	result
`PROP_MS_17`	Molar Entropy (Vapor)	kJ/[kmol.K]	result
`PROP_MS_18`	Thermal Conductivity (Vapor)	W/[m.K]	result
`PROP_MS_19`	Kinematic Viscosity (Vapor)	m2/s	result
`PROP_MS_20`	Dynamic Viscosity (Vapor)	Pa.s	result
`PROP_MS_21`	Heat Capacity (Vapor)	kJ/[kg.K]	result
`PROP_MS_22`	Heat Capacity Ratio (Vapor)		result
`PROP_MS_23`	Mass Flow (Vapor)	kg/s	result
`PROP_MS_24`	Molar Flow (Vapor)	mol/s	result
`PROP_MS_25`	Volumetric Flow (Vapor)	m3/s	result
`PROP_MS_26`	Compressibility Factor (Vapor)		result
`PROP_MS_27`	Molar Fraction (Vapor)		yes
`PROP_MS_28`	Mass Fraction (Vapor)		result
`PROP_MS_29`	Volumetric Fraction (Vapor)		result
`PROP_MS_30`	Density (Overall Liquid)	kg/m3	result
`PROP_MS_31`	Molecular Weight (Overall Liquid)	kg/kmol	result
`PROP_MS_32`	Specific Enthalpy (Overall Liquid)	kJ/kg	result
`PROP_MS_33`	Specific Entropy (Overall Liquid)	kJ/[kg.K]	result
`PROP_MS_34`	Molar Enthalpy (Overall Liquid)	kJ/kmol	result
`PROP_MS_35`	Molar Entropy (Overall Liquid)	kJ/[kmol.K]	result
`PROP_MS_36`	Thermal Conductivity (Overall Liquid)	W/[m.K]	result
`PROP_MS_37`	Kinematic Viscosity (Overall Liquid)	m2/s	result
`PROP_MS_38`	Dynamic Viscosity (Overall Liquid)	Pa.s	result
`PROP_MS_39`	Heat Capacity (Overall Liquid)	kJ/[kg.K]	result
`PROP_MS_40`	Heat Capacity Ratio (Overall Liquid)		result
`PROP_MS_41`	Mass Flow (Overall Liquid)	kg/s	result
`PROP_MS_42`	Molar Flow (Overall Liquid)	mol/s	result
`PROP_MS_43`	Volumetric Flow (Overall Liquid)	m3/s	result
`PROP_MS_44`	Compressibility Factor (Overall Liquid)		result
`PROP_MS_45`	Molar Fraction (Overall Liquid)		result
`PROP_MS_46`	Mass Fraction (Overall Liquid)		result
`PROP_MS_47`	Volumetric Fraction (Overall Liquid)		result
`PROP_MS_48`	Density (Liquid 1)	kg/m3	result
`PROP_MS_49`	Molar Weight (Liquid 1)	kg/kmol	result
`PROP_MS_50`	Specific Enthalpy (Liquid 1)	kJ/kg	result
`PROP_MS_51`	Specific Entropy (Liquid 1)	kJ/[kg.K]	result
`PROP_MS_52`	Molar Enthalpy (Liquid 1)	kJ/kmol	result
`PROP_MS_53`	Molar Entropy (Liquid 1)	kJ/[kmol.K]	result
`PROP_MS_54`	Thermal Conductivity (Liquid 1)	W/[m.K]	result
`PROP_MS_55`	Kinematic Viscosity (Liquid 1)	m2/s	result
`PROP_MS_56`	Dynamic Viscosity (Liquid 1)	Pa.s	result
`PROP_MS_57`	Heat Capacity (Liquid 1)	kJ/[kg.K]	result
`PROP_MS_58`	Heat Capacity Ratio (Liquid 1)		result
`PROP_MS_59`	Mass Flow (Liquid 1)	kg/s	result
`PROP_MS_60`	Molar Flow (Liquid 1)	mol/s	result
`PROP_MS_61`	Volumetric Flow (Liquid 1)	m3/s	result
`PROP_MS_62`	Compressibility Factor (Liquid 1)		result
`PROP_MS_63`	Molar Fraction (Liquid 1)		result
`PROP_MS_64`	Mass Fraction (Liquid 1)		result
`PROP_MS_65`	Volumetric Fraction (Liquid 1)		result
`PROP_MS_66`	Density (Liquid 2)	kg/m3	result
`PROP_MS_67`	Molar Weight (Liquid 2)	kg/kmol	result
`PROP_MS_68`	Specific Enthalpy (Liquid 2)	kJ/kg	result
`PROP_MS_69`	Specific Entropy (Liquid 2)	kJ/[kg.K]	result
`PROP_MS_70`	Molar Enthalpy (Liquid 2)	kJ/kmol	result
`PROP_MS_71`	Molar Entropy (Liquid 2)	kJ/[kmol.K]	result
`PROP_MS_72`	Thermal Conductivity (Liquid 2)	W/[m.K]	result
`PROP_MS_73`	Kinematic Viscosity (Liquid 2)	m2/s	result
`PROP_MS_74`	Dynamic Viscosity (Liquid 2)	Pa.s	result
`PROP_MS_75`	Heat Capacity (Liquid 2)	kJ/[kg.K]	result
`PROP_MS_76`	Heat Capacity Ratio (Liquid 2)		result
`PROP_MS_77`	Mass Flow (Liquid 2)	kg/s	result
`PROP_MS_78`	Molar Flow (Liquid 2)	mol/s	result
`PROP_MS_79`	Volumetric Flow (Liquid 2)	m3/s	result
`PROP_MS_80`	Compressibility Factor (Liquid 2)		result
`PROP_MS_81`	Molar Fraction (Liquid 2)		result
`PROP_MS_82`	Mass Fraction (Liquid 2)		result
`PROP_MS_83`	Volumetric Fraction (Liquid 2)		result
`PROP_MS_84`	Density (Aqueous)	kg/m3	result
`PROP_MS_85`	Molecular Weight (Aqueous)	kg/kmol	result
`PROP_MS_86`	Specific Enthalpy (Aqueous)	kJ/kg	result
`PROP_MS_87`	Specific Entropy (Aqueous)	kJ/[kg.K]	result
`PROP_MS_88`	Molar Enthalpy (Aqueous)	kJ/kmol	result
`PROP_MS_89`	Molar Entropy (Aqueous)	kJ/[kmol.K]	result
`PROP_MS_90`	Thermal Conductivity (Aqueous)	W/[m.K]	result
`PROP_MS_91`	Kinematic Viscosity (Aqueous)	m2/s	result
`PROP_MS_92`	Dynamic Viscosity (Aqueous)	Pa.s	result
`PROP_MS_93`	Heat Capacity (Aqueous)	kJ/[kg.K]	result
`PROP_MS_94`	Heat Capacity Ratio (Aqueous)		result
`PROP_MS_95`	Mass Flow (Aqueous)	kg/s	result
`PROP_MS_96`	Molar Flow (Aqueous)	mol/s	result
`PROP_MS_97`	Volumetric Flow (Aqueous)	m3/s	result
`PROP_MS_98`	Compressibility Factor (Aqueous)		result
`PROP_MS_99`	Molar Fraction (Aqueous)		result
`PROP_MS_100`	Aqueous Mass Fraction		result
`PROP_MS_101`	Aqueous Volumetric Fraction		result
`PROP_MS_131`	Density (Solid)	kg/m3	result
`PROP_MS_132`	Molecular Weight (Solid)	kg/kmol	result
`PROP_MS_133`	Specific Enthalpy (Solid)	kJ/kg	result
`PROP_MS_134`	Specific Entropy (Solid)	kJ/[kg.K]	result
`PROP_MS_135`	Molar Enthalpy (Solid)	kJ/kmol	result
`PROP_MS_136`	Molar Entropy (Solid)	kJ/[kmol.K]	result
`PROP_MS_137`	Thermal Conductivity (Solid)	W/[m.K]	result
`PROP_MS_138`	Kinematic Viscosity (Solid)	m2/s	result
`PROP_MS_139`	Dynamic Viscosity (Solid)	Pa.s	result
`PROP_MS_140`	Solid Heat Capacity (Cp)	kJ/[kg.K]	result
`PROP_MS_141`	Solid Heat Capacity Ratio (Cp/Cv)		result
`PROP_MS_142`	Mass Flow (Solid)	kg/s	result
`PROP_MS_143`	Molar Flow (Solid)	mol/s	result
`PROP_MS_144`	Volumetric Flow (Solid)	m3/s	result
`PROP_MS_145`	Compressibility Factor (Solid)		result
`PROP_MS_146`	Molar Fraction (Solid)		result
`PROP_MS_147`	Mass Fraction (Solid)		result
`PROP_MS_148`	Volumetric Fraction (Solid)		result
`PROP_MS_102/Methane`	Molar Fraction (Mixture) / Methane		yes
`PROP_MS_102/Ethane`	Molar Fraction (Mixture) / Ethane		yes
`PROP_MS_102/Propane`	Molar Fraction (Mixture) / Propane		yes
`PROP_MS_102/N-butane`	Molar Fraction (Mixture) / N-butane		yes
`PROP_MS_102/N-pentane`	Molar Fraction (Mixture) / N-pentane		yes
`PROP_MS_103/Methane`	Mass Fraction (Mixture) / Methane		yes
`PROP_MS_103/Ethane`	Mass Fraction (Mixture) / Ethane		yes
`PROP_MS_103/Propane`	Mass Fraction (Mixture) / Propane		yes
`PROP_MS_103/N-butane`	Mass Fraction (Mixture) / N-butane		yes
`PROP_MS_103/N-pentane`	Mass Fraction (Mixture) / N-pentane		yes
`PROP_MS_104/Methane`	Molar Flow (Mixture) / Methane	mol/s	yes
`PROP_MS_104/Ethane`	Molar Flow (Mixture) / Ethane	mol/s	yes
`PROP_MS_104/Propane`	Molar Flow (Mixture) / Propane	mol/s	yes
`PROP_MS_104/N-butane`	Molar Flow (Mixture) / N-butane	mol/s	yes
`PROP_MS_104/N-pentane`	Molar Flow (Mixture) / N-pentane	mol/s	yes
`PROP_MS_105/Methane`	Mass Flow (Mixture) / Methane	kg/s	yes
`PROP_MS_105/Ethane`	Mass Flow (Mixture) / Ethane	kg/s	yes
`PROP_MS_105/Propane`	Mass Flow (Mixture) / Propane	kg/s	yes
`PROP_MS_105/N-butane`	Mass Flow (Mixture) / N-butane	kg/s	yes
`PROP_MS_105/N-pentane`	Mass Flow (Mixture) / N-pentane	kg/s	yes
`PROP_MS_106/Methane`	Molar Fraction (Vapor) / Methane		result
`PROP_MS_106/Ethane`	Molar Fraction (Vapor) / Ethane		result
`PROP_MS_106/Propane`	Molar Fraction (Vapor) / Propane		result
`PROP_MS_106/N-butane`	Molar Fraction (Vapor) / N-butane		result
`PROP_MS_106/N-pentane`	Molar Fraction (Vapor) / N-pentane		result
`PROP_MS_107/Methane`	Molar Fraction (Overall Liquid) / Methane		result
`PROP_MS_107/Ethane`	Molar Fraction (Overall Liquid) / Ethane		result
`PROP_MS_107/Propane`	Molar Fraction (Overall Liquid) / Propane		result
`PROP_MS_107/N-butane`	Molar Fraction (Overall Liquid) / N-butane		result
`PROP_MS_107/N-pentane`	Molar Fraction (Overall Liquid) / N-pentane		result
`PROP_MS_108/Methane`	Molar Fraction (Liquid 1) / Methane		result
`PROP_MS_108/Ethane`	Molar Fraction (Liquid 1) / Ethane		result
`PROP_MS_108/Propane`	Molar Fraction (Liquid 1) / Propane		result
`PROP_MS_108/N-butane`	Molar Fraction (Liquid 1) / N-butane		result
`PROP_MS_108/N-pentane`	Molar Fraction (Liquid 1) / N-pentane		result
`PROP_MS_109/Methane`	Molar Fraction (Liquid 2) / Methane		result
`PROP_MS_109/Ethane`	Molar Fraction (Liquid 2) / Ethane		result
`PROP_MS_109/Propane`	Molar Fraction (Liquid 2) / Propane		result
`PROP_MS_109/N-butane`	Molar Fraction (Liquid 2) / N-butane		result
`PROP_MS_109/N-pentane`	Molar Fraction (Liquid 2) / N-pentane		result
`PROP_MS_110/Methane`	Molar Fraction (Aqueous) / Methane		result
`PROP_MS_110/Ethane`	Molar Fraction (Aqueous) / Ethane		result
`PROP_MS_110/Propane`	Molar Fraction (Aqueous) / Propane		result
`PROP_MS_110/N-butane`	Molar Fraction (Aqueous) / N-butane		result
`PROP_MS_110/N-pentane`	Molar Fraction (Aqueous) / N-pentane		result
`PROP_MS_111/Methane`	Mass Fraction (Vapor) / Methane		result
`PROP_MS_111/Ethane`	Mass Fraction (Vapor) / Ethane		result
`PROP_MS_111/Propane`	Mass Fraction (Vapor) / Propane		result
`PROP_MS_111/N-butane`	Mass Fraction (Vapor) / N-butane		result
`PROP_MS_111/N-pentane`	Mass Fraction (Vapor) / N-pentane		result
`PROP_MS_112/Methane`	Mass Fraction (Overall Liquid) / Methane		result
`PROP_MS_112/Ethane`	Mass Fraction (Overall Liquid) / Ethane		result
`PROP_MS_112/Propane`	Mass Fraction (Overall Liquid) / Propane		result
`PROP_MS_112/N-butane`	Mass Fraction (Overall Liquid) / N-butane		result
`PROP_MS_112/N-pentane`	Mass Fraction (Overall Liquid) / N-pentane		result
`PROP_MS_113/Methane`	Mass Fraction (Liquid 1) / Methane		result
`PROP_MS_113/Ethane`	Mass Fraction (Liquid 1) / Ethane		result
`PROP_MS_113/Propane`	Mass Fraction (Liquid 1) / Propane		result
`PROP_MS_113/N-butane`	Mass Fraction (Liquid 1) / N-butane		result
`PROP_MS_113/N-pentane`	Mass Fraction (Liquid 1) / N-pentane		result
`PROP_MS_114/Methane`	Mass Fraction (Liquid 2) / Methane		result
`PROP_MS_114/Ethane`	Mass Fraction (Liquid 2) / Ethane		result
`PROP_MS_114/Propane`	Mass Fraction (Liquid 2) / Propane		result
`PROP_MS_114/N-butane`	Mass Fraction (Liquid 2) / N-butane		result
`PROP_MS_114/N-pentane`	Mass Fraction (Liquid 2) / N-pentane		result
`PROP_MS_115/Methane`	Mass Fraction (Aqueous) / Methane		result
`PROP_MS_115/Ethane`	Mass Fraction (Aqueous) / Ethane		result
`PROP_MS_115/Propane`	Mass Fraction (Aqueous) / Propane		result
`PROP_MS_115/N-butane`	Mass Fraction (Aqueous) / N-butane		result
`PROP_MS_115/N-pentane`	Mass Fraction (Aqueous) / N-pentane		result
`PROP_MS_116/Methane`	Molar Flow (Vapor) / Methane	mol/s	result
`PROP_MS_116/Ethane`	Molar Flow (Vapor) / Ethane	mol/s	result
`PROP_MS_116/Propane`	Molar Flow (Vapor) / Propane	mol/s	result
`PROP_MS_116/N-butane`	Molar Flow (Vapor) / N-butane	mol/s	result
`PROP_MS_116/N-pentane`	Molar Flow (Vapor) / N-pentane	mol/s	result
`PROP_MS_117/Methane`	Molar Flow (Overall Liquid) / Methane	mol/s	result
`PROP_MS_117/Ethane`	Molar Flow (Overall Liquid) / Ethane	mol/s	result
`PROP_MS_117/Propane`	Molar Flow (Overall Liquid) / Propane	mol/s	result
`PROP_MS_117/N-butane`	Molar Flow (Overall Liquid) / N-butane	mol/s	result
`PROP_MS_117/N-pentane`	Molar Flow (Overall Liquid) / N-pentane	mol/s	result
`PROP_MS_118/Methane`	Molar Flow (Liquid 1) / Methane	mol/s	result
`PROP_MS_118/Ethane`	Molar Flow (Liquid 1) / Ethane	mol/s	result
`PROP_MS_118/Propane`	Molar Flow (Liquid 1) / Propane	mol/s	result
`PROP_MS_118/N-butane`	Molar Flow (Liquid 1) / N-butane	mol/s	result
`PROP_MS_118/N-pentane`	Molar Flow (Liquid 1) / N-pentane	mol/s	result
`PROP_MS_119/Methane`	Molar Flow (Liquid 2) / Methane	mol/s	result
`PROP_MS_119/Ethane`	Molar Flow (Liquid 2) / Ethane	mol/s	result
`PROP_MS_119/Propane`	Molar Flow (Liquid 2) / Propane	mol/s	result
`PROP_MS_119/N-butane`	Molar Flow (Liquid 2) / N-butane	mol/s	result
`PROP_MS_119/N-pentane`	Molar Flow (Liquid 2) / N-pentane	mol/s	result
`PROP_MS_120/Methane`	Molar Flow (Aqueous) / Methane	mol/s	result
`PROP_MS_120/Ethane`	Molar Flow (Aqueous) / Ethane	mol/s	result
`PROP_MS_120/Propane`	Molar Flow (Aqueous) / Propane	mol/s	result
`PROP_MS_120/N-butane`	Molar Flow (Aqueous) / N-butane	mol/s	result
`PROP_MS_120/N-pentane`	Molar Flow (Aqueous) / N-pentane	mol/s	result
`PROP_MS_121/Methane`	Mass Flow (Vapor) / Methane	kg/s	result
`PROP_MS_121/Ethane`	Mass Flow (Vapor) / Ethane	kg/s	result
`PROP_MS_121/Propane`	Mass Flow (Vapor) / Propane	kg/s	result
`PROP_MS_121/N-butane`	Mass Flow (Vapor) / N-butane	kg/s	result
`PROP_MS_121/N-pentane`	Mass Flow (Vapor) / N-pentane	kg/s	result
`PROP_MS_122/Methane`	Mass Flow (Overall Liquid) / Methane	kg/s	result
`PROP_MS_122/Ethane`	Mass Flow (Overall Liquid) / Ethane	kg/s	result
`PROP_MS_122/Propane`	Mass Flow (Overall Liquid) / Propane	kg/s	result
`PROP_MS_122/N-butane`	Mass Flow (Overall Liquid) / N-butane	kg/s	result
`PROP_MS_122/N-pentane`	Mass Flow (Overall Liquid) / N-pentane	kg/s	result
`PROP_MS_123/Methane`	Mass Flow (Liquid 1) / Methane	kg/s	result
`PROP_MS_123/Ethane`	Mass Flow (Liquid 1) / Ethane	kg/s	result
`PROP_MS_123/Propane`	Mass Flow (Liquid 1) / Propane	kg/s	result
`PROP_MS_123/N-butane`	Mass Flow (Liquid 1) / N-butane	kg/s	result
`PROP_MS_123/N-pentane`	Mass Flow (Liquid 1) / N-pentane	kg/s	result
`PROP_MS_124/Methane`	Mass Flow (Liquid 2) / Methane	kg/s	result
`PROP_MS_124/Ethane`	Mass Flow (Liquid 2) / Ethane	kg/s	result
`PROP_MS_124/Propane`	Mass Flow (Liquid 2) / Propane	kg/s	result
`PROP_MS_124/N-butane`	Mass Flow (Liquid 2) / N-butane	kg/s	result
`PROP_MS_124/N-pentane`	Mass Flow (Liquid 2) / N-pentane	kg/s	result
`PROP_MS_125/Methane`	Mass Flow (Aqueous) / Methane	kg/s	result
`PROP_MS_125/Ethane`	Mass Flow (Aqueous) / Ethane	kg/s	result
`PROP_MS_125/Propane`	Mass Flow (Aqueous) / Propane	kg/s	result
`PROP_MS_125/N-butane`	Mass Flow (Aqueous) / N-butane	kg/s	result
`PROP_MS_125/N-pentane`	Mass Flow (Aqueous) / N-pentane	kg/s	result
`PROP_MS_149/Methane`	Mole Fraction (Solid) / Methane		result
`PROP_MS_149/Ethane`	Mole Fraction (Solid) / Ethane		result
`PROP_MS_149/Propane`	Mole Fraction (Solid) / Propane		result
`PROP_MS_149/N-butane`	Mole Fraction (Solid) / N-butane		result
`PROP_MS_149/N-pentane`	Mole Fraction (Solid) / N-pentane		result
`PROP_MS_150/Methane`	Mass Fraction (Solid) / Methane		result
`PROP_MS_150/Ethane`	Mass Fraction (Solid) / Ethane		result
`PROP_MS_150/Propane`	Mass Fraction (Solid) / Propane		result
`PROP_MS_150/N-butane`	Mass Fraction (Solid) / N-butane		result
`PROP_MS_150/N-pentane`	Mass Fraction (Solid) / N-pentane		result
`PROP_MS_151/Methane`	Mole Flow (Solid) / Methane	mol/s	result
`PROP_MS_151/Ethane`	Mole Flow (Solid) / Ethane	mol/s	result
`PROP_MS_151/Propane`	Mole Flow (Solid) / Propane	mol/s	result
`PROP_MS_151/N-butane`	Mole Flow (Solid) / N-butane	mol/s	result
`PROP_MS_151/N-pentane`	Mole Flow (Solid) / N-pentane	mol/s	result
`PROP_MS_152/Methane`	Mass Flow (Solid) / Methane	kg/s	result
`PROP_MS_152/Ethane`	Mass Flow (Solid) / Ethane	kg/s	result
`PROP_MS_152/Propane`	Mass Flow (Solid) / Propane	kg/s	result
`PROP_MS_152/N-butane`	Mass Flow (Solid) / N-butane	kg/s	result
`PROP_MS_152/N-pentane`	Mass Flow (Solid) / N-pentane	kg/s	result
`PROP_MS_126`	Bubble Pressure at Stream Temperature	Pa	result
`PROP_MS_127`	Dew Pressure at Stream Temperature	Pa	result
`PROP_MS_128`	Bubble Temperature at Stream Pressure	K	result
`PROP_MS_129`	Dew Temperature at Stream Pressure	K	result
`PROP_MS_130`	Phases		result
`PROP_MS_153`	pH (Liquid 1)		result
`PROP_MS_246`	Osmotic Coefficient (Liquid 1)		result
`PROP_MS_247`	Mean Ionic Activity Coefficient (Liquid 1)		result
`PROP_MS_248`	Freezing Point (Liquid 1)	K	result
`PROP_MS_249`	Freezing Point Depression (Liquid 1)	K (difference)	result
`PROP_MS_155`	Isothermal Compressibility (Vapor)	1/Pa	result
`PROP_MS_156`	Bulk Modulus (Vapor)	Pa	result
`PROP_MS_157`	Speed of Sound (Vapor)	m/s	result
`PROP_MS_158`	Joule-Thomson Coefficient (Vapor)	K/Pa	result
`PROP_MS_159`	Internal Energy (Vapor)	kJ/kg	result
`PROP_MS_160`	Gibbs Free Energy (Vapor)	kJ/kg	result
`PROP_MS_161`	Helmholtz Free Energy (Vapor)	kJ/kg	result
`PROP_MS_162`	Isothermal Compressibility (Overall Liquid)	1/Pa	result
`PROP_MS_163`	Bulk Modulus (Overall Liquid)	Pa	result
`PROP_MS_164`	Speed of Sound (Overall Liquid)	m/s	result
`PROP_MS_165`	Joule-Thomson Coefficient (Overall Liquid)	K/Pa	result
`PROP_MS_166`	Internal Energy (Overall Liquid)	kJ/kg	result
`PROP_MS_167`	Gibbs Free Energy (Overall Liquid)	kJ/kg	result
`PROP_MS_168`	Helmholtz Free Energy (Overall Liquid)	kJ/kg	result
`PROP_MS_169`	Bulk Modulus (Liquid 1)	Pa	result
`PROP_MS_170`	Speed of Sound (Liquid 1)	m/s	result
`PROP_MS_171`	Joule-Thomson Coefficient (Liquid 1)	K/Pa	result
`PROP_MS_172`	Internal Energy (Liquid 1)	kJ/kg	result
`PROP_MS_173`	Gibbs Free Energy (Liquid 1)	kJ/kg	result
`PROP_MS_174`	Helmholtz Free Energy (Liquid 1)	kJ/kg	result
`PROP_MS_175`	Isothermal Compressibility (Liquid 1)	1/Pa	result
`PROP_MS_176`	Bulk Modulus (Liquid 2)	Pa	result
`PROP_MS_177`	Speed of Sound (Liquid 2)	m/s	result
`PROP_MS_178`	Joule-Thomson Coefficient (Liquid 2)	K/Pa	result
`PROP_MS_179`	Internal Energy (Liquid 2)	kJ/kg	result
`PROP_MS_180`	Gibbs Free Energy (Liquid 2)	kJ/kg	result
`PROP_MS_181`	Helmholtz Free Energy (Liquid 2)	kJ/kg	result
`PROP_MS_182`	Isothermal Compressibility (Liquid 2)	1/Pa	result
`PROP_MS_183`	Bulk Modulus (Liquid 3)	Pa	result
`PROP_MS_184`	Speed of Sound (Liquid 3)	m/s	result
`PROP_MS_185`	Joule-Thomson Coefficient (Liquid 3)	K/Pa	result
`PROP_MS_186`	Internal Energy (Liquid 3)	kJ/kg	result
`PROP_MS_187`	Gibbs Free Energy (Liquid 3)	kJ/kg	result
`PROP_MS_188`	Helmholtz Free Energy (Liquid 3)	kJ/kg	result
`PROP_MS_189`	Isothermal Compressibility (Liquid 3)	1/Pa	result
`PROP_MS_190`	Bulk Modulus (Aqueous)	Pa	result
`PROP_MS_191`	Speed of Sound (Aqueous)	m/s	result
`PROP_MS_192`	Joule-Thomson Coefficient (Aqueous)	K/Pa	result
`PROP_MS_193`	Internal Energy (Aqueous)	kJ/kg	result
`PROP_MS_194`	Gibbs Free Energy (Aqueous)	kJ/kg	result
`PROP_MS_195`	Helmholtz Free Energy (Aqueous)	kJ/kg	result
`PROP_MS_196`	Isothermal Compressibility (Aqueous)	1/Pa	result
`PROP_MS_198`	Bulk Modulus (Solid)	Pa	result
`PROP_MS_199`	Speed of Sound (Solid)	m/s	result
`PROP_MS_200`	Joule-Thomson Coefficient (Solid)	K/Pa	result
`PROP_MS_201`	Internal Energy (Solid)	kJ/kg	result
`PROP_MS_202`	Gibbs Free Energy (Solid)	kJ/kg	result
`PROP_MS_203`	Helmholtz Free Energy (Solid)	kJ/kg	result
`PROP_MS_204`	Isothermal Compressibility (Solid)	1/Pa	result
`PROP_MS_205`	Internal Energy (Mixture)	kJ/kg	result
`PROP_MS_206`	Gibbs Free Energy (Mixture)	kJ/kg	result
`PROP_MS_207`	Helmholtz Free Energy (Mixture)	kJ/kg	result
`PROP_MS_208`	Molar Internal Energy (Mixture)	kJ/kmol	result
`PROP_MS_209`	Molar Gibbs Free Energy (Mixture)	kJ/kmol	result
`PROP_MS_210`	Molar Helmholtz Free Energy (Mixture)	kJ/kmol	result
`PROP_MS_211`	Molar Internal Energy (Vapor)	kJ/kmol	result
`PROP_MS_212`	Molar Gibbs Free Energy (Vapor)	kJ/kmol	result
`PROP_MS_213`	Molar Helmholtz Free Energy (Vapor)	kJ/kmol	result
`PROP_MS_214`	Molar Internal Energy (Overall Liquid)	kJ/kmol	result
`PROP_MS_215`	Molar Gibbs Free Energy (Overall Liquid)	kJ/kmol	result
`PROP_MS_216`	Molar Helmholtz Free Energy (Overall Liquid)	kJ/kmol	result
`PROP_MS_217`	Molar Internal Energy (Liquid 1)	kJ/kmol	result
`PROP_MS_218`	Molar Gibbs Free Energy (Liquid 1)	kJ/kmol	result
`PROP_MS_219`	Molar Helmholtz Free Energy (Liquid 1)	kJ/kmol	result
`PROP_MS_220`	Molar Internal Energy (Liquid 2)	kJ/kmol	result
`PROP_MS_221`	Molar Gibbs Free Energy (Liquid 2)	kJ/kmol	result
`PROP_MS_222`	Molar Helmholtz Free Energy (Liquid 2)	kJ/kmol	result
`PROP_MS_223`	Molar Internal Energy (Liquid 3)	kJ/kmol	result
`PROP_MS_224`	Molar Gibbs Free Energy (Liquid 3)	kJ/kmol	result
`PROP_MS_225`	Molar Helmholtz Free Energy (Liquid 3)	kJ/kmol	result
`PROP_MS_226`	Molar Internal Energy (Aqueous Phase)	kJ/kmol	result
`PROP_MS_227`	Molar Gibbs Free Energy (Aqueous Phase)	kJ/kmol	result
`PROP_MS_228`	Molar Helmholtz Free Energy (Aqueous Phase)	kJ/kmol	result
`PROP_MS_229`	Molar Internal Energy (Solid)	kJ/kmol	result
`PROP_MS_230`	Molar Gibbs Free Energy (Solid)	kJ/kmol	result
`PROP_MS_231`	Molar Helmholtz Free Energy (Solid)	kJ/kmol	result
`PROP_MS_232/Methane`	Molality (Mixture) / Methane	mol/Kg Water	result
`PROP_MS_232/Ethane`	Molality (Mixture) / Ethane	mol/Kg Water	result
`PROP_MS_232/Propane`	Molality (Mixture) / Propane	mol/Kg Water	result
`PROP_MS_232/N-butane`	Molality (Mixture) / N-butane	mol/Kg Water	result
`PROP_MS_232/N-pentane`	Molality (Mixture) / N-pentane	mol/Kg Water	result
`PROP_MS_233/Methane`	Molality (Vapor Phase) / Methane	mol/Kg Water	result
`PROP_MS_233/Ethane`	Molality (Vapor Phase) / Ethane	mol/Kg Water	result
`PROP_MS_233/Propane`	Molality (Vapor Phase) / Propane	mol/Kg Water	result
`PROP_MS_233/N-butane`	Molality (Vapor Phase) / N-butane	mol/Kg Water	result
`PROP_MS_233/N-pentane`	Molality (Vapor Phase) / N-pentane	mol/Kg Water	result
`PROP_MS_234/Methane`	Molality (Overall Liquid) / Methane	mol/Kg Water	result
`PROP_MS_234/Ethane`	Molality (Overall Liquid) / Ethane	mol/Kg Water	result
`PROP_MS_234/Propane`	Molality (Overall Liquid) / Propane	mol/Kg Water	result
`PROP_MS_234/N-butane`	Molality (Overall Liquid) / N-butane	mol/Kg Water	result
`PROP_MS_234/N-pentane`	Molality (Overall Liquid) / N-pentane	mol/Kg Water	result
`PROP_MS_235/Methane`	Molality (Liquid Phase 1) / Methane	mol/Kg Water	result
`PROP_MS_235/Ethane`	Molality (Liquid Phase 1) / Ethane	mol/Kg Water	result
`PROP_MS_235/Propane`	Molality (Liquid Phase 1) / Propane	mol/Kg Water	result
`PROP_MS_235/N-butane`	Molality (Liquid Phase 1) / N-butane	mol/Kg Water	result
`PROP_MS_235/N-pentane`	Molality (Liquid Phase 1) / N-pentane	mol/Kg Water	result
`PROP_MS_236/Methane`	Molality (Liquid Phase 2) / Methane	mol/Kg Water	result
`PROP_MS_236/Ethane`	Molality (Liquid Phase 2) / Ethane	mol/Kg Water	result
`PROP_MS_236/Propane`	Molality (Liquid Phase 2) / Propane	mol/Kg Water	result
`PROP_MS_236/N-butane`	Molality (Liquid Phase 2) / N-butane	mol/Kg Water	result
`PROP_MS_236/N-pentane`	Molality (Liquid Phase 2) / N-pentane	mol/Kg Water	result
`PROP_MS_238/Methane`	Molality (Solid Phase) / Methane	mol/Kg Water	result
`PROP_MS_238/Ethane`	Molality (Solid Phase) / Ethane	mol/Kg Water	result
`PROP_MS_238/Propane`	Molality (Solid Phase) / Propane	mol/Kg Water	result
`PROP_MS_238/N-butane`	Molality (Solid Phase) / N-butane	mol/Kg Water	result
`PROP_MS_238/N-pentane`	Molality (Solid Phase) / N-pentane	mol/Kg Water	result
`PROP_MS_239/Methane`	Molarity (Mixture) / Methane	mol/m3	result
`PROP_MS_239/Ethane`	Molarity (Mixture) / Ethane	mol/m3	result
`PROP_MS_239/Propane`	Molarity (Mixture) / Propane	mol/m3	result
`PROP_MS_239/N-butane`	Molarity (Mixture) / N-butane	mol/m3	result
`PROP_MS_239/N-pentane`	Molarity (Mixture) / N-pentane	mol/m3	result
`PROP_MS_240/Methane`	Molarity (Vapor Phase) / Methane	mol/m3	result
`PROP_MS_240/Ethane`	Molarity (Vapor Phase) / Ethane	mol/m3	result
`PROP_MS_240/Propane`	Molarity (Vapor Phase) / Propane	mol/m3	result
`PROP_MS_240/N-butane`	Molarity (Vapor Phase) / N-butane	mol/m3	result
`PROP_MS_240/N-pentane`	Molarity (Vapor Phase) / N-pentane	mol/m3	result
`PROP_MS_241/Methane`	Molarity (Overall Liquid) / Methane	mol/m3	result
`PROP_MS_241/Ethane`	Molarity (Overall Liquid) / Ethane	mol/m3	result
`PROP_MS_241/Propane`	Molarity (Overall Liquid) / Propane	mol/m3	result
`PROP_MS_241/N-butane`	Molarity (Overall Liquid) / N-butane	mol/m3	result
`PROP_MS_241/N-pentane`	Molarity (Overall Liquid) / N-pentane	mol/m3	result
`PROP_MS_242/Methane`	Molarity (Liquid Phase 1) / Methane	mol/m3	result
`PROP_MS_242/Ethane`	Molarity (Liquid Phase 1) / Ethane	mol/m3	result
`PROP_MS_242/Propane`	Molarity (Liquid Phase 1) / Propane	mol/m3	result
`PROP_MS_242/N-butane`	Molarity (Liquid Phase 1) / N-butane	mol/m3	result
`PROP_MS_242/N-pentane`	Molarity (Liquid Phase 1) / N-pentane	mol/m3	result
`PROP_MS_243/Methane`	Molarity (Liquid Phase 2) / Methane	mol/m3	result
`PROP_MS_243/Ethane`	Molarity (Liquid Phase 2) / Ethane	mol/m3	result
`PROP_MS_243/Propane`	Molarity (Liquid Phase 2) / Propane	mol/m3	result
`PROP_MS_243/N-butane`	Molarity (Liquid Phase 2) / N-butane	mol/m3	result
`PROP_MS_243/N-pentane`	Molarity (Liquid Phase 2) / N-pentane	mol/m3	result
`PROP_MS_244/Methane`	Molarity (Aqueous Phase) / Methane	mol/m3	result
`PROP_MS_244/Ethane`	Molarity (Aqueous Phase) / Ethane	mol/m3	result
`PROP_MS_244/Propane`	Molarity (Aqueous Phase) / Propane	mol/m3	result
`PROP_MS_244/N-butane`	Molarity (Aqueous Phase) / N-butane	mol/m3	result
`PROP_MS_244/N-pentane`	Molarity (Aqueous Phase) / N-pentane	mol/m3	result
`PROP_MS_245/Methane`	Molarity (Solid Phase) / Methane	mol/m3	result
`PROP_MS_245/Ethane`	Molarity (Solid Phase) / Ethane	mol/m3	result
`PROP_MS_245/Propane`	Molarity (Solid Phase) / Propane	mol/m3	result
`PROP_MS_245/N-butane`	Molarity (Solid Phase) / N-butane	mol/m3	result
`PROP_MS_245/N-pentane`	Molarity (Solid Phase) / N-pentane	mol/m3	result
`PROP_MS_154`	Energy Flow	kW	result
`PROP_MS_250`	Ideal Gas Heat Capacity Cp (Vapor)	kJ/kg	result
`PROP_MS_251`	Ideal Gas Heat Capacity Cp (Liquid 1)	kJ/kg	result
`PROP_MS_252`	Ideal Gas Heat Capacity Cp (Liquid 2)	kJ/kg	result
`PROP_MS_253`	Ideal Gas Heat Capacity Cp (Overall Liquid)	kJ/kg	result
`PROP_MS_254`	Ideal Gas Heat Capacity Cp (Solid)	kJ/kg	result
`PROP_MS_255`	Ideal Gas Heat Capacity Ratio (Vapor)		result
`PROP_MS_256`	Ideal Gas Heat Capacity Ratio (Liquid 1)		result
`PROP_MS_257`	Ideal Gas Heat Capacity Ratio (Liquid 2)		result
`PROP_MS_258`	Ideal Gas Heat Capacity Ratio (Overall Liquid)		result
`PROP_MS_259`	Ideal Gas Heat Capacity Ratio (Solid)		result
`CO2 Loading`			result
`CO2 Partial Pressure`		Pa	result
`H2S Loading`			result
`H2S Partial Pressure`		Pa	result
`Mean Particle Size (Solid)`		mm	result
`Particle Size Standard Deviation (Solid)`		mm	result
`PROP_MS_260`	Volumetric Fraction (Vapor)		result
`PROP_MS_261`	Volumetric Fraction (Overall Liquid)		result
`PROP_MS_262`	Volumetric Fraction (Liquid 1)		result
`PROP_MS_263`	Volumetric Fraction (Liquid 2)		result
`PROP_MS_264`	Volumetric Fraction (Solid)		result

The object also exposes 10 indexed results under Activity Coefficient, one per segment or step, for example Activity Coefficient, Liquid Phase 1 / Methane.

The object also exposes 15 indexed results under Fugacity Coefficient, one per segment or step, for example Fugacity Coefficient, Vapor Phase / Methane.

The object also exposes 15 indexed results under Diffusion Coefficient, one per segment or step, for example Diffusion Coefficient, Vapor Phase / Methane.

Learn more¶

API members¶

Public members declared by this class. Inherited members are documented on the base classes.

Constructors¶

MaterialStream(): Initializes a new instance of MaterialStream with default phase collection and stream conditions.

Initializes a new instance of MaterialStream with default phase collection and stream conditions.

C#VB.NET

public MaterialStream()

Public Sub New()

MaterialStream(string, string): Initializes a new instance of MaterialStream with a name and description, without a flowsheet.

Initializes a new instance of MaterialStream with a name and description, without a flowsheet.

Parameter	Type	Description
`name`	`String`	Display name of the stream.
`description`	`String`	Description of the stream.

C#VB.NET

public MaterialStream(string name, string description)

Public Sub New(name As String, description As String)

MaterialStream(string, string, IFlowsheet, PropertyPackage): Initializes a new instance of MaterialStream attached to a flowsheet and property package.

Initializes a new instance of MaterialStream attached to a flowsheet and property package.

Parameter	Type	Description
`name`	`String`	Display name of the stream.
`description`	`String`	Description of the stream.
`flowsheet`	`IFlowsheet`	The parent flowsheet.
`proppack`	`PropertyPackage`	The property package to use for calculations.

C#VB.NET

public MaterialStream(string name, string description, IFlowsheet flowsheet, PropertyPackage proppack)

Public Sub New(name As String, description As String, flowsheet As IFlowsheet, proppack As PropertyPackage)

Properties¶

EditorState: Gets or sets the serialized JSON state of the stream editor UI.

Gets or sets the serialized JSON state of the stream editor UI.

C#VB.NET

public string EditorState { get; set; }

Public Property EditorState As String

EquilibriumCalculatedExternally: Set when the phase split of this stream was worked out by something other than the property package of the...

Set when the phase split of this stream was worked out by something other than the property package of the flowsheet, as a CAPE-OPEN unit operation does with its own thermodynamics. The next calculation keeps that split and only works out the properties, then clears the flag.

C#VB.NET

public bool EquilibriumCalculatedExternally { get; set; }

Public Property EquilibriumCalculatedExternally As Boolean

GeneratePhaseEnvelopeLookup: Gets or sets whether the stream builds a phase envelope lookup table for its composition before each equilibrium...

Gets or sets whether the stream builds a phase envelope lookup table for its composition before each equilibrium calculation (rebuilt only when the composition changes). The table is used to identify the phase and to give initial temperature estimates to PH and PS flashes. Default False.

C#VB.NET

public bool GeneratePhaseEnvelopeLookup { get; set; }

Public Property GeneratePhaseEnvelopeLookup As Boolean

HasPropertiesForDynamicMode: Returns False because material streams do not expose properties specific to dynamic mode.

Returns False because material streams do not expose properties specific to dynamic mode.

C#VB.NET

public override bool HasPropertiesForDynamicMode { get; }

Public Overrides ReadOnly Property HasPropertiesForDynamicMode As Boolean

LastSolutionInputData: Gets or sets the input data snapshot from the last successful solution.

Gets or sets the input data snapshot from the last successful solution.

C#VB.NET

public MaterialStreamInputData LastSolutionInputData { get; set; }

Public Property LastSolutionInputData As MaterialStreamInputData

Liquid1: Gets the first liquid phase (phase index 3).

Gets the first liquid phase (phase index 3).

C#VB.NET

public Phase Liquid1 { get; }

Public ReadOnly Property Liquid1 As Phase

Liquid2: Gets the second liquid phase (phase index 4).

Gets the second liquid phase (phase index 4).

C#VB.NET

public Phase Liquid2 { get; }

Public ReadOnly Property Liquid2 As Phase

MaximumAllowableDynamicMassFlowRate: Gets or sets the maximum allowable mass flow rate during dynamic simulation, in kg/s.

Gets or sets the maximum allowable mass flow rate during dynamic simulation, in kg/s.

C#VB.NET

public double? MaximumAllowableDynamicMassFlowRate { get; set; }

Public Property MaximumAllowableDynamicMassFlowRate As Double?

Mixture: Gets the overall mixture phase (phase index 0).

Gets the overall mixture phase (phase index 0).

C#VB.NET

public Phase Mixture { get; }

Public ReadOnly Property Mixture As Phase

MobileCompatible: Returns True to indicate that this stream is compatible with the DWSIM mobile client.

Returns True to indicate that this stream is compatible with the DWSIM mobile client.

C#VB.NET

public override bool MobileCompatible { get; }

Public Overrides ReadOnly Property MobileCompatible As Boolean

ObjectClass: Gets or sets the simulation object class for this stream.

Gets or sets the simulation object class for this stream.

C#VB.NET

public override SimulationObjectClass ObjectClass { get; set; }

Public Overrides Property ObjectClass As SimulationObjectClass

OverallLiquid: Gets the overall liquid phase (phase index 1).

Gets the overall liquid phase (phase index 1).

C#VB.NET

public Phase OverallLiquid { get; }

Public ReadOnly Property OverallLiquid As Phase

OverrideSingleCompoundFlashBehavior: Use this property to disable automatic PH-Flash for single-compound streams connected to unit operations.

Use this property to disable automatic PH-Flash for single-compound streams connected to unit operations. Default is 'False'.

C#VB.NET

public bool OverrideSingleCompoundFlashBehavior { get; set; }

Public Property OverrideSingleCompoundFlashBehavior As Boolean

PhaseEnvelopeLookup: Gets or sets the phase envelope lookup table built for the current composition of this stream, or Nothing when none...

Gets or sets the phase envelope lookup table built for the current composition of this stream, or Nothing when none has been built.

C#VB.NET

public PhaseEnvelopeLookupTable PhaseEnvelopeLookup { get; set; }

Public Property PhaseEnvelopeLookup As PhaseEnvelopeLookupTable

PhaseEnvelopeLookupMode: Gets or sets which curves the phase envelope lookup table includes: WidomOnly (bubble, dew and Widom lines; default)...

Gets or sets which curves the phase envelope lookup table includes: WidomOnly (bubble, dew and Widom lines; default) or FullEnvelope (also the solid-liquid equilibrium lines).

C#VB.NET

public PhaseEnvelopeLookupMode PhaseEnvelopeLookupMode { get; set; }

Public Property PhaseEnvelopeLookupMode As PhaseEnvelopeLookupMode

PropertyPackage: Gets or sets the associated Property Package for this stream.

Gets or sets the associated Property Package for this stream.

C#VB.NET

public PropertyPackage PropertyPackage { get; set; }

Public Property PropertyPackage As PropertyPackage

Solid: Gets the solid phase (phase index 7).

Gets the solid phase (phase index 7).

C#VB.NET

public Phase Solid { get; }

Public ReadOnly Property Solid As Phase

SupportsDynamicMode: Returns True to indicate that this stream supports dynamic simulation mode.

Returns True to indicate that this stream supports dynamic simulation mode.

C#VB.NET

public override bool SupportsDynamicMode { get; }

Public Overrides ReadOnly Property SupportsDynamicMode As Boolean

TotalEnergyFlow: Gets or sets the total energy flow associated with this stream, in kW.

Gets or sets the total energy flow associated with this stream, in kW.

C#VB.NET

public double TotalEnergyFlow { get; set; }

Public Property TotalEnergyFlow As Double

Vapor: Gets the vapor phase (phase index 2).

Gets the vapor phase (phase index 2).

C#VB.NET

public Phase Vapor { get; }

Public ReadOnly Property Vapor As Phase

Methods¶

Add(MaterialStream, double): Adds a material stream to this one, returning the resulting mixed stream, leaving this instance unmodifed.

Adds a material stream to this one, returning the resulting mixed stream, leaving this instance unmodifed.

Parameter	Type	Description
`stream`	`MaterialStream`	Stream to be mixed with this one.
`Factor`	`Double`	Flow multiplier for the stream to be mixed with this one. Default is 1.0.

C#VB.NET

public MaterialStream Add(MaterialStream stream, double Factor = 1)

Public Function Add(stream As MaterialStream, Factor As Double = 1) As MaterialStream

Assign(IMaterialStream): Copies basic properties from another stream.

Copies basic properties from another stream.

Parameter	Type	Description
`ASource`	`IMaterialStream`	Stream to be used as the source

C#VB.NET

public void Assign(IMaterialStream ASource)

Public Sub Assign(ASource As IMaterialStream)

AssignFromPhase(PhaseLabel, MaterialStream, bool): Assign properties from another phase in another stream.

Assign properties from another phase in another stream.

Parameter	Type	Description
`phase`	`PhaseLabel`	Phase to assign proeprties from.
`stream`	`MaterialStream`	Stream to read phase properties from.
`SetW`	`Boolean`	True to set the overall mass flow from the other stream phase.

C#VB.NET

public void AssignFromPhase(PhaseLabel phase, MaterialStream stream, bool SetW)

Public Sub AssignFromPhase(phase As PhaseLabel, stream As MaterialStream, SetW As Boolean)

AssignProps(IMaterialStream): Copies phase properties from another stream.

Copies phase properties from another stream.

Parameter	Type	Description
`ASource`	`IMaterialStream`	Source stream

C#VB.NET

public void AssignProps(IMaterialStream ASource)

Public Sub AssignProps(ASource As IMaterialStream)

AssignSelfToPP(): Sets this stream as the current material stream on the associated property package.

Sets this stream as the current material stream on the associated property package.

C#VB.NET

public void AssignSelfToPP()

Public Sub AssignSelfToPP()

AssignSolidData(MaterialStream): Copies solid particle and additional solid phase data from another stream.

Copies solid particle and additional solid phase data from another stream.

Parameter	Type	Description
`source`	`MaterialStream`	Source stream to copy solid data from.

C#VB.NET

public void AssignSolidData(MaterialStream source)

Public Sub AssignSolidData(source As MaterialStream)

BuildPhaseEnvelopeLookupAsync(PhaseEnvelopeLookupMode): Starts building the phase envelope lookup table for the current composition on a background task, using a clone of...

Starts building the phase envelope lookup table for the current composition on a background task, using a clone of the property package. Does nothing if a build is already running. The new table replaces PhaseEnvelopeLookup when the task finishes.

Parameter	Type	Description
`mode`	`PhaseEnvelopeLookupMode`	Which curves to include: `WidomOnly` (bubble, dew and Widom lines) or `FullEnvelope` (also the solid-liquid equilibrium lines).

C#VB.NET

public void BuildPhaseEnvelopeLookupAsync(PhaseEnvelopeLookupMode mode = PhaseEnvelopeLookupMode.WidomOnly)

Public Sub BuildPhaseEnvelopeLookupAsync(mode As PhaseEnvelopeLookupMode = PhaseEnvelopeLookupMode.WidomOnly)

CalcOverallCompMassFractions(): Calculates and stores the overall mass fractions for each compound from the current mole fractions and molecular...

Calculates and stores the overall mass fractions for each compound from the current mole fractions and molecular weights.

C#VB.NET

public void CalcOverallCompMassFractions()

Public Sub CalcOverallCompMassFractions()

CalcOverallCompMoleFractions(): Calculates and stores the overall mole fractions for each compound from the current mass fractions and molecular...

Calculates and stores the overall mole fractions for each compound from the current mass fractions and molecular weights.

C#VB.NET

public void CalcOverallCompMoleFractions()

Public Sub CalcOverallCompMoleFractions()

CalcOverallMolecularWeight(): Calculates the molecular weight of the overall mixture from current mole fractions and compound molecular weights.

Calculates the molecular weight of the overall mixture from current mole fractions and compound molecular weights.

C#VB.NET

public double CalcOverallMolecularWeight()

Public Function CalcOverallMolecularWeight() As Double

CalcPhaseMassComposition(Phase): Calculates and stores the mass fractions for each compound in the specified phase, based on the current mole fractions.

Calculates and stores the mass fractions for each compound in the specified phase, based on the current mole fractions.

Parameter	Type	Description
`dwp`	`Phase`	The phase for which mass fractions are calculated.

C#VB.NET

public void CalcPhaseMassComposition(Phase dwp)

Public Sub CalcPhaseMassComposition(dwp As Phase)

Calculate(bool, bool): Calculates equilibrium and/or properties for this stream.

Calculates equilibrium and/or properties for this stream.

Parameter	Type	Description
`equilibrium`	`Boolean`
`properties`	`Boolean`

C#VB.NET

public void Calculate(bool equilibrium, bool properties)

Public Sub Calculate(equilibrium As Boolean, properties As Boolean)

Calculate(object): Triggers a full equilibrium and property calculation for this stream, respecting flowsheet options.

Triggers a full equilibrium and property calculation for this stream, respecting flowsheet options.

Parameter	Type	Description
`args`	`Object`	Optional calculation arguments (unused).

C#VB.NET

public override void Calculate(object args = null)

Public Overrides Sub Calculate(args As Object = Nothing)

CheckDirtyStatus(): Compares the current stream inputs against the last solution snapshot and marks the stream dirty if anything has...

Compares the current stream inputs against the last solution snapshot and marks the stream dirty if anything has changed.

C#VB.NET

public override void CheckDirtyStatus()

Public Overrides Sub CheckDirtyStatus()

Clear(): Clears the basic phase properties of this stream.

Clears the basic phase properties of this stream.

C#VB.NET

public void Clear()

Public Sub Clear()

ClearCalculatedProps(): Clear all calculated props on this stream.

Clear all calculated props on this stream.

C#VB.NET

public void ClearCalculatedProps()

Public Sub ClearCalculatedProps()

ClearPropertyPackageInstance(): Removes the directly-assigned property package instance, reverting to flowsheet lookup.

Removes the directly-assigned property package instance, reverting to flowsheet lookup.

C#VB.NET

public override bool ClearPropertyPackageInstance()

Public Overrides Function ClearPropertyPackageInstance() As Boolean

Clone(): Creates and returns a shallow clone of this stream.

Creates and returns a shallow clone of this stream.

C#VB.NET

public override object Clone()

Public Overrides Function Clone() As Object

CloneXML(): Creates a deep copy of this stream by adding compounds from the flowsheet and copying all properties.

Creates a deep copy of this stream by adding compounds from the flowsheet and copying all properties.

C#VB.NET

public override object CloneXML()

Public Overrides Function CloneXML() As Object

CloseEditForm(): Closes the stream editor form if it is currently open.

Closes the stream editor form if it is currently open.

C#VB.NET

public override void CloseEditForm()

Public Overrides Sub CloseEditForm()

CopyCompositions(PhaseLabel, PhaseLabel): Copy mass/mole fractions from one phase to another.

Copy mass/mole fractions from one phase to another.

Parameter	Type	Description
`fromphase`	`PhaseLabel`	Phase to copy compositions from
`tophase`	`PhaseLabel`	Phase to copy compositions to

C#VB.NET

public void CopyCompositions(PhaseLabel fromphase, PhaseLabel tophase)

Public Sub CopyCompositions(fromphase As PhaseLabel, tophase As PhaseLabel)

DeepClear(): Clears basic phase properties and all calculated thermodynamic properties on this stream.

Clears basic phase properties and all calculated thermodynamic properties on this stream.

C#VB.NET

public void DeepClear()

Public Sub DeepClear()

DisplayEditForm(): Opens or activates the stream editor form.

Opens or activates the stream editor form.

C#VB.NET

public override void DisplayEditForm()

Public Overrides Sub DisplayEditForm()

Empty(): Clears all phase properties, including temperature, pressure and overall composition.

Clears all phase properties, including temperature, pressure and overall composition.

C#VB.NET

public void Empty()

Public Sub Empty()

EmptyPropertyPackage(): Returns whether the stream has no property package assigned, neither by ID nor by direct instance.

Returns whether the stream has no property package assigned, neither by ID nor by direct instance.

C#VB.NET

public bool EmptyPropertyPackage()

Public Function EmptyPropertyPackage() As Boolean

EqualizeOverallComposition(): Sets equal mole fractions for all compounds in the overall mixture.

Sets equal mole fractions for all compounds in the overall mixture.

C#VB.NET

public void EqualizeOverallComposition()

Public Sub EqualizeOverallComposition()

EstimateTemperatureFromPH(double, double): Estimates the temperature at the given pressure and enthalpy by interpolating the bubble and dew curves of the phase...

Estimates the temperature at the given pressure and enthalpy by interpolating the bubble and dew curves of the phase envelope lookup table. Used as the initial estimate of PH flashes.

Parameter	Type	Description
`P`	`Double`	Pressure, in Pa.
`H`	`Double`	Mass enthalpy, in kJ/kg.

C#VB.NET

public double EstimateTemperatureFromPH(double P, double H)

Public Function EstimateTemperatureFromPH(P As Double, H As Double) As Double

EstimateTemperatureFromPS(double, double): Estimates the temperature at the given pressure and entropy by interpolating the bubble and dew curves of the phase...

Estimates the temperature at the given pressure and entropy by interpolating the bubble and dew curves of the phase envelope lookup table. Used as the initial estimate of PS flashes.

Parameter	Type	Description
`P`	`Double`	Pressure, in Pa.
`S`	`Double`	Mass entropy, in kJ/(kg.K).

C#VB.NET

public double EstimateTemperatureFromPS(double P, double S)

Public Function EstimateTemperatureFromPS(P As Double, S As Double) As Double

GetCompoundNames(): Returns an array of compound names present in this stream.

Returns an array of compound names present in this stream.

C#VB.NET

public string[] GetCompoundNames()

Public Function GetCompoundNames() As String()

GetDebugReport(): Runs a full equilibrium and property calculation and returns diagnostic text output for debugging.

Runs a full equilibrium and property calculation and returns diagnostic text output for debugging.

C#VB.NET

public override string GetDebugReport()

Public Overrides Function GetDebugReport() As String

GetDefaultProperties(): Returns the default set of property identifiers shown for this stream in the property panel.

Returns the default set of property identifiers shown for this stream in the property panel.

C#VB.NET

public override string[] GetDefaultProperties()

Public Overrides Function GetDefaultProperties() As String()

GetDisplayDescription(): Returns the localised display description for this stream type.

Returns the localised display description for this stream type.

C#VB.NET

public override string GetDisplayDescription()

Public Overrides Function GetDisplayDescription() As String

GetDisplayName(): Returns the localised display name for this stream type.

Returns the localised display name for this stream type.

C#VB.NET

public override string GetDisplayName()

Public Overrides Function GetDisplayName() As String

GetFlashSpec(): Returns the current flash specification as a short string code (e.g.

Returns the current flash specification as a short string code (e.g. "PT", "PH", "PS", "PVF", "TVF").

C#VB.NET

public string GetFlashSpec()

Public Function GetFlashSpec() As String

GetIconBitmapBytes(): Returns the icon bitmap as a byte array for this stream object.

Returns the icon bitmap as a byte array for this stream object.

C#VB.NET

public override byte[] GetIconBitmapBytes()

Public Overrides Function GetIconBitmapBytes() As Byte()

GetMassEnthalpyAt(double, bool): Calculates the overall mass enthalpy this stream would have at another temperature and its current pressure, on a...

Calculates the overall mass enthalpy this stream would have at another temperature and its current pressure, on a temporary clone; the stream itself is left unchanged.

Parameter	Type	Description
`T`	`Double`	Temperature, in K.
`calc_eq`	`Boolean`	`True` to recalculate the phase equilibrium at the new temperature; `False` to keep the current phase split.

C#VB.NET

public double GetMassEnthalpyAt(double T, bool calc_eq = true)

Public Function GetMassEnthalpyAt(T As Double, calc_eq As Boolean = True) As Double

GetMassEnthalpyAt(double, double, bool): Calculates the overall mass enthalpy this stream would have at another temperature and pressure, on a temporary...

Calculates the overall mass enthalpy this stream would have at another temperature and pressure, on a temporary clone; the stream itself is left unchanged.

Parameter	Type	Description
`T`	`Double`	Temperature, in K.
`P`	`Double`	Pressure, in Pa.
`calc_eq`	`Boolean`	`True` to recalculate the phase equilibrium at the new conditions; `False` to keep the current phase split.

C#VB.NET

public double GetMassEnthalpyAt(double T, double P, bool calc_eq = true)

Public Function GetMassEnthalpyAt(T As Double, P As Double, calc_eq As Boolean = True) As Double

GetMassEntropy(): Returns the overall mass entropy.

Returns the overall mass entropy.

C#VB.NET

public double GetMassEntropy()

Public Function GetMassEntropy() As Double

GetOverallMolecularWeight(): Returns the molecular weight of the overall mixture.

Returns the molecular weight of the overall mixture.

C#VB.NET

public double GetOverallMolecularWeight()

Public Function GetOverallMolecularWeight() As Double

GetPhase(string): Returns the Phase object corresponding to the given phase name.

Returns the Phase object corresponding to the given phase name.

Parameter	Type	Description
`phasename`	`String`	Phase name (e.g. "Vapor", "Liquid1", "Solid", "Mixture").

C#VB.NET

public Phase GetPhase(string phasename)

Public Function GetPhase(phasename As String) As Phase

GetPhaseMassFlow(string): Returns the mass flow rate of the phase with the given name, in kg/s.

Returns the mass flow rate of the phase with the given name, in kg/s.

Parameter	Type	Description
`phasename`	`String`	Phase name (e.g. "Vapor", "Liquid1", "Solid").

C#VB.NET

public object GetPhaseMassFlow(string phasename)

Public Function GetPhaseMassFlow(phasename As String) As Object

GetPhaseMassFraction(string): Returns the mass fraction of the phase with the given name.

Returns the mass fraction of the phase with the given name.

Parameter	Type	Description
`phasename`	`String`	Phase name (e.g. "Vapor", "Liquid1", "Solid").

C#VB.NET

public object GetPhaseMassFraction(string phasename)

Public Function GetPhaseMassFraction(phasename As String) As Object

GetPhaseMolarFlow(string): Returns the molar flow rate of the phase with the given name, in mol/s.

Returns the molar flow rate of the phase with the given name, in mol/s.

Parameter	Type	Description
`phasename`	`String`	Phase name (e.g. "Vapor", "Liquid1", "Solid").

C#VB.NET

public object GetPhaseMolarFlow(string phasename)

Public Function GetPhaseMolarFlow(phasename As String) As Object

GetPhaseMolarFraction(string): Returns the molar fraction of the phase with the given name.

Returns the molar fraction of the phase with the given name.

Parameter	Type	Description
`phasename`	`String`	Phase name (e.g. "Vapor", "Liquid1", "Solid").

C#VB.NET

public double GetPhaseMolarFraction(string phasename)

Public Function GetPhaseMolarFraction(phasename As String) As Double

GetProcessFlowsheetProperties(): Returns the set of property identifiers displayed on the process flowsheet for this stream.

Returns the set of property identifiers displayed on the process flowsheet for this stream.

C#VB.NET

public string[] GetProcessFlowsheetProperties()

Public Function GetProcessFlowsheetProperties() As String()

GetProp(string, string): Returns a single property value for the given property and phase, using Mass basis.

Returns a single property value for the given property and phase, using Mass basis.

Parameter	Type	Description
`prop`	`String`	Property identifier.
`phase`	`String`	Phase label.

C#VB.NET

public double GetProp(string prop, string phase)

Public Function GetProp(prop As String, phase As String) As Double

GetProperties(PropertyType): Returns the list of property identifiers for the specified property type.

Returns the list of property identifiers for the specified property type.

Parameter	Type	Description
`proptype`	`PropertyType`	The category of properties to enumerate.

C#VB.NET

public override string[] GetProperties(PropertyType proptype)

Public Overrides Function GetProperties(proptype As PropertyType) As String()

GetPropertyDescription(string): Returns the localised description text for the specified property identifier.

Returns the localised description text for the specified property identifier.

Parameter	Type	Description
`p`	`String`	Property identifier string.

C#VB.NET

public override string GetPropertyDescription(string p)

Public Overrides Function GetPropertyDescription(p As String) As String

GetPropertyUnit(string, IUnitsOfMeasure): Returns the display unit string for the given property identifier.

Returns the display unit string for the given property identifier.

Parameter	Type	Description
`prop`	`String`	Property identifier string.
`su`	`IUnitsOfMeasure`	Unit system; defaults to SI if Nothing.

C#VB.NET

public override string GetPropertyUnit(string prop, IUnitsOfMeasure su = null)

Public Overrides Function GetPropertyUnit(prop As String, su As IUnitsOfMeasure = Nothing) As String

GetPropertyValue(string, IUnitsOfMeasure): Returns the value of a named stream property converted to the specified unit system.

Returns the value of a named stream property converted to the specified unit system.

Parameter	Type	Description
`prop`	`String`	Property identifier string.
`su`	`IUnitsOfMeasure`	Unit system to convert the result to; defaults to SI if Nothing.

C#VB.NET

public override object GetPropertyValue(string prop, IUnitsOfMeasure su = null)

Public Overrides Function GetPropertyValue(prop As String, su As IUnitsOfMeasure = Nothing) As Object

GetPropUnits(string, string, IUnitsOfMeasure): Returns the display unit string for a given CAPE-OPEN property and basis in the specified unit system.

Returns the display unit string for a given CAPE-OPEN property and basis in the specified unit system.

Parameter	Type	Description
`prop`	`String`	Property identifier.
`basis`	`String`	Basis (Mole or Mass).
`su`	`IUnitsOfMeasure`	Unit system.

C#VB.NET

public static string GetPropUnits(string prop, string basis, IUnitsOfMeasure su)

Public Shared Function GetPropUnits(prop As String, basis As String, su As IUnitsOfMeasure) As String

GetReport(IUnitsOfMeasure, CultureInfo, string): Generates a formatted text report for this stream.

Generates a formatted text report for this stream.

Parameter	Type	Description
`su`	`IUnitsOfMeasure`	Unit system to use for property values.
`ci`	`CultureInfo`	Culture info for number formatting.
`numberformat`	`String`	Number format string (e.g. "0.####").

C#VB.NET

public override string GetReport(IUnitsOfMeasure su, CultureInfo ci, string numberformat)

Public Overrides Function GetReport(su As IUnitsOfMeasure, ci As CultureInfo, numberformat As String) As String

GetSinglePhaseProp2(string, string, string): Helper that calls GetSinglePhaseProp and returns the result as a typed list.

Helper that calls GetSinglePhaseProp and returns the result as a typed list.

Parameter	Type	Description
`prop`	`String`	Property identifier.
`basis`	`String`	Basis (Mole or Mass).
`phaseLabel`	`String`	Phase label.

C#VB.NET

public List<double> GetSinglePhaseProp2(string prop, string basis, string phaseLabel)

Public Function GetSinglePhaseProp2(prop As String, basis As String, phaseLabel As String) As List(Of Double)

GetSinglePhasePropDefaultUnits(string, string): Returns the default SI unit string for the given single-phase property and basis.

Returns the default SI unit string for the given single-phase property and basis.

Parameter	Type	Description
`property`	`String`	CAPE-OPEN property identifier.
`basis`	`String`	Basis (Mole or Mass).

C#VB.NET

public string GetSinglePhasePropDefaultUnits(string property, string basis)

Public Function GetSinglePhasePropDefaultUnits([property] As String, basis As String) As String

GetStructuredReport(): Returns a structured list of report items (labels and values) for display in the DWSIM report panel.

Returns a structured list of report items (labels and values) for display in the DWSIM report panel.

C#VB.NET

public override List<Tuple<ReportItemType, string[]>> GetStructuredReport()

Public Overrides Function GetStructuredReport() As List(Of Tuple(Of ReportItemType, String()))

InvalidatePhaseEnvelopeLookup(): Marks the current phase envelope lookup table as not ready, so it is no longer used and gets rebuilt.

Marks the current phase envelope lookup table as not ready, so it is no longer used and gets rebuilt.

C#VB.NET

public void InvalidatePhaseEnvelopeLookup()

Public Sub InvalidatePhaseEnvelopeLookup()

LoadData(List<XElement>): Restores stream state from a list of XML elements previously produced by SaveData.

Restores stream state from a list of XML elements previously produced by SaveData.

Parameter	Type	Description
`data`	`List<XElement>`	XML elements containing serialized stream data.

C#VB.NET

public override bool LoadData(List<XElement> data)

Public Overrides Function LoadData(data As List(Of XElement)) As Boolean

MassFractionsToMoleFractions(double[]): Converts mass fractions to mole fractions using the current compound list.

Converts mass fractions to mole fractions using the current compound list.

Parameter	Type	Description
`massfractions`	`Double[]`

C#VB.NET

public double[] MassFractionsToMoleFractions(double[] massfractions)

Public Function MassFractionsToMoleFractions(massfractions As Double()) As Double()

Mix(MaterialStream): Mixes this stream with another one.

Mixes this stream with another one.

Parameter	Type	Description
`withstream`	`MaterialStream`	Stream to mix this one with.

C#VB.NET

public void Mix(MaterialStream withstream)

Public Sub Mix(withstream As MaterialStream)

MoleFractionsToMassFractions(double[]): Converts mole fractions to mass fractions using the current compound list.

Converts mole fractions to mass fractions using the current compound list.

Parameter	Type	Description
`molefractions`	`Double[]`

C#VB.NET

public double[] MoleFractionsToMassFractions(double[] molefractions)

Public Function MoleFractionsToMassFractions(molefractions As Double()) As Double()

NormalizeOverallMassComposition(): Normalises the overall mass fractions so that they sum to 1.

Normalises the overall mass fractions so that they sum to 1.

C#VB.NET

public void NormalizeOverallMassComposition()

Public Sub NormalizeOverallMassComposition()

NormalizeOverallMoleComposition(): Normalises the overall mole fractions so that they sum to 1.

Normalises the overall mole fractions so that they sum to 1.

C#VB.NET

public void NormalizeOverallMoleComposition()

Public Sub NormalizeOverallMoleComposition()

QueryPhaseRegion(double, double): Returns the phase region of the stream composition at the given conditions from the phase envelope lookup table.

Returns the phase region of the stream composition at the given conditions from the phase envelope lookup table.

Parameter	Type	Description
`T`	`Double`	Temperature, in K.
`P`	`Double`	Pressure, in Pa.

C#VB.NET

public PhaseRegion QueryPhaseRegion(double T, double P)

Public Function QueryPhaseRegion(T As Double, P As Double) As PhaseRegion

RunDynamicModel(): Executes the dynamic model step for this stream, updating phase properties according to the integrator settings.

Executes the dynamic model step for this stream, updating phase properties according to the integrator settings.

C#VB.NET

public override void RunDynamicModel()

Public Overrides Sub RunDynamicModel()

SaveData(): Serializes the stream state to a list of XML elements.

Serializes the stream state to a list of XML elements.

C#VB.NET

public override List<XElement> SaveData()

Public Overrides Function SaveData() As List(Of XElement)

SetFlashSpec(string): Sets stream flash spec.

Sets stream flash spec.

Parameter	Type	Description
`value`	`String`	Flash Specification (PT, PH, PS, PVF, TVF, PSF, VT, VH or VS).

C#VB.NET

public string SetFlashSpec(string value)

Public Function SetFlashSpec(value As String) As String

SetMassEnthalpy(string): Sets the mass enthalpy according with the specified units.

Sets the mass enthalpy according with the specified units.

Parameter	Type	Description
`valuestring`	`String`	value + units, i.e. '2500 kJ/kg'

C#VB.NET

public string SetMassEnthalpy(string valuestring)

Public Function SetMassEnthalpy(valuestring As String) As String

SetMassEntropy(double): Sets stream mass entropy.

Sets stream mass entropy.

Parameter	Type	Description
`value`	`Double`	Entropy in kJ/[kg.K]

C#VB.NET

public string SetMassEntropy(double value)

Public Function SetMassEntropy(value As Double) As String

SetMassEntropy(string): Sets the mass entropy according with the specified units.

Sets the mass entropy according with the specified units.

Parameter	Type	Description
`valuestring`	`String`	value + units, i.e. '10 kJ/[kg.K]'

C#VB.NET

public string SetMassEntropy(string valuestring)

Public Function SetMassEntropy(valuestring As String) As String

SetMassFlow(string): Sets the mass flow according to the specified units.

Sets the mass flow according to the specified units.

Parameter	Type	Description
`valuestring`	`String`	value + units, i.e. '100 kg/h'

C#VB.NET

public string SetMassFlow(string valuestring)

Public Function SetMassFlow(valuestring As String) As String

SetMolarFlow(string): Sets the molar flow according to the specified units.

Sets the molar flow according to the specified units.

Parameter	Type	Description
`valuestring`	`String`	value + units, i.e. '100 kmol/h'

C#VB.NET

public string SetMolarFlow(string valuestring)

Public Function SetMolarFlow(valuestring As String) As String

SetOverallCompoundMassFlow(int, double): Set the mass flow for a single compound and updates the overall mass flow and composition.

Set the mass flow for a single compound and updates the overall mass flow and composition.

Parameter	Type	Description
`compoundIndex`	`Int32`	Name of the compound
`flow`	`Double`	flow rate in kg/s

C#VB.NET

public void SetOverallCompoundMassFlow(int compoundIndex, double flow)

Public Sub SetOverallCompoundMassFlow(compoundIndex As Integer, flow As Double)

SetOverallCompoundMassFlow(string, double): Set the mass flow for a single compound and updates the overall mass flow and composition.

Set the mass flow for a single compound and updates the overall mass flow and composition.

Parameter	Type	Description
`compoundName`	`String`	Name of the compound
`flow`	`Double`	flow rate in kg/s

C#VB.NET

public void SetOverallCompoundMassFlow(string compoundName, double flow)

Public Sub SetOverallCompoundMassFlow(compoundName As String, flow As Double)

SetOverallCompoundMolarFlow(int, double): Set the molar flow for a single compound and updates the overall molar flow and composition.

Set the molar flow for a single compound and updates the overall molar flow and composition.

Parameter	Type	Description
`compoundIndex`	`Int32`	Index of the compound
`flow`	`Double`	flow rate in mol/s

C#VB.NET

public void SetOverallCompoundMolarFlow(int compoundIndex, double flow)

Public Sub SetOverallCompoundMolarFlow(compoundIndex As Integer, flow As Double)

SetOverallCompoundMolarFlow(string, double): Set the molar flow for a single compound and updates the overall molar flow and composition.

Set the molar flow for a single compound and updates the overall molar flow and composition.

Parameter	Type	Description
`compoundName`	`String`	Name of the compound
`flow`	`Double`	flow rate in mol/s

C#VB.NET

public void SetOverallCompoundMolarFlow(string compoundName, double flow)

Public Sub SetOverallCompoundMolarFlow(compoundName As String, flow As Double)

SetPhaseComposition(double[], Phase): Sets the molar composition of a phase.

Sets the molar composition of a phase.

Parameter	Type	Description
`Vx`	`Double[]`	Molar composition array
`phase`	`Phase`	Phase to set composition of

C#VB.NET

public void SetPhaseComposition(double[] Vx, Phase phase)

Public Sub SetPhaseComposition(Vx As Double(), phase As Phase)

SetPressure(string): Sets the pressure according to the specified units.

Sets the pressure according to the specified units.

Parameter	Type	Description
`valuestring`	`String`	value + units, i.e. '34 atm'

C#VB.NET

public string SetPressure(string valuestring)

Public Function SetPressure(valuestring As String) As String

SetPropertyPackageInstance(IPropertyPackage): Assigns a property package instance directly to this stream, bypassing the flowsheet lookup.

Assigns a property package instance directly to this stream, bypassing the flowsheet lookup.

Parameter	Type	Description
`PP`	`IPropertyPackage`	The property package instance to assign.

C#VB.NET

public override void SetPropertyPackageInstance(IPropertyPackage PP)

Public Overrides Sub SetPropertyPackageInstance(PP As IPropertyPackage)

SetPropertyValue(string, object, IUnitsOfMeasure): Sets a stream property by identifier, converting the value from the specified unit system.

Sets a stream property by identifier, converting the value from the specified unit system.

Parameter	Type	Description
`prop`	`String`	Property identifier string.
`propval`	`Object`	New property value.
`su`	`IUnitsOfMeasure`	Unit system for the supplied value; defaults to SI if Nothing.

C#VB.NET

public override bool SetPropertyValue(string prop, object propval, IUnitsOfMeasure su = null)

Public Overrides Function SetPropertyValue(prop As String, propval As Object, su As IUnitsOfMeasure = Nothing) As Boolean

SetTemperature(string): Sets the temperature according to the specified units.

Sets the temperature according to the specified units.

Parameter	Type	Description
`valuestring`	`String`	value + units, i.e. '100 C'

C#VB.NET

public string SetTemperature(string valuestring)

Public Function SetTemperature(valuestring As String) As String

SetVolumetricFlow(string): Sets the volumetric flow according to the specified units.

Sets the volumetric flow according to the specified units.

Parameter	Type	Description
`valuestring`	`String`	value + units, i.e. '100 L/h'

C#VB.NET

public string SetVolumetricFlow(string valuestring)

Public Function SetVolumetricFlow(valuestring As String) As String

ShallowClone(): Creates a new MaterialStream with the same compounds, properties and settings as this one.

Creates a new MaterialStream with the same compounds, properties and settings as this one.

C#VB.NET

public MaterialStream ShallowClone()

Public Function ShallowClone() As MaterialStream

Subtract(MaterialStream, double): Subtracts a material stream contents from this one, returning a new stream object, leaving this instance unmodified.

Subtracts a material stream contents from this one, returning a new stream object, leaving this instance unmodified.

Parameter	Type	Description
`stream`	`MaterialStream`	Stream to subtract this one from.
`Factor`	`Double`	Flow multiplier for the stream to subtract from this one. Default is 1.0.

C#VB.NET

public MaterialStream Subtract(MaterialStream stream, double Factor = 1)

Public Function Subtract(stream As MaterialStream, Factor As Double = 1) As MaterialStream

SubtractFromPhase(double, Phase, bool): Subtracts a given mass flow from the specified phase and updates all phase and overall flows accordingly.

Subtracts a given mass flow from the specified phase and updates all phase and overall flows accordingly.

Parameter	Type	Description
`massflow`	`Double`	Mass flow to subtract, in kg/s.
`p`	`Phase`	Phase from which to subtract flow.
`calceq`	`Boolean`	If True, recalculates equilibrium after the subtraction.

C#VB.NET

public void SubtractFromPhase(double massflow, Phase p, bool calceq)

Public Sub SubtractFromPhase(massflow As Double, p As Phase, calceq As Boolean)

ThrowCAPEException(ref Exception, string, string, string, string, string, string, int): Stores the CAPE-OPEN error information exposed through the ECapeUser interface, appends the exception to the...

Stores the CAPE-OPEN error information exposed through the ECapeUser interface, appends the exception to the property package exception log and throws a CapeComputationException wrapping it.

Parameter	Type	Description
`ex`	`Exception`	The original exception.
`name`	`String`	The error name. Not stored.
`description`	`String`	The error description.
`interf`	`String`	The name of the CAPE-OPEN interface where the error occurred.
`moreinfo`	`String`	Additional information about the error (callers pass the exception source).
`operation`	`String`	The operation that failed (callers pass the stack trace).
`scope`	`String`	The scope of the error (callers pass the method name).
`code`	`Int32`	The error code (HRESULT).

C#VB.NET

public void ThrowCAPEException(ref Exception ex, string name, string description, string interf, string moreinfo, string operation, string scope, int code)

Public Sub ThrowCAPEException(ex As Exception, name As String, description As String, interf As String, moreinfo As String, operation As String, scope As String, code As Integer)

ToString(): Returns a string representation of this stream including T, P, flows, vapor fraction and compound mole fractions.

Returns a string representation of this stream including T, P, flows, vapor fraction and compound mole fractions.

C#VB.NET

public override string ToString()

Public Overrides Function ToString() As String

TranslateString(string): Converts a CAPE-OPEN property identifier string to a human-readable label.

Converts a CAPE-OPEN property identifier string to a human-readable label.

Parameter	Type	Description
`s`	`String`	CAPE-OPEN property identifier.

C#VB.NET

public string TranslateString(string s)

Public Function TranslateString(s As String) As String

UpdateEditForm(): Refreshes the stream editor form if it is currently open.

Refreshes the stream editor form if it is currently open.

C#VB.NET

public override void UpdateEditForm()

Public Overrides Sub UpdateEditForm()

Validate(): Validates the stream specification values and throws an ArgumentException if any are invalid.

Validates the stream specification values and throws an ArgumentException if any are invalid.

C#VB.NET

public override void Validate()

Public Overrides Sub Validate()

Fields¶

_pp: Backing field of PropertyPackage: holds a property package instance assigned directly (one that...

Backing field of PropertyPackage: holds a property package instance assigned directly (one that is not registered in the flowsheet, or set while the stream has no flowsheet). Flowsheet property packages are referenced through _ppid instead. Not saved with the flowsheet.

C#VB.NET

public PropertyPackage _pp

Public _pp As PropertyPackage

_ppid: The unique ID of the associated property package.

The unique ID of the associated property package.

C#VB.NET

public string _ppid

Public _ppid As String

f: The classic (WinForms) editor window open for this stream, if any.

The classic (WinForms) editor window open for this stream, if any. Not saved with the flowsheet.

C#VB.NET

public object f

Public f As Object

PostCreationAction1: Optional action executed after a new MaterialStream instance is created (slot 1).

Optional action executed after a new MaterialStream instance is created (slot 1).

C#VB.NET

public static Action<MaterialStream> PostCreationAction1

Public Shared PostCreationAction1 As Action(Of MaterialStream)

PostCreationAction2: Optional action executed after a new MaterialStream instance is created (slot 2).

Optional action executed after a new MaterialStream instance is created (slot 2).

C#VB.NET

public static Action<MaterialStream> PostCreationAction2

Public Shared PostCreationAction2 As Action(Of MaterialStream)

PostCreationAction3: Optional action executed after a new MaterialStream instance is created (slot 3).

Optional action executed after a new MaterialStream instance is created (slot 3).

C#VB.NET

public static Action<MaterialStream> PostCreationAction3

Public Shared PostCreationAction3 As Action(Of MaterialStream)