> 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/pe-add-on-opal-rt/model-in-schematic-editor/library-blocks-reference/machines-blocks/squirrel-cage-induction-machine-with-saturation.md).

# Squirrel-Cage Induction Machine with saturation

## Description

<figure><img src="https://1300141755-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCyfrFRdgX5VC5iwM13Zm%2Fuploads%2FqrUJgMBFviTGhb3Lxn4V%2Fimage.png?alt=media&amp;token=5de11a55-b2a7-4c8e-9927-2813f4831490" alt=""><figcaption></figcaption></figure>

The **Squirrel-Cage Induction Machine (SCIM)wit saturation** block models a three‑phase asynchronous machine with a squirrel‑cage rotor, including magnetizing‑inductance saturation in the stationary (stator) reference frame and temperature‑dependent variations in the stator and rotor resistances. Optional resolver and encoder models are also available.

The machine can operate in both motoring mode, when the mechanical torque is positive, and generating mode when the mechanical torque is negative.

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

### Resolver Encoder Model <a href="#resolver-encoder-model" id="resolver-encoder-model"></a>

The equations of the resolver encoder can be expressed as follows:

$$
\theta\_{res}=(\theta\_{mec}+\theta\_{offset})\times R\_{pp} \\\[8pt]
\text{cosine}
=============

\text{Excitation}
\times
\bigl(
\cos(\theta\_{\text{res}}), R\_{h\_{cs}}
\+
\sin(\theta\_{\text{res}}), R\_{k\_{ss}}
\bigr)
\\\[8pt]
\text{sine}
===========

\text{Excitation}
\times
\bigl(
\cos(\theta\_{\text{res}}), R\_{k\_{cc}}
\+
\sin(\theta\_{\text{res}}), R\_{k\_{sc}}
\bigr)
\\\[8pt]
$$

where ***θ***<sub>***res***</sub> is the resolver angle, ***θ***<sub>***mec***</sub> is the mechanical angle of the machine, ***θ***<sub>***offset***</sub> is the angle offset, $$\bold{R\_{pp}}$$ is the Number of pole pairs of the resolver and $$\bold{R\_k}$$ are the resolver sine cosine gains.

## Parameters

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

<table><thead><tr><th width="180">Parameter</th><th width="310">Description</th><th width="100">Sets feature</th><th width="120">I/O &#x26; Monitoring</th></tr></thead><tbody><tr><td><strong>Stator resistances R</strong><sub><strong>S</strong></sub></td><td>In Constant DQ mode:<br>Resistances of the stator windings for phases a, b, and c (Ω).</td><td>No</td><td>N/A</td></tr><tr><td><strong>Stator leakage inductance L</strong><sub><strong>lS</strong></sub></td><td>Stator winding leakage inductance of phase a, b, and c (H).</td><td>No</td><td>N/A</td></tr><tr><td><strong>Rotor resistance R</strong><sub><strong>r'</strong></sub></td><td>Equivalent rotor winding resistance referred to the stator of phase a, b, and c (Ω).</td><td>No</td><td>N/A</td></tr><tr><td><strong>Rotor leakage inductance L</strong><sub><strong>lr'</strong></sub></td><td>Equivalent rotor winding leakage inductance referred to the stator of phase a, b, and c (H)</td><td>No</td><td>N/A</td></tr><tr><td><strong>Mutual inductance</strong> <strong>L</strong><sub><strong>m</strong></sub></td><td>Stator-rotor mutual (magnetizing) inductance of phase a, b, and c (H)</td><td>No</td><td>N/A</td></tr><tr><td><strong>Number of pole pairs pp</strong></td><td>Number of pole pairs.</td><td>No</td><td>N/A</td></tr><tr><td><strong>Stator currents i</strong><sub><strong>S</strong></sub></td><td>Currents measured at phases a, b, and c of the stator (A)</td><td>No</td><td><p>To model<br>To AO</p><p>To SFP<br>To Waveform</p></td></tr><tr><td><strong>Stator currents (DQ)</strong> <strong>i</strong><sub><strong>sqd</strong></sub></td><td>Currents measured of axis d and q</td><td>No</td><td><p>To model<br>To AO</p><p>To SFP<br>To Waveform</p></td></tr><tr><td><strong>Stator qd fluxes Φ</strong><sub><strong>sqd</strong></sub></td><td>Stator fluxes in qd frame (Wb)</td><td>No</td><td>To model<br>To AO<br>To SFP<br>To Waveform</td></tr><tr><td><strong>Stator voltages V</strong><sub><strong>sqd</strong></sub></td><td>Stator voltages in qd frame</td><td>No</td><td>To model<br>To AO<br>To SFP<br>To Waveform</td></tr><tr><td><strong>Rotor phase currents i</strong><sub><strong>r'</strong></sub></td><td>Rotor equivalent phase a, b, and c currents, referred to the stator (A)</td><td>No</td><td>To model<br>To AO<br>To SFP<br>To Waveform</td></tr><tr><td><strong>Rotor qd currents i</strong><sub><strong>rdq</strong></sub></td><td>Rotor currents in qd frame, referred to the stator (A)</td><td>No</td><td><p>To model<br>To AO</p><p>To SFP<br>To Waveform</p></td></tr><tr><td><strong>Rotor qd fluxes Φ</strong><sub><strong>rdq'</strong></sub></td><td>Rotor fluxes in qd frame, referred to the stator (Wb)</td><td>No</td><td>To model<br>To AO<br>To SFP<br>To Waveform</td></tr><tr><td><strong>Snubber resistance R</strong><sub><strong>Sn</strong></sub></td><td>Snubber resistances on phases a, b, and c (Ω).</td><td>No</td><td>N/A</td></tr><tr><td><strong>Snubber capacitance C</strong><sub><strong>Sn</strong></sub></td><td>Snubber capacitances on phases a, b, and c (F).</td><td>No</td><td>N/A</td></tr></tbody></table>
{% endtab %}

