💧
OLI API
  • Welcome to the OLI API documentation
  • Basic workflow
  • Authentication
    • Bearer Token
    • API Keys
      • Generate a Key
      • List All Keys
      • Delete a Key
  • Generating chemistry model files
    • ChemBuilder API
      • Getting Started with ChemBuilder
        • Set Thermodynamic Framework
        • Include Private Databanks
        • Include Inflows
          • Include Assays
          • Include Pseudocomponent
        • Choose Phases
        • Specify Model Name
        • Choose Redox
        • Choose Solids
        • Add Kinetics
      • ChemBuilder Query
        • Species Query
        • Redox Query
        • Solid Phase Query
        • Databank Query
        • Kinetics Query
        • Query Output Results
      • Supporting Information for ChemBuilder
        • Add Comment
        • "enabled" Keyword
        • ChemBuilder Errors
    • Chemistry Wizard
  • Uploading chemistry model files
  • Get list of uploaded files
  • Quickstart example: Python
  • Known issues and Limitations
  • OLI ENGINE API
    • Main methods
      • API call blueprint
      • Chemistry information
      • Isothermal flash
      • Isenthalpic flash
      • Bubble point flash
      • Dew point flash
      • Vapor amount flash
      • Vapor fraction flash
      • Isochoric flash
      • set pH flash
      • Precipitation point flash
      • Autoclave
      • Custom flash
      • Corrosion contact surfaces
      • Corrosion rates
      • Water analysis
  • Additional methods
    • Flash history - Chemistry model
    • Result - by jobId
    • delete file
    • cancel run
  • Inflows input
  • Optional inputs
  • Kinetic calculation inputs
  • Kinetic calculation outputs
  • Input units
  • User defined output unit set
  • Survey calculation
  • Stream output
  • Error/Warning output
  • Definition of terms
  • OLI Process API
    • Uploading a Process API package
      • Creating a Process API package
    • Get list of all uploaded ProcessAPI packages
    • Get input specs for Process API package
    • Get output specs for ProcessAPI package
    • Run a Process API calculation
    • Get calculation status and results
  • Deleting a process package
  • Undelete a process package
  • Process API input specification
    • "data" object
      • "flowsheet" object
        • "chemical-info" object
        • "general-info" object
        • "properties" object
        • "units_set_info" object
  • OLI ScaleChem API
    • Uploading chemistry model files for ScaleChem API
    • Get list of uploaded ScaleChem model files
    • Main methods
      • Brine analysis
      • Gas analysis
      • Oil analysis
      • Mixer calculation
      • Scale scenario
Powered by GitBook
On this page

Was this helpful?

User defined output unit set

PreviousInput unitsNextSurvey calculation

Last updated 2 years ago

Was this helpful?

For all the flash computations, the user can optionally specify the unit of each output value in the in the params.unitSetInfo section. The table below describes the supported output units.

params.unitSetInfo

definition

default unit

units available

liq1_phs_comp

liquid 1 phase composition

mol

see composition units below

solid_phs_comp

solid phase composition output

mol

see composition units below

vapor_phs_comp

vapor phase composition output

mol

see composition units below

liq2_phs_comp

liquid 2 phase composition output

mol

see composition units below

combined_phs_comp

total composition output

mol

see composition units below

density

density of a phase/total stream

g/L

g/ml, kg/m3, g/L, kg/L, lb/ft3, lb/gal

mass

mass of a phase/total stream

g

g, kg, lb, mg, (g/100), metric ton

vol

volume of a phase/total stream

L

L, ml, cm3, m3, E3m3, E6m3, ft3, Mft3, MMft3, gal, MMgal, bbl

moles

total moles in a phase/stream

mol

mol, kgmol, lbmol, mmol, μmol, (mol/100)

pt

pressure of stream

atm

atm, bar, barg, mbar, Pa, kPa, MPa, mmHg, Torr, inHg, psia, psig, inH2O, kg/cm2

t

temperature of stream

°C

K, degree_Fahrenheit, °C, °F, degree_Celsius, R

enthalpy

enthalpy of a phase/stream

cal

cal, E3cal, E6cal, J, kJ, MJ, Btu, MMBtu

visabs

Absolute viscosity

cP

cP, Poise, Pa-s

i

Ionic strength, x-based

mol/mol

mol/mol

im

Ionic strength, m-based

mol/kg

mol/kg

econd

Specific electric conductivity

µmho/cm

