> 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-machines/synchronous-machine-w-fault.md).

# Synchronous Machine w/ Fault

## Description

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-8f8da294cb04397edb42494ff293369c7707c098%2Fimage%20(349).png?alt=media" alt=""><figcaption></figcaption></figure>

The **Synchronous Machine with Fault** block, located in the **Network Machines** library, can represent both **round-rotor** and **salient-pole machines** operating as either **motors** or **generators**, without relying on **Park’s transformation**. Based on **winding function theory**, the model accounts for the effects of **non-sinusoidal winding distributions**, resulting in a more accurate representation of machine behavior. In addition, it can simulate various **stator internal faults** and evaluate their impact on machines with **multiple parallel windings**. The **neutral impedance** can be specified by the user.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-cf8b508c4774234e53de7612d15694b0a63c463c%2Fimage%20(331).png?alt=media" alt=""><figcaption><p><strong>Direct axis diagram</strong></p></figcaption></figure>

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-c47f1ddc241a06b174cef553e83e178a9a06e162%2Fimage%20(332).png?alt=media" alt=""><figcaption><p><strong>Quadrature axis diagram</strong></p></figcaption></figure>

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-8f8b7243f201ec4d4913a6b2a3034b4e02a0f678%2Fimage%20(334).png?alt=media" alt=""><figcaption><p><strong>Exciter diagram</strong></p></figcaption></figure>

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-fc0028c46ca72e9c5ef0b5cd58b92660c8021e17%2Fimage%20(335).png?alt=media" alt=""><figcaption><p><strong>Stabilizer diagram</strong></p></figcaption></figure>

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-20af26a8870698dbc2a3f9d4b6aff72109cbda28%2Fimage%20(336).png?alt=media" alt=""><figcaption><p><strong>Speed regulator diagram</strong></p></figcaption></figure>

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-76cf34e1499031f7848371248d51d92e3fe3ff0a%2Fjfx10905609067123607857.png?alt=media" alt=""><figcaption><p>Hydraulic turbine diagram</p></figcaption></figure>

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-10ef4afeb1a03eb40836261774082db164038ff0%2Fimage%20(337).png?alt=media" alt=""><figcaption><p><strong>Shaft diagram</strong></p></figcaption></figure>

The block participates in load flow by using the network steady-state solution to initialize machine parameters.

## Mask parameters

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

{% tabs %}
{% tab title="Generator Controls" %}

<table><thead><tr><th width="217">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Description</strong></td><td>Free-form description of the component.</td></tr><tr><td><strong>Nominal electrical power of generator</strong></td><td>Base nominal electrical power of the three-phase generator (MVA)</td></tr><tr><td><strong>Nominal mechanical power of turbine</strong></td><td>Base nominal mechanical power of the turbine(MW)</td></tr><tr><td><strong>Voltage (rms LL)</strong></td><td>Base line-to-line RMS voltage (kV)</td></tr><tr><td><strong>Angular frequency</strong></td><td>Base angular frequency (rad/s)</td></tr><tr><td><strong>Voltage</strong></td><td>Voltage reference (pu)</td></tr><tr><td><strong>Voltage reference selection</strong></td><td>Select voltage reference: Vref or Vref = Vt.</td></tr><tr><td><strong>Power filter</strong></td><td>Power reference filter time constant (s)</td></tr><tr><td><strong>Active power</strong></td><td>Active power reference (MW)</td></tr><tr><td><strong>Speed</strong></td><td>Speed reference (pu)</td></tr><tr><td><strong>Reactive power</strong></td><td>Reactive power reference (only if Vref = Vt) (Mvar).</td></tr></tbody></table>
{% endtab %}

{% tab title="Synchronous Genrator" %}