{% tab title="Mechanical" %}

<table><thead><tr><th width="180">Parameter</th><th width="310">Description</th><th width="100">Stets feature</th><th width="120">I/O &#x26; Monitoring</th></tr></thead><tbody><tr><td><strong>J Rotor inertia</strong></td><td>Rotor moment of inertia available only in Torque mode (kg·m<sup>2</sup>)</td><td>No</td><td>N/A</td></tr><tr><td><strong>F</strong><sub><strong>s</strong></sub><strong> Static friction torque</strong></td><td>Static friction torque (N·m)</td><td>No</td><td>N/A</td></tr><tr><td><strong>F</strong><sub><strong>v</strong></sub><strong> Viscous friction coefficient</strong></td><td>Viscous friction available only in Torque mode (N·m·s/rad)</td><td>No</td><td>N/A</td></tr><tr><td><strong>ctrl Mechanical control mode</strong></td><td><p>Options: Speed or Torque.</p><p>In <strong>Speed (0) mode</strong>, the mechanical model is bypassed and the speed command is applied directly.<br>In <strong>Torque (1) mode</strong>, the torque command drives the mechanical model to compute speed.</p></td><td>Yes</td><td>From model</td></tr><tr><td><strong>T Torque command</strong></td><td>Torque command to the mechanical model (N·m)</td><td>Yes</td><td>From model</td></tr><tr><td><strong>ω</strong><sub><strong>r0</strong></sub><strong> Initial rotor speed command</strong></td><td>Initial rotor speed setpoint (rpm)</td><td>No</td><td>N/A</td></tr><tr><td><strong>ω</strong><sub><strong>rc</strong></sub><strong> Rotor speed command</strong></td><td>Rotor speed command to the mechanical model (rpm)</td><td>Yes</td><td>From model</td></tr><tr><td><strong>Rotor speed ω</strong><sub><strong>r</strong></sub></td><td>Mechanical rotor speed (rpm)</td><td>No</td><td>To model<br>To AO<br>To SFP<br>To Waveform</td></tr><tr><td><strong>Electromagnetic torque T</strong><sub><strong>e</strong></sub></td><td>Torque measured at the rotor (Nm)</td><td>No</td><td>To model<br>To AO<br>To SFP<br>To Waveform</td></tr><tr><td><strong>θ</strong><sub><strong>0</strong></sub><strong> Initial rotor angle</strong></td><td>Rotor position at time t = 0 (°)</td><td>No</td><td>N/A</td></tr><tr><td><strong>Rotor angle θ</strong></td><td>Mechanical rotor angle (0–360°) (°)</td><td>No</td><td>To model<br>To AO<br>To SFP<br>To Waveform</td></tr></tbody></table>
{% endtab %}

{% tab title="Resolver" %}

