💧
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
  • Optional Properties
  • A few key points to remember are:

Was this helpful?

  1. Generating chemistry model files
  2. ChemBuilder API
  3. Getting Started with ChemBuilder
  4. Include Inflows

Include Pseudocomponent

Individual pseudocomponents with specific properties can be added to the inflow if distillation data is unavailable. The "type" must be set as "pseudo" to add a pseudocomponent JSON object. Users can customize the pseudocomponent name using the "name" field.

Below is a sample input to add a pseudocomponent to the inflow:

{ 
	"inflows": [
	{
	     "name": "H2O"
	}, 
    	{
            "name": "PSEUDOAA",
            "type": "pseudo",
            "enabled": true,
            "data": {
		"thermodynamicMethod": "API-8",
		"normalBoilingPoint": {
			"unit": "°C",
			"value": 69.0,
			"enabled": true
		},
		"specificGravity": {
			"value": 1.2,
			"enabled": false
		},
		"molecularWeight": {
			"value": 86.0,
			"enabled": true
		},
		"criticalTemperature": { 
			"value": 379,
			"unit": "°C",
			"enabled": true
		},  
		"criticalPressure": { 
			"unit": "atm",
			"value": 217,
			"enabled": true
		}, 
		"criticalVolume": { 
			"unit": "L", 
			"value": 0.057,
			"enabled": true
		}, 
		"acentric": { 
			"value": 0.34,
			"enabled": true
		}
		}
	    } 
	]	
} 
Pseudocomponent
required
type
description

name

String

A name provided by the user for this input assay.

type

String

This field is used to identify the type of inflow. Allowed values include "assay" or "pseudo".

data

JSON Object

Contains the user-defined input for an assay.

Optional Properties

data
required
type

thermodynamicMethod

String

normalBoilingPoint

JSON Object

specificGravity

JSON Object

molecularWeight

JSON Object

criticalTemperature

JSON Object

criticalPressure

JSON Object

criticalVolume

JSON Object

accentric

JSON Object

A few key points to remember are:

The "type" must be specified as either "assay" or "pseudo". Otherwise, the species is treated as a regular inflow species.

The supported thermodynamic methods are API-8, API-5, Cavett, and Kessler.

A minimum of 2 of the folllowing properties "normalBoilingPoint", "specificGravity", and "molecularWeight" are required.

All supercritical properties are optional and can be disabled.

The pseudo object and its associated input JSON object can be enabled or disabled using "enabled" Keyword

PreviousInclude AssaysNextChoose Phases

Last updated 10 months ago

Was this helpful?

✔️
✔️
✔️
❌
❌
❌
❌
❌
❌
❌
❌