> 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/rt-lab/simulink-blocks-reference/artemis-library/ssn-synchronous-machine.md).

# SSN Synchronous Machine

## Description

<figure><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-2e345f5935afcfc7b692bbdc2d493300a6d04e45%2FArtemis_SSN_sync_machine_block.png?alt=media" alt="" width="312"><figcaption></figcaption></figure>

The **SSN Synchronous Machine** block, located in the **ARTEMiS/SSN/SSN rotating Machines** library, implements a 3‑phase synchronous machine modeled in the d‑q rotor reference frame for use with the SSN solver. The stator windings are wye‑connected to an internal neutral point. The neutral point can be grounded through a user‑specified impedance or via an external impedance (model with Neutral terminal available).

The model is 6th order for the round‑rotor type and 5th order for the salient‑rotor type. Steady‑state and differential saturation modes are supported using total flux in both d‑q axes for the round rotor and d‑axis only for the salient type.

<figure><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-50bc22f7c169e2bf44bde72b04faa37a17410b16%2FArtemis_SSN_sync_machine_model_curves.png?alt=media" alt=""><figcaption><p>Difference between global inductance and differential saturations<br>when the machine is operated at its nominal saturation point</p></figcaption></figure>

{% hint style="danger" %}
This block requires a valid RT-LAB license on the simulator with the feature ARTEMiS enabled. Refer to[ ARTEMiS Requirements](https://www.opal-rt.com/docs/rt-lab/model-and-simulation/power-systems-with-artemis/artemis-requirements.md) for details.
{% endhint %}

## Mask parameters

<figure><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-0fd70d60356b3e5bba8ebb21e20d5811a18a0bf6%2FArtemis_SSN_sync_machine_mask.png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

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

<table data-search="false"><thead><tr><th width="278.60003662109375">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Nominal power, voltage, frequency, field current</strong></td><td>[ Pn(VA) Vn(Vrms) fn(Hz) ifn(A) ]<br>Nominal total power, line‑line RMS voltage, frequency, and field current.</td></tr><tr><td><strong>Rotor type</strong></td><td>Salient (5th order model) / Round (6th order model).</td></tr><tr><td><strong>Stator parameters</strong></td><td>[ Rs(ohm), Ll, Lmd, Lmq(H), Lcanay(H) ]<br>Stator resistance and leakage inductance; magnetization inductance for d‑q axes. Lcanay is the Canay inductance correction accounting for unequal mutual flux couplings on the d‑axis. If unknown, ignore or set to zero.</td></tr><tr><td><strong>Field parameters</strong></td><td>[ Rf'(ohm) Llfd'(H) ]<br>Field resistance and leakage inductance (referred to the stator).</td></tr><tr><td><strong>Dampers parameters</strong></td><td>[ Rkd', Llkd' Rkq1', Llkq1' Rkq2' Llkq2' ] (R=ohm, L=H)<br>D‑ and q‑axis damper resistances and leakage inductances.</td></tr><tr><td><strong>Pole pairs</strong></td><td>Number of pole pairs.</td></tr><tr><td><strong>Initial rotor angle</strong></td><td>Initial electrical rotor angle in degrees. A zero angle makes the back‑EMF on phase A maximum and produces a waveform on phase A under no‑load conditions.</td></tr><tr><td><strong>Initial currents</strong></td><td>[Ifd Ia Ib Ic (A) (amplitude) Ia Ib Ic (deg) (angle)]<br>Initial field current and stator phase currents (amplitudes in A and angles in degrees).</td></tr><tr><td><strong>Saturation</strong></td><td>Enables saturation when selected. By default, global (steady‑state) saturation is used unless Differential saturation is selected.</td></tr><tr><td><strong>Differential saturation</strong></td><td>Uses differential saturation when selected.<br>In differential mode, only 3 saturation points (plus origin) are allowed; a 3rd‑order function is fitted.</td></tr><tr><td><strong>Open stator saturation curve: field current (pu)</strong></td><td>Per‑unit field current; base is the nominal field current.</td></tr><tr><td><strong>Open stator saturation curve: phase‑phase RMS voltage (pu)</strong></td><td>Per‑unit phase‑phase RMS voltage; base is the nominal terminal voltage specified in the first parameter.</td></tr><tr><td><strong>Plot saturation curves</strong></td><td>Plots the saturation curves if checked.</td></tr><tr><td><strong>Zero sequence machine reactance (Ohms)</strong></td><td>Only for SM with internal neutral connection, sum of the machine zero‑sequence reactance and the impedance used to connect the star common point to ground.</td></tr><tr><td><strong>Neutral grounding resistance (Ohms)</strong></td><td>Only for SM with internal neutral connection, resistance value, in series with Zero sequence machine reactance, connecting the stator star point to ground.</td></tr><tr><td><strong>Sample Time (s)</strong></td><td>Model sample time in seconds.</td></tr></tbody></table>
{% endtab %}

{% tab title="SSN parameters" %}

<table><thead><tr><th width="240.20001220703125">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Computed stator‑to‑field coil winding turn ratio (read only)</strong></td><td>Computed using:<br>Ns_on_Nf = Lmd<em>Ifn</em>(2<em>pi</em>fn)/Vn,<br>where Lmd is d‑axis mutual inductance, Ifn is nominal field current, fn is nominal electric frequency, and Vn is machine line‑line RMS voltage. Useful to convert stator‑referenced values to field‑referenced values.</td></tr><tr><td><strong>Delayed speed term</strong></td><td>When selected, includes the machine speed term with a delay in the state‑space equations (moved from A to B matrix), producing a constant nodal admittance compatible with SSN LDL<sup>T</sup> factorization.</td></tr><tr><td><strong>Backward Euler discretization</strong></td><td>Only for model with External Neutral Terminal, when selected, discretizes SSN‑SM equations with the Backward Euler method. This may reduce oscillatory terminal voltages in some cases.</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

{% hint style="info" %}
All SSN rotating machines internally use an orthonormal Park transform that differs from the classic North American convention.
{% endhint %}

## Conserving ports

<table><thead><tr><th width="239.5999755859375">Input</th><th>Description</th></tr></thead><tbody><tr><td><strong>Field</strong></td><td>Positive field winding terminal; the negative field terminal is implicitly connected to ground.</td></tr><tr><td><strong>A, B, C</strong></td><td>Stator phase connection points.</td></tr><tr><td><strong>Neutral</strong></td><td>Neutral star connection point (only in the model with Neutral terminal available). Adds a nodal connection and increases computational time; use only when required.</td></tr></tbody></table>

## Inputs

<table><thead><tr><th width="239.5999755859375">Input</th><th>Description</th></tr></thead><tbody><tr><td><strong>w_mec</strong></td><td>Mechanical speed of the machine in rad/s. Typically computed by a separate mechanical model that uses this block’s electric torque (Te) as an input.</td></tr></tbody></table>

## Outputs

<table><thead><tr><th width="250">Output</th><th>Description</th></tr></thead><tbody><tr><td>meas</td><td>measurements available</td></tr></tbody></table>

<details>

<summary>Measurements available</summary>

| Name                   | Description                                                                                                                                                     |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| meas.flux              | phid, phiq, phif, phikd, phikq, phikq2: internal state fluxes (Wb)                                                                                              |
| meas.Iabc              | ABC terminal currents (A)                                                                                                                                       |
| meas.Ifield            | Field terminal current (A)                                                                                                                                      |
| meas.Peo               | Total electric power generated (W)                                                                                                                              |
| meas.Te                | Electric torque (N.m)                                                                                                                                           |
| meas.Angle             | Electrical rotor angle (rad). The d‑axis is aligned with phase A. At no load, 0 rad corresponds to a zero voltage of terminal A to ground, with negative slope. |
| meas.phim\_dq          | Air‑gap flux (Wb).                                                                                                                                              |
| meas.saturation factor | Per‑unit global inductance. By definition, it equals 1 at the nominal operating point.                                                                          |
| meas.Vd, meas.Vq       | Stator d‑q voltages (V).                                                                                                                                        |
| meas.Id, meas.Iq       | Stator d‑q currents (A).                                                                                                                                        |
| meas.Load angle        | Load angle computed as arctan(Vq/Vq) (deg)                                                                                                                      |

</details>


---

# 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/rt-lab/simulink-blocks-reference/artemis-library/ssn-synchronous-machine.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.