mho/m, mho/cm, µmho/m, µmho/cm

econdm

Molar electric conductivity

m2/ohm-mol

m2/ohm-mol, cm2/ohm-mol

fug

Fugacity

atm

atm, bar, barg, mbar, Pa, kPa, MPa, mmHg, Torr, inHg, psia, psig, inH2O, kg/cm2

mob

Mobilities

cm2/s-volt

cm2/s-volt, m2/s-volt

dif

Self diffusivity

m2/s

m2/s

alkalinity

Alkalinity

mg HCO3/L

eq/L, meq/L, mg HCO3/L, mg CO3/L, mol HCO3/L, mol CO3/L, mg CaCO3/L, mol CaCO3/L

tds

Total dissolved solids

mg/L

mg/L

cp

Heat capacity

cal/g K

J/kg K, J/g K, cal/g K, Btu/lb R

entr

Entropy

cal/K

J/K, cal/K, Btu/R

thermalcond

Thermal conductivity

cal/hr m °C

Btu/hr ft °F, cal/hr m °C, cal/s m °C, J/s m K

surface_tension

Surface tension

N/m

N/m, dyne/cm

mol_entr

Molar entropy

cal/mol K

J/mol K, cal/mol K, Btu/mol R

interfacial_tension

Interfacial tension

N/m

N/m, dyne/cm

kinetics_k

K value of kinetic reaction

mol/hr m3

mol/hr m3

kinetics_rate

Kinetic reaction rate

mol/hr hr

mol/hr hr

kinetics_extent

Kinetic reaction extent

mol/hr

mol/hr

hardness

Hardness

mg/L of Mg+2 and Ca+2

mg/L of Mg+2 and Ca+2

tic

Total inorganic carbon

mol C/L

mg C/L, g C/L, mol C/L

energy

Gibbs free energy

cal

cal, E3cal, E6cal, J, kJ, MJ, Btu, MMBtu

mol_energy

Molar Gibbs free energy

cal/mol

cal/mol, E3cal/mol, E6cal/mol, J/mol, kJ/mol, MJ/mol, Btu/mol, MMBtu/mol

part_pressure

Partial pressure

atm

atm, bar, barg, mbar, Pa, kPa, MPa, mmHg, Torr, inHg, psia, psig, inH2O, kg/cm2

molefrac

Mole fraction

mol/mol

mol/mol, mole %, ppm (mole)

induction_time

scaling induction time

hr

s, min, hr, day, yr

All unit entries do not have to be specified. The ones that are not will be overridden by the default.

Composition units

unit types

units

moles

mol, kgmol, lbmol, mmol, µmol, (mol/100)

mole fraction

mol/mol, mole %, ppm (mole)

mass

g, kg, lb, mg, (g/100), metric ton

mass fraction

g/g, mass %, ppm (mass)

composition units can be specified as any units above

JSON input (example)

{
    "params": {
        ...<snip>...
        "unitSetInfo": {
            "liq1_phs_comp": "mol/mol",
            "solid_phs_comp": "mol/mol",
            "vapor_phs_comp": "mol/mol",
            "liq2_phs_comp": "mol/mol",
            "combined_phs_comp": "mol/mol",
            "density": "kg/m3",
            "mass": "g",
            "vol": "L",
            "moles": "mol",
            "pt": "atm",
            "t": "°C",
            "enthalpy": "J",
            "visabs": "cP",
            "i": "mol/mol",
            "im" "mol/kg",
            "econd": "µmho/cm",
            "econdm": "m2/ohm-mol",
            "fug": "atm",
            "mob": "m2/s-volt",
            "dif": "m2/s",
            "alkalinity": "mg HCO3/L",
            "tds": "mg/L",
            "current_den": "A/sq-m",
            "molefrac": "mole %",
            "cp": "cal/g K",
            "entr": "cal/K hr",
            "thermalcond": "cal/hr m °C",
            "surface_tension": "N/m",
            "part_pressure": "atm",
            "mol_entr": "cal/mol K",
            "interfacial_tension": "N/m",
            "kinetics_k": "mol/hr m3",
            "kinetics_rate": "mol/hr hr",
            "kinetics_extent": "mol",
            "hardness": "mg/L of Mg+2 and Ca+2",
            "tic": "mol C/L"
        }
}

Explanation of each property and available units will be documented later.

Below is an input sample containing the params.unitSetInfo optional object using function input as an example.

Stream output
isothermal flash