> 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/ehs/3.7/model-in-schematic-editor/library-blocks-reference/transformer-blocks/saturable-transformer.md).

# Saturable Transformer

## Description

<figure><img src="https://521571437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fo99Izmvvw5eHT4ldzI4g%2Fuploads%2Fgit-blob-2ce3d03c5c2e7b0fdf47aa148b4defc4bc40a250%2FSE_sattransformer.png?alt=media" alt=""><figcaption></figcaption></figure>

The **Saturable Transformer** block implements a transformer represented by the following equivalent circuit:

<figure><img src="https://521571437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fo99Izmvvw5eHT4ldzI4g%2Fuploads%2Fgit-blob-18b902120b25874607634be69ad1d34d2c804927%2FSE_sattransfocircuiteq.png?alt=media" alt=""><figcaption></figcaption></figure>

The circuit is same than the Single Phase Two Winding Transformer with ideal mode configuration, except that the magnetizing inductance has been replaced by its saturated version, which model consists of a controlled current source in parallel with an RC snubber. The value of the generated current is determined by the voltage measured across it.

{% hint style="info" %}
This block is only available in the eHS library.
{% endhint %}

<figure><img src="https://521571437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fo99Izmvvw5eHT4ldzI4g%2Fuploads%2Fgit-blob-3bf7e928437016b0d8760cd11e1b68d68bdd9c8a%2FSE_satinductor_model.png?alt=media" alt="" width="320"><figcaption></figcaption></figure>

## Parameters

<figure><img src="https://521571437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fo99Izmvvw5eHT4ldzI4g%2Fuploads%2Fgit-blob-b6845e80d07d32415eba025cff26fb74f108fa4e%2FSE_1p2windingtransfoparam.png?alt=media" alt="" width="320"><figcaption></figcaption></figure>

{% tabs %}
{% tab title="Primary winding (1)" %}

| Parameter                                      | Description                                                                                                          | Sets feature | I/O & Monitoring |
| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------ | ---------------- |
| **Ideal**                                      | When **enabled**, primary leakage resistance and inductance are neglected. When **disabled**, they can be specified. | No           | N/A              |
| **Nominal voltage (V**<sub>**1**</sub>**)**    | The nominal voltage V, in volts RMS, of the primary winding.                                                         | Yes          | N/A              |
| **Resistance (R**<sub>**1**</sub>**)**         | The resistance, in ohms, of the primary winding.                                                                     | Yes          | N/A              |
| **Leakage inductance (L**<sub>**1**</sub>**)** | The leakage inductance, in henries, of the primary winding.                                                          | Yes          | N/A              |
| **Initial current (I**<sub>**1**</sub>**)**    | The initial current A, in amperes, of the primary winding.                                                           | No           | N/A              |
| {% endtab %}                                   |                                                                                                                      |              |                  |

{% tab title="Secondary winding (2)" %}

| Parameter                                      | Description                                                                                                          | Sets feature | I/O & Monitoring |
| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------ | ---------------- |
| **Ideal**                                      | When **enabled**, primary leakage resistance and inductance are neglected. When **disabled**, they can be specified. | No           | N/A              |
| **Nominal voltage (V**<sub>**2**</sub>**)**    | The nominal voltage V, in volts RMS, of the secondary winding.                                                       | Yes          | N/A              |
| **Resistance (R**<sub>**2**</sub>**)**         | The resistance, in ohms, of the secondary winding.                                                                   | Yes          | N/A              |
| **Leakage inductance (L**<sub>**2**</sub>**)** | The leakage inductance, in henries, of the secondary winding.                                                        | Yes          | N/A              |
| **Initial current (I**<sub>**2**</sub>**)**    | The initial current A, in amperes, of the secondary winding.                                                         | No           | N/A              |
| {% endtab %}                                   |                                                                                                                      |              |                  |

{% tab title="Magnetization" %}

| Parameter                                        | Description                                                                                                                                 | Sets feature | I/O & Monitoring |
| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------------- |
| **Ideal**                                        | When this option is enabled, the core resistance and core inductance are set to very high values, so the magnetization branch is neglected. | No           | N/A              |
| **Core loss resistance (R**<sub>**m**</sub>**)** | Magnetization branch equivalent resistance value in ohm (Ω).                                                                                | Yes          | N/A              |
| **Saturation characteristic (φ=f(Im))**          | Import a saturation characteristic file defining the transformer magnetizing inductance profile.                                            | No           | N/A              |
| **Initial current (I**<sub>**m**</sub>**)**      | The initial current A, in amperes, of the magnetizing inductance.                                                                           | No           | N/A              |
| {% endtab %}                                     |                                                                                                                                             |              |                  |

{% tab title="Snubber" %}

| Parameter                                        | Description                              | Sets feature | I/O & Monitoring |
| ------------------------------------------------ | ---------------------------------------- | ------------ | ---------------- |
| **Snubber resistance (R**<sub>**sn**</sub>**)**  | Snubber resistance value in ohm (Ω).     | Yes          | N/A              |
| **Snubber capacitance (C**<sub>**sn**</sub>**)** | Snubber capacitance value in farads (F). | Yes          | N/A              |
| {% endtab %}                                     |                                          |              |                  |
| {% endtabs %}                                    |                                          |              |                  |

### Saturation characteristic file

<details>

<summary>How to specify the magnetizing inductance parameters of a saturable transformer</summary>

This block uses a table-defined magnetizing inductance.

The saturable magnetizing inductance parameters are described in a JSON format.

| Parameter (JSON key)       | Value type | Unit | Description                            | Example                                                                                                                  |
| -------------------------- | ---------- | ---- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| magnetizingFluxBreakpoints | double\[]  | Wb   | Core magnetizing flux                  | <p>"magnetizingFluxBreakpoints": \[<br>0.0,<br>0.0000129,<br>0.00002,<br>0.0000227,<br>0.0000236,<br>0.0000239<br>],</p> |
| currentValues              | double\[]  | A    | Current through the magnetizing branch | <p>"currentValues": \[<br>0.0,<br>0.64,<br>1.28,<br>1.92,<br>2.56,<br>3.2<br>]</p>                                       |

The examples provided above, when combined in a valid JSON format, would appear as follows:

{% code overflow="wrap" lineNumbers="true" %}

```jsonl
{
	"magnetizingFluxBreakpoints": [
		0.0,
		0.0000129,
		0.00002,
		0.0000227,
		0.0000236,
		0.0000239
	],
	"currentValues": [
		0.0,
		0.64,
		1.28,
		1.92,
		2.56,
		3.2
	]
}
```

{% endcode %}

#### Parameters constraints

The following constraints applies the saturation characteristic: $$\varphi > 0;\ I\_M > 0 \\\[8pt] \varphi\_{i+1} > \varphi\_i ;;\Rightarrow;; I\_{M,i+1} \ge I\_{M,i} \qquad \text{(monotonically increasing)}\\\[8pt]$$

where $$\varphi$$ is the magnetizing flux, and $$I\_M$$ is the magnetizing current.

Additionally, the number of elements of the array “magnetizingFluxBreakpoints“ shall be the same of “currentValues“ and the number of points shall be less than or equal to 17.

</details>

## Conserving ports

| Port   | Description   |
| ------ | ------------- |
| **p1** | Positive port |
| **n1** | Negative port |
| **p2** | Positive port |
| **n2** | Negative port |


---

# 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/ehs/3.7/model-in-schematic-editor/library-blocks-reference/transformer-blocks/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.