<table><thead><tr><th width="180">Parameter</th><th width="310">Description</th><th width="100">Sets feature</th><th width="120">I/O &#x26; Monitoring</th></tr></thead><tbody><tr><td><strong>Enable resolver Ren</strong></td><td><p><strong>Disable</strong> the resolver.</p><p><strong>Enable</strong> the resolver, the following parameters are displayed.</p></td><td>No</td><td>N/A</td></tr><tr><td><strong>Resolver feedback signals R</strong><sub><strong>sc</strong></sub></td><td>Resolver sine and cosine feedback signals proportional to the angle.</td><td>No</td><td>To model<br>To AO<br>To SFP<br>To Waveform</td></tr><tr><td><strong>R</strong><sub><strong>pp</strong></sub><strong> Number of resolver pole pairs</strong></td><td>Resolver pole-pair count.</td><td>No</td><td>N/A</td></tr><tr><td><strong>R</strong><sub><strong>dir</strong></sub><strong> Direction of the sensor rotation</strong></td><td>Options: Clockwise or counterclockwise.</td><td>No</td><td>N/A</td></tr><tr><td><strong>θ</strong><sub><strong>offset</strong></sub><strong> Angle offset Δθ (Sensor − Rotor)</strong></td><td>Angle offset between resolver and rotor position (°)</td><td>No</td><td>N/A</td></tr><tr><td><strong>R</strong><sub><strong>k</strong></sub><strong> Resolver sine/cosine gains</strong></td><td>The sine/cosine modulation output sine/cosine component amplitude. Default value are 1, 0, 0 and 1.</td><td>No</td><td>N/A</td></tr><tr><td><strong>E</strong><sub><strong>type</strong></sub><strong> Excitation source type</strong></td><td><p>Options AC, DC External<br><strong>AC</strong>: generated in FPGA at the specified frequency,</p><p><strong>DC:</strong> single excitation only<br><strong>External</strong> provided from outside the model.</p></td><td>No</td><td>N/A</td></tr><tr><td><strong>E</strong><sub><strong>src</strong></sub><strong> Excitation source</strong></td><td>External excitation source in External mode.</td><td>No</td><td>From AI</td></tr><tr><td><strong>E</strong><sub><strong>f</strong></sub><strong> Excitation frequency</strong></td><td>Frequency of the excitation when in AC mode (Hz)</td><td>No</td><td>N/A</td></tr><tr><td><strong>E</strong><sub><strong>ts</strong></sub><strong> Excitation time shift</strong></td><td>Compensates time offset between the carrier generation input and modulated signal output (s)</td><td>No</td><td>N/A</td></tr></tbody></table>
{% endtab %}

{% tab title="Encoder" %}

<table><thead><tr><th width="180">Parameter</th><th width="310">Description</th><th width="100">Sets feature</th><th>I/O &#x26; Monitoring</th></tr></thead><tbody><tr><td><strong>Enc</strong><sub><strong>en</strong></sub><strong> Enable encoder</strong></td><td><p><strong>Disable</strong> the encoder.</p><p><strong>Enable</strong> the encoder, the following parameters are displayed.</p></td><td>No</td><td>N/A</td></tr><tr><td><strong>A B Z encoder signals Q</strong><sub><strong>ABZ</strong></sub></td><td>Quadrature encoder A, B, and Z signals in Quadrature mode</td><td>No</td><td>To DO</td></tr><tr><td><strong>Q</strong><sub><strong>ppr</strong></sub><strong> Number of pulses per revolution</strong></td><td>Number of pulses in one full revolution of the encoder in Quadrature mode.</td><td>No</td><td>N/A</td></tr><tr><td><strong>Q</strong><sub><strong>dir</strong></sub><strong> Direction of the sensor rotation</strong></td><td>Direction in which the sensor is turning, A leads B or B leads A in Quadrature mode.</td><td>No</td><td>N/A</td></tr><tr><td><strong>θ</strong><sub><strong>offset</strong></sub><strong> Angle offset Δθ ( Sensor - Rotor )</strong></td><td>Angle offset between the encoder and the rotor position from 0 to 360 degrees</td><td>No</td><td>N/A</td></tr><tr><td><strong>Q</strong><sub><strong>rat</strong></sub><strong> Encoder speed ratio</strong></td><td>Sensor-to-mechanical position ratio. Encoder angle = Qrat × machine mechanical angle in Quadrature mode.</td><td>No</td><td>N/A</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

{% hint style="info" %}
The I/O type and quantities depend on the selected firmware.
{% endhint %}

### Machine files parameters

<details>

<summary><strong>How to specify the electrical saturation profile parameters file</strong></summary>

</details>

## Conserving ports

| Port           | Description                                       |
| -------------- | ------------------------------------------------- |
| Stator phase A | Electrical conserving port for stator terminal A. |
| Stator phase B | Electrical conserving port for stator terminal B. |
| Stator phase C | Electrical conserving port for stator terminal C. |


---

# 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/pe-add-on-opal-rt/model-in-schematic-editor/library-blocks-reference/machines-blocks/squirrel-cage-induction-machine-with-saturation.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.
