> 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-thermal.md).

# Synchronous Machine (Thermal)

## Description

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

The **Thermal Synchronous Machine** block, located in the **Network Machines** library, models a thermal turbine generator ....

<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-7f2d2d16aceb9260d380390f39409778de95aeb6%2Fimage%20(333).png?alt=media" alt=""><figcaption><p><strong>Saturation 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-c6d9e1de49423732f46f6e8ff0651d04ff09835d%2Fjfx9433778970726838401.png?alt=media" alt=""><figcaption><p>Speed regulator 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-9b5669c82c7f9a87010744771cd859f42aeba0c3%2Fjfx1225353270310183643.jpg?alt=media" alt=""><figcaption><p>Steam 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-e23ac369fe2768749d54b6874247857313e79bdd%2Fjfx9385350541467150823.jpg?alt=media" alt=""><figcaption><p>Boiler 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-e22aabb0a6004c83f82b799e443125b8ebde9a95%2Fjfx10713516279046596446.png?alt=media" alt=""><figcaption><p>Mass model diagram</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-5bb0e778089cdf5f81f02cde3131235189bc560a%2Fi.jpg?alt=media" alt=""><figcaption></figcaption></figure>

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

<table><thead><tr><th width="230">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 Generator" %}

<table><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>Saturation</strong></td><td>Enable or disable saturation (On/Off).</td></tr><tr><td><strong>EU</strong></td><td>Voltage upper saturation limit (pu)</td></tr><tr><td><strong>EL</strong></td><td>Voltage lower saturation limit (pu)</td></tr><tr><td><strong>SGU</strong></td><td>Saturation coefficient (upper).</td></tr><tr><td><strong>SGL</strong></td><td>Saturation coefficient (lower).</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><thead><tr><th width="230">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><thead><tr><th width="230">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/valve 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/valve 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/valve opening time constant 1 (s).</td></tr><tr><td><strong>Tw2</strong></td><td>Gate/valve 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><thead><tr><th width="230">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Modeling of speed regulator</strong></td><td>Select internal or external (input pins) model.</td></tr><tr><td><strong>r</strong></td><td>(pu).</td></tr><tr><td><strong>ahlim</strong></td><td>(pu).</td></tr><tr><td><strong>pah1</strong></td><td>(pu).</td></tr><tr><td><strong>pah2</strong></td><td>(pu).</td></tr><tr><td><strong>db</strong></td><td>(pu).</td></tr><tr><td><strong>k1</strong></td><td>(pu).</td></tr><tr><td><strong>t1</strong></td><td>(s).</td></tr><tr><td><strong>t2</strong></td><td>(s).</td></tr></tbody></table>
{% endtab %}

{% tab title="Turbine / speed / boiler" %}

<table><thead><tr><th width="242">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Steam turbine</strong></td><td>Enable or disable the steam turbine (On/Off).</td></tr><tr><td><strong>Modeling of steam turbine</strong></td><td>Select internal or external (input pins) model.</td></tr><tr><td><strong>sw1</strong></td><td></td></tr><tr><td><strong>Tr1</strong></td><td>(s)</td></tr><tr><td><strong>TR2</strong></td><td>(s)</td></tr><tr><td><strong>fh</strong></td><td>(pu)</td></tr><tr><td><strong>fi</strong></td><td>(pu)</td></tr><tr><td><strong>fl</strong></td><td>(pu)</td></tr><tr><td><strong>ai</strong></td><td>(pu)</td></tr><tr><td><strong>al</strong></td><td>(pu)</td></tr><tr><td><strong>t3</strong></td><td>(s)</td></tr><tr><td><strong>t4</strong></td><td>(s)</td></tr><tr><td>t5</td><td>(s)</td></tr><tr><td>t6</td><td>(s)</td></tr><tr><td><strong>t7</strong></td><td>(s)</td></tr><tr><td><strong>t11</strong></td><td>(s)</td></tr><tr><td><strong>t12</strong></td><td>(s)</td></tr><tr><td><strong>Boiler</strong></td><td>Enable or disable the boiler (On/Off).</td></tr><tr><td><strong>Modeling of boiler</strong></td><td>Select internal or external (input pins) model.</td></tr><tr><td><strong>k2</strong></td><td>(pu)</td></tr><tr><td><strong>k3</strong></td><td>(pu)</td></tr><tr><td><strong>k4</strong></td><td>(pu)</td></tr><tr><td><strong>ki</strong></td><td>(pu)</td></tr><tr><td><strong>kpc</strong></td><td>(pu)</td></tr><tr><td><strong>bmax</strong></td><td>(pu)</td></tr><tr><td><strong>press</strong></td><td>(pu)</td></tr><tr><td><strong>td</strong></td><td>(s)</td></tr><tr><td><strong>t8</strong></td><td>(s)</td></tr><tr><td><strong>t9</strong></td><td>(s)</td></tr></tbody></table>
{% endtab %}

