> 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-saturable-transformer.md).

# 2 Winding 3 Phase 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-62ff25306771c36808eef2b0a78b2ee4eaab8e29%2Fimage%20(1168).png?alt=media" alt=""><figcaption></figcaption></figure>

The **2 Winding 3 Phase Saturable Transformer** block, located in the **Network Transformers** library, adds modeling of saturation and hysteresis to a linear transformer, with increased computation time when these effects are enabled.

Saturation is a core (winding) characteristic, independent of the 3‑phase connection type (Y, Delta, or Zigzag). It is represented 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 modeled by the parallel resistance (Rm). The initial trajectory is defined by the initial flux. Two special tolerances limit the generation of minor nested loops and their stored trajectories (loops that are too small are represented by straight segments). Their number must be limited (100, which suffices in most cases).

Above the main cycle (limited to ±Is), the saturation zone is entered. Saturation is characterized either by a series of points on the curve or by an air-core inductance that the curve approaches asymptotically. In the latter case, the model automatically generates segments (in both positive and negative saturation zones) of equal length (Is).

## Mask parameters

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

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

<table><thead><tr><th width="242">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Description</strong></td><td>Free-form notes 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, at the cost of computation time.</td></tr><tr><td><strong>Base primary/secondary winding voltage (rmsLL)</strong></td><td>Base value for per-unit conversion (kV). Voltage is expressed in kV rms LL. The base and 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 per-unit conversion (MVA).</td></tr><tr><td><strong>Base frequency</strong></td><td>Base value for per-unit conversion (Hz).</td></tr><tr><td><strong>Rm</strong></td><td>Equivalent resistance of iron losses in the magnetic circuit (Ω).</td></tr><tr><td><strong>Primary/secondary connection</strong></td><td><strong>Y ground</strong>: Grounded Y connection (can use the internal neutral impedance specified in the other tab).<br><strong>Y floating</strong>: Floating Y connection.<br><strong>Y neutral</strong>: Y connection with impedance connected at input pin N1 or N2.<br><strong>Delta lead</strong>: Delta connection with 30° lead.<br><strong>Delta ground</strong>: Grounded delta connection (Phase C is grounded).<br><strong>Delta lag</strong>: Delta connection with 30° lag.</td></tr><tr><td><strong>Voltage (rmsLL)</strong></td><td>Rated voltage of the winding (kV rms LL).</td></tr><tr><td><strong>R1, R2</strong></td><td>Leakage resistance of the winding (Ω).</td></tr><tr><td><strong>L1, L2</strong></td><td>Leakage inductance of the winding (H).</td></tr></tbody></table>
{% endtab %}

{% tab title="Neutral impedance" %}

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

{% tab title="Saturation" %}

| Parameter                 | Description                                                                                                                          |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| **Number of data 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 origin (0,0) is implied (A).                                                   |
| **Saturation flux**       | Flux for each segment of the saturation curve; the origin (0.0, 0.0) is implied (V·s).                                               |
| {% endtab %}              |                                                                                                                                      |

{% tab title="Hysteresis" %}

<table><thead><tr><th width="219">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Saturation data type</strong></td><td>Determines if the saturation curve is calculated by the model or defined by a series of segments (Equation, Curve).</td></tr><tr><td><strong>Air core inductance</strong></td><td>Value of the saturation inductance that the curve approaches asymptotically (H).</td></tr><tr><td><strong>Slope at Ic</strong></td><td>Flux slope at coercive current (H).</td></tr><tr><td><strong>Coercitive current - Ic</strong></td><td>Positive coercive current at null flux (A).</td></tr><tr><td><strong>Saturation current - Is</strong></td><td>Current value of the first point in the saturation zone (A).</td></tr><tr><td><strong>Current tolerance</strong></td><td>Limits generation of minor nested loops. When the magnetizing current at the last inversion point and the preceding inversion point are closer than the specified tolerance (in % of Ic), the trajectory between them is represented by a straight segment.</td></tr><tr><td><strong>Remnant flux - Φr</strong></td><td>Positive remnant flux at null current (V·s).</td></tr><tr><td><strong>Saturation flux - Φs</strong></td><td>Flux value of the first point in the saturation zone (V·s).</td></tr><tr><td><strong>Flux tolerance</strong></td><td>Limits generation of minor nested loops. When the flux at the last inversion point and the preceding inversion point are closer than the specified tolerance (in % of Φs), the displacement follows the current loop.</td></tr><tr><td><strong>Initial flux (peak)</strong></td><td>Initial flux defining the initial trajectory, calculated assuming an inversion point on the main cycle (V·s).</td></tr><tr><td><strong>Number of 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 first value must be equal to Is (A).</td></tr><tr><td><strong>Saturation flux</strong></td><td>Flux for each segment of the saturation curve; the first value must be equal to Φs (V·s).</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

## Conserving ports

<table><thead><tr><th width="201">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 primary winding (supports only 1‑phase connections).</td></tr><tr><td><strong>Net_N2</strong></td><td>Neutral connection for 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 for each phase (A)</td></tr><tr><td><strong>SEG(a,b,c)</strong></td><td><p>Segment number of the saturation curve.<br>In the <strong>saturation</strong> model, the numbering is always positive, starting at 1 for the last segment in the negative saturation zone.</p><p>In the <strong>hysteresis</strong> model, the numbering is positive/negative starting at 1/−1 in the positive/negative saturation zone. In the hysteresis zone, it takes a null value.</p></td></tr></tbody></table>

## References <a href="#id-2-winding3-phasesaturabletransformer-references" id="id-2-winding3-phasesaturabletransformer-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-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.