<table data-search="false"><thead><tr><th width="200">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Xd</strong></td><td>Direct-axis synchronous reactance (pu)</td></tr><tr><td><strong>X’d</strong></td><td>Direct-axis transient reactance (pu)</td></tr><tr><td><strong>X’’d</strong></td><td>Direct-axis sub-transient reactance (pu)</td></tr><tr><td><strong>T’do</strong></td><td>Direct-axis transient time constant (s)</td></tr><tr><td><strong>T’’do</strong></td><td>Direct-axis sub-transient time constant (s)</td></tr><tr><td><strong>Xq</strong></td><td>Quadrature-axis synchronous reactance (pu)</td></tr><tr><td><strong>X’q</strong></td><td>Quadrature-axis transient reactance (pu)</td></tr><tr><td><strong>X’’q</strong></td><td>Quadrature-axis sub-transient reactance (pu)</td></tr><tr><td><strong>T’q</strong></td><td>Quadrature-axis transient time constant(s)</td></tr><tr><td><strong>T’’q</strong></td><td>Quadrature-axis sub-transient time constant(s)</td></tr><tr><td><strong>Fault location</strong></td><td>(%)</td></tr><tr><td><strong>Fault type</strong></td><td>Select Fault type:<br>1- Single winding to ground<br>2- Phase-phase shorted windings<br>3- Phase-phase windings to ground<br>4- Three phase shorted windings<br>5- Three phase windings to ground<br>6- Single phase shorted windings<br>7- Single phase windings to ground<br>8- Single winding shorted turns</td></tr><tr><td><strong>Rf_open</strong></td><td>(pu)</td></tr><tr><td><strong>Rf_close</strong></td><td>(pu)</td></tr><tr><td><strong>Rfg_open</strong></td><td>(pu)</td></tr><tr><td><strong>Rfg_close</strong></td><td>(pu)</td></tr><tr><td><strong>Ra</strong></td><td>Armature resistance (pu)</td></tr><tr><td><strong>XI</strong></td><td>Armature leakage reactance (pu)</td></tr><tr><td><strong>Xtfo</strong></td><td>Transformer leakage reactance (set to 0 if the generator output is regulated) (pu)</td></tr><tr><td><strong>Rtfo</strong></td><td>Transformer copper resistance (set to 0 if the generator output is regulated) (pu)</td></tr><tr><td><strong>Tdif</strong></td><td>Differentiation time constant(s)</td></tr><tr><td><strong>Lower limit of the field current</strong></td><td>Lower limit of the field current (pu)</td></tr><tr><td><strong>Upper limit of the field current</strong></td><td>Upper limit of the field current (pu)</td></tr><tr><td><strong>Initial voltage angle of external impedance</strong></td><td>Initial voltage angle of external impedance (degree)</td></tr><tr><td><strong>Frequency setting time</strong></td><td>Frequency setting time (s)</td></tr></tbody></table>
{% endtab %}

{% tab title="Exciter" %}

<table data-search="false"><thead><tr><th width="200">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Excitation circuit</strong></td><td>Enable or disable the excitation circuit (On/Off).</td></tr><tr><td><strong>Modelling of excitation circuit</strong></td><td>Select internal or external (input pins) excitation model.</td></tr><tr><td><strong>Kp</strong></td><td>Excitation proportional gain on voltage limit.</td></tr><tr><td><strong>Tr</strong></td><td>Voltage measurement time constant (s)</td></tr><tr><td><strong>Ka</strong></td><td>Voltage regulator gain.</td></tr><tr><td><strong>Ta</strong></td><td>Voltage regulator time constant (s)</td></tr><tr><td><strong>Kf</strong></td><td>Damping filter feedback gain.</td></tr><tr><td><strong>Tf</strong></td><td>Exciter damping filter feedback time constant (s)</td></tr><tr><td><strong>ex_Efdfix</strong></td><td>Constant excitation voltage (pu)</td></tr><tr><td><strong>ex_Vtmin</strong></td><td>Minimum static limit of voltage measurement (pu)</td></tr><tr><td><strong>ex_Vtmax</strong></td><td>Maximum static limit of voltage measurement (pu)</td></tr><tr><td><strong>ex_Vrmin</strong></td><td>Minimum static limit of excitation voltage (pu)</td></tr><tr><td><strong>ex_Vrmax</strong></td><td>Maximum static limit of excitation voltage (pu)</td></tr></tbody></table>
{% endtab %}

{% tab title="Stabilizer" %}

