💧
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?

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

Choose Phases

The "Phases" field is utilized to select the phases expected to form in the system. This field is an array of strings and must include the "aqueous (liquid1)" phase at a minimum. It is required for chemistry file generation, and the selected phases impact the chemistry model.

Below is an example of the "Phases" field:

{
    "params": {
    "thermodynamicFramework": "Aqueous (H+ ion)", 
    "modelName": "testModel",
      "phases": [
        "liquid1",
        "vapor",
        "solid", 
        "liquid2"
      ],
        "inflows": [
            {
                "name": "H2O"
            },
            {
                "name": "NACL"
            }
        ]
    }
}
phase
value

aqueous

liquid1

vapor

vapor

solid

solid

organic

liquid2

Here are the requirements and assumptions you need to be aware of:

  1. For DBS file generation, the "phases" field must be explicitly entered by the user and cannot be left empty (e.g., "phases":[] is incorrect).

  2. The aqueous phase or "liquid1" phase should always be specified (e.g., "phases": ["vapor", "solid"] is incorrect).

  3. The order or sequence of phase names does not matter.

  4. Duplicate phase names are not allowed (e.g., "phases": ["liquid1", "liquid1", "vapor", "solid"] is incorrect).

  5. In the Aqueous and MSE-SRK models, the vapor phase is required to model the organic phase. Thus, the vapor phase will be automatically selected by default if the organic phase is enabled.

  6. In query methods, if a user doesn't specify any phases explicitly, "liquid1" or aqueous phase, "vapor", and "solid" will be enabled by default. The "liquid2" or organic phase is not included.

PreviousInclude PseudocomponentNextSpecify Model Name

Last updated 11 months ago

Was this helpful?