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

# Saturable Inductor

## Description

<figure><img src="https://3212678799-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FABuoXNYgvaoO7wIe3bfO%2Fuploads%2Fgit-blob-7fd0ea76186229570908b15f76946dad9f48e7a6%2FSE_saturable_inductor.png?alt=media" alt=""><figcaption></figcaption></figure>

The **Saturable Inductor** block models a saturable inductor using a controlled current source in parallel with an RC snubber. The generated current is determined by the voltage measured across the device.

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

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

### Model equations

The current injected into the controlled current source $$I\_L\[k+1]$$ is given by the table provided by the user as a function of the flux, and this flux is calculated based on its previous value and the measured voltage across the element.

$$
\frac{\psi\[k+1]}{T\_S} = V\_{\text{input}}\[k] + \frac{\psi\[k]}{T\_S} \\\[8pt]

I\_L\[k+1] = \mathrm{Table}!\left( \frac{\psi\[k+1]}{T\_S} \right) \\\[8pt]
$$

The magnetic flux $$\psi$$ is the state variable and its initial value $$\psi\[0]$$ shall be provided. The 'Table' function in the expression above is a piecewise linear function symmetric about the origin, as illustrated in the figure below:

<figure><img src="https://3212678799-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FABuoXNYgvaoO7wIe3bfO%2Fuploads%2Fgit-blob-09d4fd896779a8349b1aeb49228444408f653ccf%2FSE_satindu_modelschema.png?alt=media" alt="" width="375"><figcaption><p>The saturation curve is defined by a set of points that form<br>a piecewise linear function symmetric about the origin.</p></figcaption></figure>

## Parameters

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

### **Magnetization**

| Parameter                                | Description                                                                                                             | Sets feature | I/O & Monitoring |
| ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------ | ---------------- |
| **Saturation characteristic (φ=f(Im))**  | <p>Saturation profile of the magnetizing inductance of the transformer<br>Import the Saturation Characteristic file</p> | No           | N/A              |
| **Initial flux (φ**<sub>**0**</sub>**)** | Initial flux in weber (Wb)                                                                                              | No           | N/A              |

<details>

<summary><strong>How to specify the magnetizing inductance parameters of a saturable inductor?</strong></summary>

</details>

### 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              |

## Conserving ports

| Port   | Description   |
| ------ | ------------- |
| **p1** | Positive port |
| **n1** | 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/model-in-schematic-editor/library-blocks-reference/passive-blocks/saturable-inductor.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.