<table data-search="false"><thead><tr><th width="200">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Stabilizer circuit</strong></td><td>Enable or disable the stabilizer (On/Off).</td></tr><tr><td><strong>Modelling of stabilizer circuit</strong></td><td>Select internal or external (input pins) stabilizer model.</td></tr><tr><td><strong>Kap</strong></td><td>Gain on electric power.</td></tr><tr><td><strong>Kag</strong></td><td>Gain on gate opening.</td></tr><tr><td><strong>Tap</strong></td><td>Time constant on electric power (s)</td></tr><tr><td><strong>Tag</strong></td><td>Time constant on gate opening (s)</td></tr><tr><td><strong>Ks</strong></td><td>Stabilizer gain.</td></tr><tr><td><strong>Vsmin</strong></td><td>Minimum stabilizer voltage limit (pu)</td></tr><tr><td><strong>Vsmax</strong></td><td>Maximum stabilizer voltage limit (pu)</td></tr><tr><td><strong>Tw1</strong></td><td>Gate opening time constant 1 (s)</td></tr><tr><td><strong>Tw2</strong></td><td>Gate opening time constant 2 (s)</td></tr><tr><td><strong>T1</strong></td><td>Stabilizer time constant 1 (s)</td></tr><tr><td><strong>T2</strong></td><td>Stabilizer time constant 2 (s)</td></tr><tr><td><strong>T3</strong></td><td>Stabilizer time constant 3 (s)</td></tr><tr><td><strong>T4</strong></td><td>Stabilizer time constant 4 (s)</td></tr><tr><td><strong>T5</strong></td><td>Stabilizer time constant 5 (s)</td></tr><tr><td><strong>T6</strong></td><td>Stabilizer time constant 6 (s)</td></tr></tbody></table>
{% endtab %}

{% tab title="Speed Regulator" %}

<table data-search="false"><thead><tr><th width="201">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Regulation mode</strong></td><td>Select regulation mode: gate opening or electrical power.</td></tr><tr><td><strong>Modelling of speed regulator</strong></td><td>Select internal or external (input pins) speed regulator model.</td></tr><tr><td><strong>Kg</strong></td><td>Regulator gain.</td></tr><tr><td><strong>Tp</strong></td><td>Time constant for permanent droop (s)</td></tr><tr><td><strong>sigma</strong></td><td>Permanent droop.</td></tr><tr><td><strong>delta</strong></td><td>Transient droop.</td></tr><tr><td><strong>Ts</strong></td><td>Time constant for servovalve (s)</td></tr><tr><td><strong>Tt</strong></td><td>Time constant for transient droop (s)</td></tr><tr><td><strong>Twatt</strong></td><td>Time constant for power measurements (s)</td></tr><tr><td><strong>xmin</strong></td><td>Lower gate opening limit (pu)</td></tr><tr><td><strong>xmax</strong></td><td>Upper gate opening limit (pu)</td></tr><tr><td><strong>vxmin</strong></td><td>Lower gate speed limit at closing (negative)(pu/s)</td></tr><tr><td><strong>vxmax</strong></td><td>Upper gate speed limit at closing (positive)(pu/s)</td></tr><tr><td><strong>Ta1</strong></td><td>Time constant on speed measurements 1 (s)</td></tr><tr><td><strong>Ta2</strong></td><td>Time constant on speed measurements 2 (s)</td></tr><tr><td><strong>T1</strong></td><td>Time constant for speed regulator 1 (s)</td></tr><tr><td><strong>T2</strong></td><td>Time constant for speed regulator 2 (s)</td></tr></tbody></table>
{% endtab %}

{% tab title="Hydro Turbine & Shaft" %}

<table data-search="false"><thead><tr><th width="223">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Turb_on</strong></td><td>Enable or disable turbine operation (On/Off).</td></tr><tr><td><strong>Turb_mod</strong></td><td>Select internal or external (input pins) Hydrolic turbine model.</td></tr><tr><td><strong>Tw</strong></td><td>Water time response in the penstock (s)</td></tr><tr><td><strong>Beta</strong></td><td>Effect of speed variation on water height.</td></tr><tr><td><strong>T Start</strong></td><td>(s)</td></tr><tr><td><strong>KdStart</strong></td><td></td></tr><tr><td><strong>Shaft_on</strong></td><td>Enable or disable shaft (On/Off).</td></tr><tr><td><strong>Kd</strong></td><td></td></tr><tr><td><strong>Tgo</strong></td><td>(pu/MW.s)</td></tr><tr><td><strong>H</strong></td><td>(pu/MVA)</td></tr><tr><td><strong>wmin</strong></td><td>(pu)</td></tr><tr><td><strong>wmax</strong></td><td>(pu)</td></tr></tbody></table>
{% endtab %}

{% tab title="Load Flow" %}