{% tab title="Multi-mass & Shaft" %}

<table><thead><tr><th width="230">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Shaft</strong></td><td>Enable or disable the shaft (On/Off).</td></tr><tr><td><strong>Modelling of shaft</strong></td><td>Select internal or external (input pins) shaft model.</td></tr><tr><td><strong>tgo</strong></td><td>Torque of mechanical losses of the shaft (pu/MW·s).</td></tr><tr><td><strong>Number of masses</strong></td><td>Number of masses (1, 5 or 10)</td></tr><tr><td><strong>d1 Start</strong></td><td>(pu)</td></tr><tr><td><strong>Generator mass number</strong></td><td></td></tr><tr><td><strong>tStart</strong></td><td>Duration of turbine start-up (s).</td></tr><tr><td><strong>Low pressure masses number</strong></td><td></td></tr><tr><td><strong>Intermediate pressure masses number</strong></td><td></td></tr><tr><td><strong>wmin</strong></td><td>(pu)</td></tr><tr><td><strong>wmax</strong></td><td>(pu)</td></tr><tr><td><strong>h1, h2, ... h7</strong></td><td>(s)</td></tr><tr><td><strong>d1, d2, ..., d7</strong></td><td>(pu)</td></tr><tr><td><strong>k12, k23, .., k78</strong></td><td>(pu/rad)</td></tr><tr><td><strong>d12, d23, ..., d78</strong></td><td>(pu)</td></tr></tbody></table>
{% endtab %}

{% tab title="Load flow" %}

<table><thead><tr><th width="230">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><tr><td><strong>Reactive power</strong></td><td>Reactive power (Mvar).</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

## Conserving ports

<table><thead><tr><th width="235">Port</th><th>Description</th></tr></thead><tbody><tr><td><strong>Net</strong></td><td></td></tr></tbody></table>

## Inputs

<table><thead><tr><th width="230">Input</th><th>Description</th></tr></thead><tbody><tr><td><strong>Efd_i</strong></td><td></td></tr><tr><td><strong>Ti_i</strong></td><td></td></tr><tr><td><strong>TI_i</strong></td><td></td></tr><tr><td><strong>Vstab_i</strong></td><td></td></tr><tr><td><strong>mhuh_i</strong></td><td></td></tr><tr><td><strong>psih_i</strong></td><td></td></tr><tr><td><strong>w_i</strong></td><td></td></tr><tr><td><strong>x_i</strong></td><td></td></tr></tbody></table>

## Outputs

This block has no outputs.

## 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="230">Signal</th><th>Description</th></tr></thead><tbody><tr><td><strong>Bk_cmd</strong></td><td></td></tr><tr><td><strong>Ed</strong></td><td>D-axis voltage in front of an external reactance (Xext) (pu).</td></tr><tr><td><strong>Edreg</strong></td><td>D-axis field voltage (pu).</td></tr><tr><td><strong>Efd</strong></td><td></td></tr><tr><td><strong>Eq</strong></td><td>Q-axis voltage in front of an external reactance (Xext) (pu).</td></tr><tr><td><strong>Eqreg</strong></td><td>Q-axis field voltage (pu).</td></tr><tr><td><strong>IPROBE (a,b,c)</strong></td><td>(A)</td></tr><tr><td><strong>Ia</strong></td><td>Generator phase A current (A).</td></tr><tr><td><strong>Ib</strong></td><td>Generator phase B current (A).</td></tr><tr><td><strong>Ic</strong></td><td>Generator phase C current (A).</td></tr><tr><td><strong>Id</strong></td><td>D-axis current (pu).</td></tr><tr><td><strong>Ifd</strong></td><td>Field current (pu).</td></tr><tr><td><strong>lq</strong></td><td>(pu)</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>T12, T23, T910</strong></td><td>(pu/MW·s).</td></tr><tr><td><strong>Te</strong></td><td>Electrical torque (pu/MW·s).</td></tr><tr><td><strong>Th</strong></td><td>(pu/MW·s).</td></tr><tr><td><strong>Ti</strong></td><td>(pu/MW·s).</td></tr><tr><td><strong>VPROBE(a,b,c)</strong></td><td>(v)</td></tr><tr><td><strong>Va</strong></td><td>Power system phase A voltage (V).</td></tr><tr><td><strong>Vb</strong></td><td>Power system phase B voltage (V).</td></tr><tr><td><strong>Vc</strong></td><td>Power system phase C voltage (V).</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>mhuh</strong></td><td>(pu)</td></tr><tr><td><strong>psih</strong></td><td>(pu)</td></tr><tr><td><strong>w</strong></td><td>Angular speed (pu).</td></tr><tr><td><strong>w2, w3, ..w10</strong></td><td>(pu)</td></tr><tr><td><strong>x</strong></td><td>Gate/valve 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-thermal.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.
