METSIM VALUE FUNCTIONS

Density and Specific Gravity Value Functions

P VKM3 S ;Density of phase P in stream S, kilograms per cubic meter.

P VPF3 S ;Density of phase P in stream S, pounds per cubic foot.
P VPGL S ;Density of phase P in stream S, pounds per gallon.
P VPSG S ;Specific gravity of phases P in stream S.
VSGC S ;Specific gravity of coal in stream S.
VSGM S ;Specific gravity of media in coal stream S.
VSPG S ;Specific gravity of all phases plus total of stream S.

Pressure Value Functions

VATMa S ;Pressure in stream S in atmospheres, actual.

VATMg S ;Pressure in stream S in atmospheres, gauge.
VBARa S ;Pressure in stream S in bars, actual.
VBARg S ;Pressure in stream S in bars, gauge.
VKPAa S ;Pressure in stream S in kiloPascals, actual.
VKPAg S ;Pressure in stream S in kiloPascals, gauge.
VINWa S ;Pressure in stream S in inches of water 60F, actual.
VINWg S ;Pressure in stream S in inches of water 60F, gauge.
VMHGa S ;Pressure in stream S in millimeters of mercury 0C, actual.
VMHGg S ;Pressure in stream S in millimeters of mercury 0C, gauge.
VMMWa S ;Pressure in stream S in millimeters of water 4C, actual.
VMMWg S ;Pressure in stream S in millimeters of water 4C, gauge.
VPSIa S ;Pressure in stream S in pounds per square inch, actual.
VPSIg S ;Pressure in stream S in pounds per square inch, gauge.

Temperature Value Functions

VTEC S ;Temperature of stream S in degrees C.

VTEF S ;Temperature of stream S in degrees F.
VTEK S ;Temperature of stream S in degrees K.
VTEM S ;Temperature of stream S in degrees C.
VTER S ;Temperature of stream S in degrees R.

Volume Value Functions

C VSPV S ;Specific volume of component C in stream S.

VLTR S ;Volume of stream S in liters.
P VICF S ;Volume of phases P in stream S in cubic feet.
P VICI S ;Volume of phases P in stream S in cubic inches.
P VICM S ;Volume of phases P in stream S in cubic meters.

Mass Flowrate Value Functions Adjusted for Operating Time

C VGMD S ;Flowrate of components C in stream S in grams per day.

C VGMH S ;Flowrate of components C in stream S in grams per hour.
C VGMM S ;Flowrate of components C in stream S in grams per minute.
C VGMS S ;Flowrate of components C in stream S in grams per second.
C VKGD S ;Flowrate of components C in stream S in kilograms per day.
C VKGH S ;Flowrate of components C in stream S in kilograms per hour.
C VKGM S ;Flowrate of components C in stream S in kilograms per minute.
C VKGS S ;Flowrate of components C in stream S in kilograms per second.
C VLBD S ;Flowrate of components C in stream S in pounds per day.
C VLBH S ;Flowrate of components C in stream S in pounds per hour.
C VLBM S ;Flowrate of components C in stream S in pounds per minute.
C VMTD S ;Flowrate of components C in stream S in metric tons per day.
C VMTH S ;Flowrate of components C in stream S in metric tons per hour.
C VMTM S ;Flowrate of components C in stream S in metric tons per minute.
C VMTS S ;Flowrate of components C in stream S in metric tons per second.
C VSTD S ;Flowrate of components C in stream S in short tons per day.
C VSTH S ;Flowrate of components C in stream S in short tons per hour.

Mass Flowrate Value Functions Not-Adjusted for Operating Time

VTOP S ;Flowrate of all phases in stream S in current units.

C VMTY S ;Flowrate of components C in stream S in metric tons per year.

Mass/Molar Flowrate Value Functions Not-Adjusted for Operating Time

The following flowrates are in the units specified in ICAS.

E VEFR S ;Mass flowrate of element E in stream S.

