Precipitation point flash

This function calculates the equilibrium solution at the precipitation point of a specified solid species by varying one inflow species.

precipitation point

POST https://api.olisystems.com/engine/flash/{dbs_file_id}/precipitation-point

determine the minimum amount of an inflow species required to precipitate a solid

Headers

Name	Type	Description
Authorization	string	Bearer {access_token}
Content-Type	string	application/json

200 Please look at "API call blueprint" page on how to obtain results

{
	"code": 200,
	"data": {
		"file_id": "dee854a6-59db-487d-ad08-a20dee691133",
		"jobId": "f6b3375e-cd0f-4ace-a5ee-71e047b76754",
		"resultsLink": "https://devapi.olisystems.com/result/flash/f6b3375e-cd0f-4ace-a5ee-71e047b76754?context=engine",
		"status": "IN PROGRESS"
	},
	"message": "Process execution started Successfully",
	"status": "SUCCESS"
}

Request payload

{
    "params": {
        "temperature": {
            "value": 30.0,
            "unit": "°C"
        },
        "pressure": {
            "value": 1.5,
            "unit": "atm"
        },
        "solidToPrecipitate": "NACLPPT",
        "inflowToAdjust": "NACL",
        "inflows": {
            "unit": "mol",
            "values": {
                "H2O": 50.0,
                "CO2": 10.0,
                "NACL": 0.0,
                "BENZENE": 10.0
            }
        }
    }
}

params	type	description
temperature	valueObject	specified or initial guess temperature with unit
pressure	valueObject	specified or initial guess pressure with unit
solidToPrecipitate	string	specified solid species at precipitation point
inflowToAdjust	string	inflow species whose amount is to be adjusted to achieve precipitation point condition

params.solidToPrecipitate and params.inflowToAdjust are species and inflow names retrieved from the chemistry information call, under result.species(trueName) and result.inflows(baseName) respectively.

in addition to the inputs shown above some optional properties may also be specified. They can be viewed here

Response (status = PROCESSED)

{
    "code": 200,
    "data": {
        "result": {
           "calculatedVariables": [
                {
                    "name": "NACL",
                    "type": "inflow",
                    "unit": "mol",
                    "value": 5.531398835682553
                }
            ],
            ...<snip>...
        }
    }, 
    "message": "Results returned successfully", 
    "status": "PROCESSED"
}

The output of this calculation is the stream output which is common result output for all OLI's flash calculations or an error. In addition to this output the result also contains the amount of the added inflow (params.inflowToAdjust) can be conveniently retrieved from the data.result.calculatedVariables array

data.result.calculatedVariables [ { } ]	type	description
type	string	type of calculated variable, i.e. inflow amount for "inflow"
name	string	name of adjusted inflow species
value	number	the final amount of adjusted inflow
unit	string	unit of inflow amount

Survey Calculation

Survey calculation is supported for the variables below. Please refer to Survey calculation for explained input schema.

supported params.surveyInputs[{}].field
"/params/temperature/value"
"/params/pressure/value"