# MultiSplitLink Node

## General Description

The **MultiSplitLink node** is an extension of [PiecewiseLink](https://app.gitbook.com/o/tUkZkKm5QY0V6IeofRg4/s/ODCd8VK2OOl9jOdp5KFf/~/changes/91/modelling-fundamentals/node-types/water-transport/piecewiselink-node) that includes additional slots to connect from.

Conceptually this node looks like the following internally,

```
         / -->-- X0 -->-- \
A -->-- Xo -->-- X1 -->-- Xi -->-- C
         \ -->-- X2 -->-- /
                 |
                 Bo -->-- Bi --> D
```

An additional sublink in the PiecewiseLink (i.e. X2 above) and nodes (i.e. Bo and Bi) in this class are added for each extra slot.

Finally a mechanism is provided to (optionally) fix the ratio between the last non-split sublink (i.e. X1) and each of the extra sublinks (i.e. X2). This mechanism uses *AggregatedNode* internally. [API Reference](https://pywr.github.io/pywr-docs/master/api/generated/pywr.nodes.MultiSplitLink.html).

Notes: Users must be careful when using the factor mechanism. Factors use the last non-split sublink (i.e. X1 but not X0). If this link is constrained with a maximum or minimum flow, or if it there is another unconstrained link (i.e. if X0 is unconstrained) then ratios across this whole node may not be enforced as expected.

## Primary Attributes

<table><thead><tr><th width="180.33333333333331">Name</th><th width="318">Description</th><th>Required</th></tr></thead><tbody><tr><td>allocation penalty</td><td>The cost per unit flow via the node</td><td>Optional</td></tr><tr><td>max_flow</td><td>The maximum flow constraint on the node</td><td>Optional</td></tr><tr><td>extra_slots</td><td>Number of additional slots (and sublinks) to provide. Must be greater than zero.</td><td>Optional</td></tr><tr><td>slot_names</td><td>The names by which to refer to the slots during connection to other nodes. Length must be one more than the number of extra_slots. The first item refers to the PiecewiseLink connection with the following items for each extra slot.</td><td>Optional</td></tr><tr><td>factors</td><td>If given, the length must be equal to one more than the number of extra_slots. Each item is the proportion of total flow to pass through the additional sublinks. If no factor is required for a particular sublink then use <em>None</em> for its items. Factors are normalised prior to use in the solver.</td><td>Optional</td></tr></tbody></table>

## Examples

coming soon...


---

# Agent Instructions: 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:

```
GET https://water-strategy.gitbook.io/waterstrategy/modeling-basics/node-types/water-transport/multisplitlink-node.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.