> For the complete documentation index, see [llms.txt](https://www.opal-rt.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.opal-rt.com/docs/hypersim/library-blocks-reference/network-transformers/2-winding-3-phase-series-saturable-transformer.md).

# 2 Winding 3 Phase Series Saturable Transformer

## Description

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-905f72937a4c2ce4264b5591528e3ca0e11c4867%2Fimage%20(1165).png?alt=media" alt=""><figcaption></figcaption></figure>

The **2-Winding 3-Phase Series Saturable Transformer** block, located in the **Network Transformers** library, models a series transformer with core saturation and optional hysteresis. Series transformers are similar to other 3‑phase transformers but, due to their series connection, are typically used in devices such as DVR, active filters, and UPFC. Adding saturation and hysteresis increases computation time compared to a linear transformer.

Saturation is a characteristic of the core (the winding), not the 3‑phase connection type (Y, Delta, or Zigzag). It is modeled on the magnetization branch using line segments.

The main hysteresis cycle is characterized by four parameters and is measured in DC to exclude Foucault losses, which are represented by the parallel resistance (Rm). The initial trajectory is characterized by the initial flux only. Two special parameters limit the creation of minor nested loops to reduce memory usage; loops that are too small are ignored and modeled by a straight line segment.

The number of saved internal loops is limited to 100 (sufficient in most simulated cases). Above this cycle (limited to ±Is), the model enters the saturation zone. Saturation is characterized either by a series of curve points or by an inductance approached asymptotically. In the latter case, the model automatically generates equal-length segments (Is) in positive and negative saturation zones.

## Mask parameters

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-85a551b91c127ddd74eeda7cae82a603a3ffcee1%2FSST2.jpg?alt=media" alt=""><figcaption></figcaption></figure>

{% tabs %}
{% tab title="General" %}

<table><thead><tr><th width="220">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Description</strong></td><td>Use this field to add information about the component.</td></tr><tr><td><strong>Flux current model</strong></td><td>Select saturation only or saturation with hysteresis.</td></tr><tr><td><strong>Iteration in saturation model</strong></td><td>Enable iteration to improve accuracy when the saturation segment changes; increases computation time.</td></tr><tr><td><strong>Base primary/secondary winding voltage (rmsLL)</strong></td><td>Base value for PU conversion (kV). Voltage expressed in kV rms LL. This base and the nominal voltage change if the corresponding winding connection switches between delta and Y.</td></tr><tr><td><strong>Base power (total)</strong></td><td>Base value for PU conversion (MVA).</td></tr><tr><td><strong>Base frequency</strong></td><td>Base value for PU conversion (Hz).</td></tr><tr><td><strong>Rm</strong></td><td>Equivalent resistance of iron losses of the magnetic circuit (Ω).</td></tr><tr><td><strong>Secondary connection</strong></td><td><p>Winding type:</p><ul><li><strong>Y ground</strong>: Grounded Y connection (can use the internal neutral impedance specified in the other tab)</li><li><strong>Y floating</strong>: Floating Y connection</li><li><strong>Y neutral</strong>: Y connection with impedance connected at the input pin N1 or N2</li><li><strong>Delta lead</strong>: Delta connection with lead of 30°</li><li><strong>Delta ground</strong>: Grounded delta connection (Phase C is grounded)</li><li><strong>Delta lag</strong>: Delta connection with lag of 30°</li></ul></td></tr><tr><td><strong>Voltage (rmsLL)</strong></td><td>Rated voltage of the winding (kV). For both Y and delta connections: voltage expressed in kV rms LL.</td></tr><tr><td><strong>R1, R2</strong></td><td>Leakage resistance of each winding (Ω).</td></tr><tr><td><strong>L1, L2</strong></td><td>Leakage inductance of each winding (H).</td></tr></tbody></table>
{% endtab %}

{% tab title="Neutral impedance " %}

<table><thead><tr><th width="203">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>R2</strong></td><td>Neutral resistance of the secondary winding; applies only to Y ground (Ω).</td></tr><tr><td><strong>L2</strong></td><td>Neutral inductance of the secondary winding; applies only to Y ground (H).</td></tr><tr><td><strong>C2</strong></td><td>Neutral capacitance of the secondary winding; applies only to Y ground (F).</td></tr></tbody></table>
{% endtab %}

{% tab title="Saturation " %}

<table><thead><tr><th width="210">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Number of data points</strong></td><td>Number of segments of the current–flux saturation curve. Specify only the positive part; the negative part is completed by symmetry.</td></tr><tr><td><strong>Saturation current</strong></td><td>Current for each segment of the saturation curve; the origin (0, 0) is implied (A).</td></tr><tr><td><strong>Saturation flux</strong></td><td>Flux for each segment of the saturation curve; the origin (0.0, 0.0) is implied (V·s).</td></tr></tbody></table>
{% endtab %}

{% tab title="Hysteresis" %}

| Parameter                   | Description                                                                                                                                                                                                                                                   |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Saturation data type**    | Determines if the saturation curve is calculated by the model or defined by a series of segments (Equation, Curve).                                                                                                                                           |
| **Air core inductance**     | Value of the saturation inductance that the curve approaches asymptotically (H).                                                                                                                                                                              |
| **Slope at Ic**             | Flux slope at coercive current (H).                                                                                                                                                                                                                           |
| **Coercitive current - Ic** | Positive coercive current at null flux (A).                                                                                                                                                                                                                   |
| **Saturation current - Is** | Current value of the first point in the saturation zone (A).                                                                                                                                                                                                  |
| **Current tolerance**       | Limits generation of minor nested loops. When the magnetizing current values at the last and preceding inversion points are closer than the specified tolerance (in % of Ic), displacement is assumed on a trajectory represented by a straight line segment. |
| **Remanent flux - Φr**      | Positive remanent flux at null current (V·s).                                                                                                                                                                                                                 |
| **Saturation flux - Φs**    | Flux value of the first point in the saturation zone (V·s).                                                                                                                                                                                                   |
| **Flux tolerance**          | Limits generation of minor nested loops. When the flux values at the last and preceding inversion points are closer than the specified tolerance (in % of Φs), displacement is assumed on the current loop.                                                   |
| **Initial flux (peak)**     | Initial flux determining the initial trajectory, calculated assuming an inversion point on the main cycle (V·s).                                                                                                                                              |
| **Number of points**        | Number of segments of the current–flux saturation curve. Specify only the positive part; the negative part is completed by symmetry.                                                                                                                          |
| **Saturation current**      | Current for each segment of the saturation curve; the first value must be equal to Is (A).                                                                                                                                                                    |
| **Saturation flux**         | Flux for each segment of the saturation curve; the first value must be equal to Φs (V·s).                                                                                                                                                                     |
| {% endtab %}                |                                                                                                                                                                                                                                                               |
| {% endtabs %}               |                                                                                                                                                                                                                                                               |

## Conserving ports

<table><thead><tr><th width="200">Port</th><th>Description</th></tr></thead><tbody><tr><td><strong>Net_1</strong></td><td>Primary winding connection (supports only 3-phase connections).</td></tr><tr><td><strong>Net_2</strong></td><td>Secondary winding connection (supports only 3-phase connections).</td></tr><tr><td><strong>Net_N1</strong></td><td>Neutral connection for the primary winding (supports only 1-phase connections).</td></tr><tr><td><strong>Net_N2</strong></td><td>Neutral connection for the secondary winding (supports only 1-phase connections).</td></tr></tbody></table>

## Inputs

This block has no inputs.

## Outputs

This block has no outputs.

## Signals available for monitoring and external I/O connections (via sensors form)

All block inputs and outputs are available as signals for monitoring and for external I/O connections.

Additional signals are also available and are listed below with their descriptions.

<table><thead><tr><th width="220">Signal</th><th>Description</th></tr></thead><tbody><tr><td><strong>FLUX(a,b,c)</strong></td><td>Magnetization flux for each phase (V·s).</td></tr><tr><td><strong>ILMAG(a,b,c)</strong></td><td>Magnetization current for each phase (A)</td></tr><tr><td><strong>IPRIM(a,b,c)</strong></td><td>Primary current for each phase (A)</td></tr><tr><td><strong>ISEC2(a,b,c)</strong></td><td>Secondary current (A)</td></tr><tr><td><strong>ISEC3(a,b,c)</strong></td><td>Tertiary current for each phase (A).</td></tr><tr><td><strong>ISEC3(a,b,c)</strong></td><td>Fictitious winding current for each phase (A); available only when “3-limb magnetic circuit” is enabled.</td></tr><tr><td><strong>SEG(a,b,c)</strong></td><td><p>Segment number of the saturation curve.</p><ul><li><strong>Saturation</strong> model: numbering is positive, starting at 1 for the last segment in the negative saturation zone.</li><li><strong>Hysteresis</strong> model: numbering is positive/negative starting at 1/−1 in the positive/negative saturation zone; it is zero in the hysteresis zone.</li></ul></td></tr></tbody></table>

## References <a href="#id-2-winding3-phaseseriessaturabletransformer-references" id="id-2-winding3-phaseseriessaturabletransformer-references"></a>

«Hysteresis Modeling in the Matlab/Power System Blockset», Silvano Casoria, Patrice Brunelle, Gilbert Sybille, Mathematics and Computers in Simulation, Volume 63, Issues 3-5, Pages 237-248


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.opal-rt.com/docs/hypersim/library-blocks-reference/network-transformers/2-winding-3-phase-series-saturable-transformer.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
