Chemistry information
Last updated
Last updated
This function is used to obtain useful chemistry information that is based on the chemistry model file chosen. The output of this function can be for the most part used to determine the inflows required to craft the input for other OLI calculations.
GET
https://api.olisystems.com/engine/file/{dbs_file_id}/chemistry-info
get information on the inflows, species and thermodynamic framework for a given chemistry model
Name | Type | Description |
---|---|---|
There may be more inflows generated here than that was specified during the chemistry model generation stage. These extra inflows are called "related inflows", as they are the other possible inflows that can be formed from the combination of individual material species that formed the original inflows.
The response contains two main keys i.e. the result.inflows and result.species. Both are array type objects. Their values are described below
if a species exists in "aqeuous" phase, this means it can be present in liquid1 and/or liquid2 phases
OLI's species naming scheme internally attaches a suffix at the end of species name to indicate the type of species.
The only exception is H2O species, it does not have a suffix and is understood to be in the aqueous phase and/or the second liquid phase.
Authorization
string
Bearer {access_token}
data.result.inflows[ { } ]
type
description
baseName
string
name of inflow
mw
number
molecular weight
data.result.species[ { } ]
type
value
baseName
string
species name
trueName
string
name of species with suffix
mw
number
molecular weight
charge
number
species charge
phase
string
phase in which species exists
suffix
species type
possible phases
AQ
molecular (neutral)
liquid1, liquid2
ION
ionic (charged)
liquid1, liquid2
PPT
precipitate
solid
.nH2O
hydrate
solid
SOL
surface species
surface
CPI
surface ionic species
surface
CPM
surface neutral species
surface