> For the complete documentation index, see [llms.txt](https://devdocs.olisystems.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://devdocs.olisystems.com/oli-scalechem-api/main-methods/scale-scenario.md).

# Scale scenario

### Request payload

```json
{
    "method": "scalechem.mixerCalculation",
    "params": {
        "name": "mixer",
        "chemistryModel": "mixerChemistry",
        "externalStreams": [...<snip>...],
        "inletInputs": [...<snip>...],
        "scenarios": [...<snip>...]
    }
}
```

| **params**      | type             | description                                                                                                           |
| --------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------- |
| name            | string           | name of output stream                                                                                                 |
| chemistryModel  | string           | [chemistry model file (dbs) name](/oli-scalechem-api/main-methods.md#chemistry-model) for scale scenario calculations |
| externalStreams | array of objects | [inputs for external streams](#external-streams)                                                                      |
| inletInputs     | array of objects | [flow rate specifications for mixer inlet streams](#undefined)                                                        |
| scenarios       | array of objects | [scale scenario specification](#undefined)                                                                            |

After combining all inlet streams, this calculation performs a series of calculations in the locations specified as below, where the outlet of each location is passed as the inlet to the next location.

### Scale scenario inputs

```json
{
    "method": "scalechem.mixerCalculation",
    "params": {
        ...<snip>...,
        "scenarios": [
        {
            "location": "Stock tank",
            "temperature": {
                "unit": "°C",
                "value": 20
            },
            "pressure": {
                "unit": "bar",
                "value": 2
            }
        },
        {
            "location": "Stock tank",
            "temperature": {
                "unit": "°C",
                "value": 15
            },
            "pressure": {
                "unit": "bar",
                "value": 1.5
            },
            "dropSolids": true
        },
        ...<snip>...
        ]
    }
}
```

|                           |                                     |                                                                                                                                |
| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| **params.scenarios\[{}]** | type                                | description                                                                                                                    |
| location                  | string                              | location name                                                                                                                  |
| temperature               | [valueObject](/terms-definition.md) | specified temperature with [unit](/input-unit-set.md)                                                                          |
| pressure                  | [valueObject](/terms-definition.md) | specified pressure with [unit](/input-unit-set.md)                                                                             |
| dropSolids                | boolean                             | optional. If specified as true, all solids in the outlet are removed when passing as inlet to next location. Default is false. |

### Additional input

{% hint style="info" %}
In addition to the inputs shown above, some optional properties may also be specified. They can be viewed [here](/optional-inputs.md).
{% endhint %}

### Response (status = PROCESSED)

```json
{
    "code": 200,
    "result": {
       "external stream 1": {...<snip>...},
       "external stream 2": {...<snip>...},
       ...<snip>...,
       "scenarioOutputs": [
       {
          "location": "Stock tank", 
          "result": {...<snip>...}
       },
       ...<snip>...
       ]
    },
    "message": "Results returned successfully", 
    "status": "PROCESSED"
}
```

The "result" contains all [stream outputs ](/stream-output-json.md)for each external stream. Results of each location are listed as an array of objects in **result.scenarioOutputs**, with location and result of corresponding [stream output](/stream-output-json.md).

by their names specified in the input.

### Survey Calculation

Survey calculation is supported for the variables below. Please refer to [Survey calculation](/survey-calculation.md) for explained input schema.

| supported **params.surveyInputs\[{}].field**                                                                                        |
| ----------------------------------------------------------------------------------------------------------------------------------- |
| "/params/temperature/value"                                                                                                         |
| "/params/pressure/value"                                                                                                            |
| "/params/inletInputs/***i***/totalAmount/value" where ***i*** is the index (0 based) of the **params.inletInputs** array of objects |
| "/params/scenarios/***i***/temperature/value" where ***i*** is the index (0 based) of the **params.scenarios** array of objects     |
| "/params/scenarios/***i***/pressure/value" where ***i*** is the index (0 based) of the **params.scenarios** array of objects        |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://devdocs.olisystems.com/oli-scalechem-api/main-methods/scale-scenario.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.