E VEWL S ;Mass flowrate of element E in liquid components in stream S.
E VEWS S ;Mass flowrate of element E in solid components in stream S.
E VEWT S ;Mass flowrate of element E in total stream S.
C VCWT S ;Mass flowrate of components C in stream S.
P VPWT S ;Mass flowrate of phases P in stream S.
C VSTR S ;Mass flowrate of components C in stream S.
E VOZD S ;Mass flowrate of element E in stream S in ounces per day.
C VCMT S ;Molar flowrate of components C in stream S.
E VEMT S ;Molar flowrate of element E in stream S.
C VMFR S ;Molar flowrate of comp components C in stream S.
P VPMT S ;Molar flowrate of phases P in stream S.
E VME1 S ;Molar flowrate of element E in phase 1 SI of stream S.
E VME2 S ;Molar flowrate of element E in phase 2 SO of stream S.
E VME3 S ;Molar flowrate of element E in phase 3 LI of stream S.
E VME4 S ;Molar flowrate of element E in phase 4 LO of stream S.
E VME5 S ;Molar flowrate of element E in phase 5 M1 of stream S.
E VME6 S ;Molar flowrate of element E in phase 6 M2 of stream S.
E VME7 S ;Molar flowrate of element E in phase 7 M3 of stream S.
E VME8 S ;Molar flowrate of element E in phase 8 GC of stream S.
E VWE1 S ;Mass flowrate of element E in phase 1 SI of stream S.
E VWE2 S ;Mass flowrate of element E in phase 2 SO of stream S.
E VWE3 S ;Mass flowrate of element E in phase 3 LI of stream S.
E VWE4 S ;Mass flowrate of element E in phase 4 LO of stream S.
E VWE5 S ;Mass flowrate of element E in phase 5 M1 of stream S.
E VWE6 S ;Mass flowrate of element E in phase 6 M2 of stream S.
E VWE7 S ;Mass flowrate of element E in phase 7 M3 of stream S.
E VWE8 S ;Mass flowrate of element E in phase 8 GC of stream S.

Volumetric Flowrate Value Functions Adjusted for Operating Time

P VCFD S ;Flowrate of phase(s) P in stream S in cubic feet per day.

P VCFM S ;Flowrate of phase(s) P in stream S in cubic feet per minute.
P VSCF S ;Flowrate of phase(s) P in stream S in standard cubic feet per min.
VCMC S ;Flowrate of coal in stream S in cubic meters per hour.
P VCMD S ;Flowrate of phases P in stream S in cubic meters per day.
P VCMH S ;Flowrate of phases P in stream S in cubic meters per hour.
P VCMM S ;Flowrate of phases P in stream S in cubic meters per minute.
P VCMY S ;Flowrate of phases P in stream S in cubic meters per year.
P VNM3 S ;Flowrate of phases P in stream S in normal cubic meters per hour.
VDM3 S ;Flowrate of dry gas in stream S in normal cubic meters per hour.
P VGPD S ;Flowrate of phases P in stream S in U.S. gallons per day.
P VGPM S ;Flowrate of phases P in stream S in U.S. gallons per minute.
P VIGH S ;Flowrate of phases P in stream S in Imperial gallons per hour.
P VIGM S ;Flowrate of phases P in stream S in Imperial gallons per minute.
P VLPD S ;Flowrate of phases P in stream S in liters per day.
P VLPH S ;Flowrate of phases P in stream S in liters per hour.
P VLPM S ;Flowrate of phases P in stream S in liters per minute.
P VLPS S ;Flowrate of phases P in stream S in liters per second.

Elemental Assay Value Functions

E VESI S ;Weight fraction of element E in solid inorganic phase of stream S.

E VESO S ;Weight fraction of element E in solid organic phase of stream S.
E VESA S ;Weight fraction of element E in solid phases of stream S.
E VELI S ;Weight fraction of element E in liquid inorganic phase of stream S.
E VELO S ;Weight fraction of element E in liquid organic phase of stream S.
E VELA S ;Weight fraction of element E in liquid phases of stream S.
E VEM1 S ;Weight fraction of element E in molten metal phase of stream S.
E VEM2 S ;Weight fraction of element E in matte phase of stream S.
E VMAT S ;Weight fraction of element E in matte phase of stream S.
E VEM3 S ;Weight fraction of element E in slag phase of stream S.
E VEGC S ;Weight fraction of element E in gaseous phase of stream S.
E VEWD S ;Weight fraction of element E in dried stream S.
E VEWF S ;Weight fraction of element E in total stream S.
E VOZT1 S ;Assay of element E in solid inorganic phase of stream S in troy ounces/t
E VOZT2 S ;Assay of element E in solid organic phase of stream S in troy ounces/ton
E VOZT3 S ;Assay of element E in liquid inorganic phase of stream S in troy ounces/
E VOZT4 S ;Assay of element E in liquid organic phase of stream S in troy ounces/to
E VOZT5 S ;Assay of element E in melt 1 phase of stream S in troy ounces/ton.
E VOZT6 S ;Assay of element E in melt 2 phase of stream S in troy ounces/ton.
E VOZT7 S ;Assay of element E in melt 3 phase of stream S in troy ounces/ton.
E VOZT8 S ;Assay of element E in gas phase of stream S in troy ounces/ton.
E VEPB S ;Parts per billion of element E in total stream S.
E VEPBa S ;Parts per billion of element E in aqueous in stream S.
E VEPBs S ;Parts per billion of element E in solids in stream S.
E VEPM S ;Parts per million of element E in total stream S.
E VEPMa S ;Parts per million of element E in aqueous in stream S.
E VEPMs S ;Parts per million of element E in solids in stream S.
VECA S C E ;The assay of element E in component C of stream S.

