Include Assays

To include assays in the inflow, users must define additional JSON objects containing "type": "assay". Users can provide a custom name for the assay "name" field.

Below is a sample input to add an assay to the inflow:

{       
         "inflows": [
            {
                "name": "H2O"
            },
            {
                "name": "test",
                "type": "assay",
                "data": {
                    "assayDataType": "ASTM D1160",
                    "thermoMethod": "API-8",
                    "assayBulkDensity": {
                        "type": "Specific Gravity",
                        "value": 0.769
                    },
                    "distillationCurveCuts": 7,
                    "distillationData": {
                        "temperatureUnit" : "°C",
                        "data": [
                        {
                            "volumePercentDistilled": 5,
                            "temperature": 68.7
                        },
                        {
                            "volumePercentDistilled": 10,
                            "temperature": 105.7
                        },
                        {
                            "volumePercentDistilled": 20,
                            "temperature": 171.9
                        },
                        {
                            "volumePercentDistilled": 30,
                            "temperature": 235.8
                        },
                        {
                            "volumePercentDistilled": 40,
                            "temperature": 295
                        },
                        {
                            "volumePercentDistilled": 50,
                            "temperature": 350.3
                        },
                        {
                            "volumePercentDistilled": 60,
                            "temperature": 405.3
                        },
                        {
                            "volumePercentDistilled": 70,
                            "temperature": 462.5
                        }
                    ]
                }
            }
        }
    ] 
 }   
    

The assay object consists of three keys: "name", "type", and "data".

assay	required	type	description
name	✔️	String	A name provided by the user for this input assay.
type	✔️	String	This field is used to specify the type of inflow (e.g., "assay" or "pseudo").
data	✔️	JSON Object	This field contains the user-defined input for an assay.

The "data" section has the following keys:

data	required	type
assayDataType	✔️	String
thermoMethod	✔️	String
assayBulkDensity	✔️	JSON Object
distillationCurveCuts	✔️	Integer
distillationData	✔️	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 include API-8, API-5, Cavett, and Kessler.

The supported density types include Specific Gravity, API Gravity, and Watson K.

The supported thermo methods areASTM D1160, ASTM D86, ASTM D2887, and

TBP Curve.

The number of distillation data points must be greater than 4.

The maximum temperature allowed is 923.15 K.

The distillation data for temperature and volume percent must be entered by the user in ascending order.

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