<table><thead><tr><th width="242">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Type of bus</strong></td><td>Bus type: Swing, PV, or PQ.</td></tr><tr><td><strong>Voltage</strong></td><td>Bus voltage magnitude (pu)</td></tr><tr><td><strong>Angle</strong></td><td>Bus voltage angle (degree)</td></tr><tr><td><strong>Reactive power minimum</strong></td><td>Minimum reactive power (Mvar)</td></tr><tr><td><strong>Reactive power maximum</strong></td><td>Maximum reactive power (Mvar)</td></tr><tr><td><strong>Active power</strong></td><td>Active power (MW)</td></tr></tbody></table>
{% endtab %}

{% tab title="Machine data" %}
To Learn How to generate machine parameters see [Machine Parameters](https://github.com/Opal-RT-Technologies/product-docs-hypersim/tree/release-2026.4/model-and-simulation/use-parameter-generators/machine-parameters.md)
{% endtab %}
{% endtabs %}

## Inputs

<table><thead><tr><th width="209">Input</th><th>Description</th></tr></thead><tbody><tr><td><strong>Efd_i</strong></td><td>Field voltage.</td></tr><tr><td><strong>Fault</strong></td><td></td></tr><tr><td><strong>Pef_i</strong></td><td>Filtered measured electrical power.</td></tr><tr><td><strong>Vstab_i</strong></td><td>Stabilizer voltage.</td></tr><tr><td><strong>w_i</strong></td><td>Angular speed.</td></tr><tr><td><strong>x_i</strong></td><td>Gate opening.</td></tr></tbody></table>

## Outputs

| Output | Description |
| ------ | ----------- |
| net    |             |

## 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="206">Signal</th><th>Description</th></tr></thead><tbody><tr><td><strong>Edreg</strong></td><td>D-axis field voltage (pu)</td></tr><tr><td><strong>Efdgen</strong></td><td>Field voltage; now obsolete, replaced by Efd_label (pu)</td></tr><tr><td><strong>Eqreg</strong></td><td>Q-axis field voltage (pu)</td></tr><tr><td><strong>Fault</strong></td><td></td></tr><tr><td><strong>I0, I1, ..,I10</strong></td><td>(pu)</td></tr><tr><td><strong>IPROBE(a,b,c)</strong></td><td></td></tr><tr><td><strong>Ian</strong></td><td>D-axis current (pu)</td></tr><tr><td><strong>Iat</strong></td><td>Field current (pu)</td></tr><tr><td><strong>Ibn</strong></td><td>Q-axis current (pu)</td></tr><tr><td><strong>Icn</strong></td><td>(A)</td></tr><tr><td><strong>Ict</strong></td><td>(A)</td></tr><tr><td><strong>Id</strong></td><td>(A)</td></tr><tr><td><strong>Idef</strong></td><td>(A)</td></tr><tr><td><strong>Ifd</strong></td><td>(A)</td></tr><tr><td><strong>In</strong></td><td>(A)</td></tr><tr><td><strong>Iq</strong></td><td>(A)</td></tr><tr><td><strong>Pe</strong></td><td>Active power (pu/MVA)</td></tr><tr><td><strong>Pef</strong></td><td>Filtered measured electrical power (pu/MVA)</td></tr><tr><td><strong>Pm</strong></td><td>Turbine mechanical power (pu/MW)</td></tr><tr><td><strong>Qe</strong></td><td>Reactive power (pu/MVA)</td></tr><tr><td><strong>Te</strong></td><td>Electrical torque (pu/MW*s)</td></tr><tr><td><strong>Tm</strong></td><td>Mechanical torque (pu/MW*s)</td></tr><tr><td><strong>VPROBE(a,b,c)</strong></td><td></td></tr><tr><td><strong>Vstab</strong></td><td>Stabilizer output voltage (pu)</td></tr><tr><td><strong>Vt</strong></td><td>Terminal voltage (pu)</td></tr><tr><td><strong>Vtd</strong></td><td>D-axis terminal voltage (pu)</td></tr><tr><td><strong>Vtq</strong></td><td>Q-axis terminal voltage (pu)</td></tr><tr><td><strong>theta</strong></td><td></td></tr><tr><td><strong>w</strong></td><td>Angular speed (pu)</td></tr><tr><td><strong>x</strong></td><td>Gate opening (pu)</td></tr></tbody></table>


---

# 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-machines/synchronous-machine-w-fault.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.