Component Assay Value Functions

C VCWF S ;Weight fraction of components C in stream S.

C VCPA S ;Weight fraction of component C in component C's phase in stream S.
C VCMF S ;Mole fraction of components C in stream S.
C VGPC S ;Volume fraction of component C in gas phase of stream S.
C VDGV S ;Dry gas volume fraction of component C in stream S.
C VISR S ;Iron silica ratio in components C in stream S, default C is SC,M3.
VM3B S ;Basic/acid ratio of slag in stream S.
VSIO S ;Weight fraction of SiO2 in solids and slag in stream S.
VSO2 S ;Weight fraction of SO2 in the gas phase of stream S.
C VGHW S ;Concentration of components C in stream S in grams per 100 grams of wate
C VGTW S ;Concentration of components C in stream S in grams per 1000 grams of wat
C VMKW S ;Concentration of components C in stream S in moles per 1000 moles of wat

Gram Per Liter Value Functions

E VGLE S ;Grams per liter of element E in stream S in total slurry.

E VGLEa S ;Grams per liter of element E in stream S in aqueous only.
E VGLEo S ;Grams per liter of element E in stream S in organic only.
E VGLEao S ;Grams per liter of element E in stream S in aqueous and organic.
E Vgle S ;Grams per liter of element E in stream S in total liquor (at 25C).
E Vglea S ;Grams per liter of element E in stream S in aqueous only (at 25C).
E Vgleo S ;Grams per liter of element E in stream S in organic only (at 25C).
C VGPL S ;Grams per liter of components C in stream S in total liquor.
C VGPLa S ;Grams per liter of components C in stream S in aqueous only.
C VGPLo S ;Grams per liter of components C in stream S in organic only.
C Vgpl S ;Grams per liter of components C in stream S in total liquor (at 25C).
C Vgpla S ;Grams per liter of components C in stream S in aqueous only (at 25C).
C Vgplo S ;Grams per liter of components C in stream S in organic only (at 25C).
VGLS S ;Grams per liter of solids in stream S.
C VFE2 S ;Grams per liter of Fe+2 in components C in stream S.
C Vfe2 S ;Grams per liter of Fe+2 in components C in stream S (at 25C).
C VFE3 S ;Grams per liter of Fe+3 in components C in stream S.
C Vfe3 S ;Grams per liter of Fe+3 in components C in stream S (at 25C).
V2O5 S ;Grams per liter of Vanadium in stream S reported as gpl V2O5.
E VMLE S ;Moles per liter of element E in stream S.
E Vmle S ;Moles per liter of element E in stream S (at 25C).
C VMPL S ;Moles per liter of components C in stream S.
C Vmpl S ;Moles per liter of components C in stream S (at 25C).
 Solid Phase Value Functions

Vgf3 S ;Particulates in gas stream S in grains per standard cubic foot.

VGF3 S ;Particulates in gas stream S in grains per actual cubic foot.
Vgm3 S ;Particulates in gas stream S in grams per normal cubic meter.
VGM3 S ;Particulates in gas stream S in grams per actual cubic meter.
VPCS S ;Weight fraction of solids in stream S.
VVPS S ;Volume fraction of solids in stream S
P VPWF S ;Weight fraction of phases P in stream S.
P VPMF S ;Mole fraction of phases P in stream S.
P VPVF S ;Volume fraction of phases P in stream S.

Particle Size Value Functions

VCPS S ;Average coal particle size in millimeters or inches.

F VMIC S ;Micron size of fraction F passing in stream S.
VP20 S ;Mesh size in microns which passes 20% of the solids in stream S.
VP50 S ;Mesh size in microns which passes 50% of the solids in stream S.
VP80 S ;Mesh size in microns which passes 80% of the solids in stream S.
M VPAS S ;Weight of solids in stream S passing M microns.
M VPPM S ;Weight fraction of solids in stream S passing M microns.
M VCPR S ;Weight fraction of solids in stream S retained on micron size M.
VPCP S ;Weight fraction of solids in stream S passing all mesh sizes.
VPCR S ;Weight fraction of solids in stream S retained on each mesh size.
M VSIZ S ;Weight fraction of solids in stream S passing M microns.

Steam and Air Value Functions

VDEW S ;Dew point of gas phase in stream S in degrees C.

VGAH S ;Absolute humidity of stream S.
VGRH S ;Relative humidity of stream S.
VARH D W ;Relative humidity from dry bulb (D) and wet bulb (W) temperatures in deg
VGDB S ;Dry bulb temperature of stream S in degrees C.
VGWB S ;Wet bulb temperature of stream S in degrees C.
VSTP T ;Saturated steam pressure in kPa at temperature T in ±C.
VSTT P ;Saturated steam temperature in ±C at pressure P in kPa.
VHCT T ;Saturated steam condensate enthalpy at temperature T.
VHCP P ;Saturated steam condensate enthalpy at pressure P.
VHST T ;Saturated steam enthalpy in Btu/lb, kcal/kg, kJ/kg as function of temper
VHSP P ;Saturated steam enthalpy in Btu/lb, kcal/kg, kJ/kg as function of pressu
VDSS S ;Degrees of superheat of steam in stream S in degrees C.
P VESS T ;Enthalpy in BTU/lb and Kcal/kg mole of superheated steam at pressure P i
and temperature T in ±F relative to 25±C.
P VMSS T ;Enthalpy in BTU/lb and Kcal/kg mole of superheated steam at pressure P i
and temperature T in ±C relative to 25±C.
P Vesse T ;Enthalpy in BTU/lb of superheated steam at pressure P in psi
and temperature T in ±F relative to 25±C.
P VESSE T ;Enthalpy in BTU/lb of superheated steam at pressure P in psi
and temperature T in ±F relative to 0±C.
P Vessm T ;Enthalpy in Kcal/kg of superheated steam at pressure P in kPa
and temperature T in ±C relative to 25±C.
P VESSM T ;Enthalpy in Kcal/kg of superheated steam at pressure P in kPa
and temperature T in ±C relative to 0±C.
VSTMTABE S ;Enthalpy of steam in stream S in BTU/lb.
VSTMTABM S ;Enthalpy of steam in stream S in kJ/kg.

Miscellaneous Value Functions

VEPH S ;Estimated pH of stream S. Requires EPH factors in ICOM.

E VEXT S2 ;Extraction of element E from solids between streams S[1] and S[2].
VVIL S ;Estimated viscosity of liquid in stream S, no solids correction.
VVIS S ;Estimated viscosity of a slurry streams S.
W VWAS S ;Wash ratio of liquor in stream W to solids in stream S.
VAHP H ;Available motor horsepower equal to or larger than H.
VTHP ;Calculates the total installed horsepower for the entire flowsheet.
 VTKW ;Calculates the total kilowatt power draw for the entire flowsheet.

Heat Content Value Functions (experimental)

VBTU S ;Estimated BTU value for coal stream S.

VBPP S ;Value of heat content of stream S in Btu/pound.
VSHC S ;Heat content of stream S in kcal/hour.
C VCHC S ;Heat content of components C in stream S in kilocalories/hour.
T VSCP S ;Heat capacity Cp of stream S at temperature T, in kilocalories/kilogram/
C VCCP S ;Cp of components C in stream S at current stream temperature kcal/kg/±C

Chemical Reaction Value Functions

U VHTR R ;Heat of reaction in kcal/hr for reaction R in unit operation U.

Note: U and R references are 'not' updated with changes.

Special Value Functions

E VEQN X ;Value of equation number E solved with parameters X. (experimental)

VSET X ;Execute expression X to set flowrate. Format: VSET 'VLPS s10=123'
VCTL N ;Value of output variable from Controller N.
VAID N ;Value of output variable from analog input device N.
VAOD N ;Value of output variable from analog output device N.
VDID N ;Value of output variable from digital input device N.
VDOD N ;Value of output variable from digital output device N.
V VFLS U ;Returns value of variable V from unit operation U. Format: 'RM' VFLS u10
VHRD S ;Value of water hardness of stream S in ppm calcium carbonate.
VLAB S ;Returns the short label for stream S.
VSNM S ;Returns the long label for stream S.
VTMP S ;Returns the control temperature for stream S in degrees C.
VAPK S ;Surface area in M3/kilogram of solids in stream S.
VBVP S ;Estimated vapor pressure of brine in streams S.
VLOI S ;Loss on ignition of stream S.

Heap Leach Value Functions

1 VHLG ib ;Returns list of blocks with same block identification as block ib

2 VHLG ib ;Returns list of blocks in column containing block ib
3 VHLG ib ;Returns list of blocks in cell containing block ib
4 VHLG ib ;Returns list of blocks in column of cell containing block ib
5 VHLG ib ;Returns list of blocks in level containing block ib
6 VHLG ib ;Returns list of blocks in column of level containing block ib
7 VHLG ib ;Returns list of blocks in heap containing block ib

VHEP B ;Places data from HEP into STR in an unused stream number and returns
the stream number, used in conjunction with other value functions.
e.g. C VGPL VHEP 3 VHLG ib
Returns the grams per liter of component C in all of the blocks
in the cell containing block ib

VHEP0 B ;Places data from HEP0 into STR in an unused stream number and returns
the stream number, used in conjunction with other value functions.