> 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/3.7/model-in-schematic-editor/library-blocks-reference/machines-blocks.md).

# Machines

## Machines features in detail

|                  | PMSM Open End Winding BLDC | PMSM Six Phase BLDC | PMSM Twelve Phase BLDC | PMSM VdQ/dQ BLDC | PMSM SH | Induction Machine | Synchronous Machine | EESM with saturation | Induction Machine with saturation |
| ---------------- | -------------------------- | ------------------- | ---------------------- | ---------------- | ------- | ----------------- | ------------------- | -------------------- | --------------------------------- |
| **Machine Type** | PMSM                       | PMSM                | PMSM                   | PMSM             | PMSM    | SCIM / DFIM       | RRSM / SPSM         | EESM                 | SCIM / DFIM                       |
| **RT-LAB**       | ✅                          | ✅                   | ✅                      | ✅                | ✅       | ✅                 | ✅                   | ✅                    | ✅                                 |
| **HYPERSIM**     | ✅                          | ✅                   | ✅                      | ✅                | ✅       | ✅                 | ✅                   | ❌                    | ✅                                 |
| **NI VeriStand** | ✅                          | ✅                   | ✅                      | ✅                | ✅       | ✅                 | ❌                   | ❌                    | ✅                                 |

### **FPGA Core properties**

|                              | PMSM Open End Winding BLDC    | PMSM Six Phase BLDC           | PMSM Twelve Phase BLDC        | PMSM VdQ/dQ BLDC      | PMSM SH              | Induction Machine        | Synchronous Machine      | EESM with saturation | Induction Machine with saturation |
| ---------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | --------------------- | -------------------- | ------------------------ | ------------------------ | -------------------- | --------------------------------- |
| **XSG library Core Name**    | <p>SixPhasePmsm<br>Solver</p> | <p>SixPhasePmsm<br>Solver</p> | <p>SixPhasePmsm<br>Solver</p> | Dual PMSM VDQ v2 Full | Dual PMSM SH v2 Full | Generic Machine Blackbox | Generic Machine Blackbox | EesmWithSatSolver    | Induction machine with Sat        |
| \*\*Minimum Time Step \*\*\* | 235ns                         | 235ns                         | 235ns                         | 120ns                 | 500ns                | 400ns                    | 400ns                    | 200ns                | 150ns                             |
| \*\*Granularity \*\*\*       | 5ns                           | 5ns                           | 5ns                           | 5ns                   | 50ns                 | 5ns                      | 5ns                      | 40ns                 | 5ns                               |
| **Clock frequency**          | 200Mhz                        | 200Mhz                        | 200Mhz                        | 200Mhz                | 200Mhz               | 200Mhz                   | 200Mhz                   | 200Mhz               | 200Mhz                            |
| \*\*Execution \*\*\*         | eHS Synchronized              | eHS Synchronized              | eHS Synchronized              | Standalone            | Standalone           | Standalone               | Standalone               | eHS Synchronized     | eHS Synchronized                  |

**Minimum Time Step**: Best Time Step achievable by the machine. In a complete circuit, the time step of the circuit will be a multiple of the granularity and be impacted by basic components (managed under eHS addon) and all the other addons (such as other machines)\
**Granularity**: Each machine has a minimum time granularity. The model time step will be a multiple of this value.\
**Execution:**\
**- Standalone**: The machine model time step is set independently from the eHS time step.\
**- eHS Synchronized**: The machine model time step is synchronized on the eHS time step.

### **Usability**

|                            | PMSM Open End Winding BLDC | PMSM Six Phase BLDC     | PMSM Twelve Phase BLDC  | PMSM VdQ/dQ BLDC        | PMSM SH                 | Induction Machine       | Synchronous Machine     | EESM with saturation | Induction Machine with saturation |
| -------------------------- | -------------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -------------------- | --------------------------------- |
| **eHS - Machine Coupling** | Automated with snubbers    | Automated with snubbers | Automated with snubbers | Automated with snubbers | Automated with snubbers | Automated with snubbers | Automated with snubbers | VBR Interface        | Automated with snubbers           |
| **AO assignment**          | From the block             | From the block          | From the block          | From the block          | From the block          | From the block          | From the block          | From the block       | From the block                    |

### **Machine topology**

|                                                                             | PMSM Open End Winding BLDC | PMSM Six Phase BLDC       | PMSM Twelve Phase BLDC   | PMSM VdQ/dQ BLDC | PMSM SH | Induction Machine | Synchronous Machine | EESM with saturation | Induction Machine with saturation |
| --------------------------------------------------------------------------- | -------------------------- | ------------------------- | ------------------------ | ---------------- | ------- | ----------------- | ------------------- | -------------------- | --------------------------------- |
| **3-Phase support**                                                         | ✅                          | 2x3 Phase Winding Sets    | 4x3 Phase Winding Sets   | ✅                | ✅       | ✅                 | ✅                   | ✅                    | ✅                                 |
| **3-phase Wye connection**                                                  | ✅                          | both winding sets are Wye | all winding sets are Wye | ✅                | ✅       | ✅                 | ✅                   | ✅                    | ✅                                 |
| **3-phase Delta connection**                                                | ✅                          | ❌                         | ❌                        | ❌                | ❌       | ❌                 | ❌                   | ❌                    | ❌                                 |
| <p><strong>BLDC support</strong><br><strong>(trapezoidal bemf)</strong></p> | ✅                          | ✅                         | ✅                        | ✅                | ✅       | N/A               | N/A                 | ❌                    | N/A                               |
| **Dual 3-phase support**                                                    | ✅                          | ❌                         | ❌                        | ❌                | ❌       | DFIM              | ❌                   | ❌                    | DFIM                              |
| **5-Phase support**                                                         | ❌                          | ❌                         | ❌                        | ❌                | ❌       | N/A               | N/A                 | ❌                    | N/A                               |
| **Open winding connection**                                                 | ✅                          | ❌                         | ❌                        | ❌                | ❌       | ❌                 | ❌                   | ❌                    | ❌                                 |
| **Access to neutral**                                                       | ✅                          | ❌                         | ❌                        | ❌                | ❌       | ❌                 | ✅                   | ❌                    | ❌                                 |

### **Electrical simulation features**

|                                     | PMSM Open End Winding BLDC | PMSM Six Phase BLDC | PMSM Twelve Phase BLDC | PMSM VdQ/dQ BLDC | PMSM SH  | Induction Machine | Synchronous Machine | EESM with saturation                  | Induction Machine with saturation |
| ----------------------------------- | -------------------------- | ------------------- | ---------------------- | ---------------- | -------- | ----------------- | ------------------- | ------------------------------------- | --------------------------------- |
| **Saturation vs current amplitude** | ❌<sup>\[1]</sup>           | ❌<sup>\[1]</sup>    | ❌                      | ✅                | ✅        | ❌                 | ❌                   | ✅                                     | ✅                                 |
| **Saturation Table size**           | N/A                        | N/A                 | N/A                    | 64x64            | 64x32x16 | N/A               | N/A                 | Flexible Nd x Nq x Nf, max = 131072   | 16 linear segment                 |
| **Spatial Harmonics**               | ❌                          | ❌                   | ❌                      | ❌                | ✅        | ❌                 | ❌                   | ❌                                     | ❌                                 |
| **Mutual between phase**            | ❌                          | ✅                   | ❌                      | ✅                | ✅        | ✅                 | ✅                   | ✅                                     | ✅                                 |
| **User defined back EMF**           | ❌<sup>\[1]</sup>           | ❌<sup>\[1]</sup>    | ❌                      | ✅                | ❌        | ❌                 | ❌                   | ❌                                     | ❌                                 |
| **Thermal variation**               | ❌                          | ❌                   | ❌                      | ❌                | ❌        | ❌                 | ❌                   | ❌                                     | ✅                                 |
| **Rs on the fly update**\*          | ❌<sup>\[1]</sup>           | ❌<sup>\[1]</sup>    | ❌<sup>\[1]</sup>       | ❌                | ❌        | ❌                 | ❌                   | Rf on the fly in custom mode          | ✅                                 |
| **Inductance on the fly update**\*  | ❌<sup>\[1]</sup>           | ❌<sup>\[1]</sup>    | ❌<sup>\[1]</sup>       | ❌                | ❌        | ❌                 | ❌                   | Lf on the fly in custom mode          | ✅                                 |
| **Flux PM on the fly update**\*     | ❌<sup>\[1]</sup>           | ❌<sup>\[1]</sup>    | ❌<sup>\[1]</sup>       | ❌                | ❌        | ❌                 | ❌                   | Psid & Psiq on the fly in custom mode | ❌                                 |

\[1] - Planned for a future release.\
**On the fly update**: parameters that could be changed during real time execution of the model. Otherwise these parameters must be set prior to model build and deployment to the real time target simulator.

### **Parameter import feature**

|                      | PMSM Open End Winding BLDC | PMSM Six Phase BLDC | PMSM Twelve Phase BLDC | PMSM VdQ/dQ BLDC | PMSM SH          | Induction Machine | Synchronous Machine | EESM with saturation | Induction Machine with saturation |
| -------------------- | -------------------------- | ------------------- | ---------------------- | ---------------- | ---------------- | ----------------- | ------------------- | -------------------- | --------------------------------- |
| **Matlab variable**  | non table values           | non table values    | non table values       | non table values | non table values | non table values  | non table values    | ✅                    | non table values                  |
| \*\*Json file \*\*\* | ❌<sup>\[1]</sup>           | ❌<sup>\[1]</sup>    | ❌                      | ✅                | ✅                | ❌                 | ❌                   | ✅                    | ✅                                 |
| \*\*Rtt file \*\*\*  | ❌                          | ❌                   | ❌                      | ❌                | ✅                | ❌                 | ❌                   | ❌                    | ❌                                 |

\[1] - Planned for a future release.\
**JSON file**: Format for Ansys Maxwell official import for PMSM Spatial Harmonics application. Also used in various model topologies for table parameter specification.\
**RTT file**: Format for JSON JMAG-RT official import for PMSM Spatial Harmonics.

### Import a JMAG or ANSYS file to configure PMSM block

**Permanent Magnet Synchronous Machine** blocks can be configured to simulate 3-Phase PMSM using advanced spatial harmonic analysis. The **JMAG-ANSYS File Converter** is used to convert ANSYS JSON format (v2), ANSYS txt format (v1 Legacy), or JMAG (.rtt) files containing PMSM SH electrical parameters into a format which is supported in the Schematic Editor.

{% hint style="danger" %}
The correct [**MATLAB Runtime engine**](https://www.opal-rt.com/docs/ehs/3.7/overview/requirements.md) must be installed to use this tool.
{% endhint %}

{% stepper %}
{% step %}

#### In the VeriStand System Definition

Browse to the **Circuit** section and click **JMAG-ANSYS File Converter** button to open the **PMSM SH File Converter** program.

Select an *Source File* and *Destination folder* and click **CONVERT**. The application will generate a .*pmsmsh* file in the selected *Destination folder*.
{% endstep %}

{% step %}

#### Open the Schematic Editor

Click on (or add) a **Permanent Magnet Synchronous Machine** block. In the *Parameters* tab, change the *Motor configuration type* to **Spatial Harmonics**.

Import the .pmsmsh file in the Motor Configuration parameter.

**Save** the schematic and **reload it** in the Circuit section.
{% endstep %}
{% endstepper %}

### **Mechanical model**

|                               | PMSM Open End Winding BLDC | PMSM Six Phase BLDC | PMSM Twelve Phase BLDC | PMSM VdQ/dQ BLDC | PMSM SH | Induction Machine | Synchronous Machine | EESM with saturation | Induction Machine with saturation |
| ----------------------------- | -------------------------- | ------------------- | ---------------------- | ---------------- | ------- | ----------------- | ------------------- | -------------------- | --------------------------------- |
| **Embedded mechanical model** | ✅                          | ✅                   | ✅                      | ✅                | ✅       | ✅                 | ✅                   | ✅                    | ✅                                 |
| **Initial speed**             | ✅                          | ✅                   | ✅                      | ✅                | ✅       | ✅                 | ✅                   | ✅                    | ✅                                 |
| **Initial angle**             | ✅                          | ✅                   | ✅                      | ✅                | ✅       | ✅                 | ✅                   | ✅                    | ✅                                 |
| **Static friction**           | ✅                          | ✅                   | ✅                      | ✅                | ✅       | ✅                 | ✅                   | ✅                    | ✅                                 |
| **Fluid friction**            | ✅                          | ✅                   | ✅                      | ✅                | ✅       | ✅                 | ✅                   | ✅                    | ✅                                 |
| **Inertia**                   | ✅                          | ✅                   | ✅                      | ✅                | ✅       | ✅                 | ✅                   | ✅                    | ✅                                 |
| **Torque ripple add**         | ❌                          | ❌                   | ❌                      | ❌                | ❌       | ❌                 | ❌                   | ❌                    | ❌                                 |
| **Theta force**               | ❌<sup>\[1]</sup>           | ❌<sup>\[1]</sup>    | ❌<sup>\[1]</sup>       | ❌                | ❌       | ❌                 | ❌                   | ❌                    | ❌                                 |

\[1] - Planned for a future release.

### **Sensor model**

|                                                          | PMSM Open End Winding BLDC | PMSM Six Phase BLDC | PMSM Twelve Phase BLDC | PMSM VdQ/dQ BLDC | PMSM SH | Induction Machine | Synchronous Machine | EESM with saturation | Induction Machine with saturation |
| -------------------------------------------------------- | -------------------------- | ------------------- | ---------------------- | ---------------- | ------- | ----------------- | ------------------- | -------------------- | --------------------------------- |
| **Embedded angle sensor model**                          | ✅                          | ✅                   | ✅                      | ✅                | ❌       | ✅                 | ✅                   | ✅                    | ✅                                 |
| **Synchro resolver**                                     | ✅                          | ✅                   | ✅                      | ✅                | ✅       | ✅                 | ✅                   | ✅                    | ✅                                 |
| **On the fly change of resolver parameters**\*           | ❌                          | ❌                   | ❌                      | ❌                | ✅       | ❌                 | ❌                   | ❌                    | ❌                                 |
| **Double Excitation resolver**                           | ❌                          | ❌                   | ❌                      | ✅                | ✅       | ❌                 | ❌                   | ❌                    | ❌                                 |
| **Quadrature encoder**                                   | ✅                          | ✅                   | ✅                      | ✅                | ✅       | ✅                 | ✅                   | ✅                    | ✅                                 |
| **On the fly change of quadrature encoder parameters**\* | ❌                          | ❌                   | ❌                      | ❌                | ✅       | ❌                 | ❌                   | ❌                    | ❌                                 |
| **Hall effect encoder**                                  | ✅                          | ✅                   | ✅                      | ✅                | ❌       | ❌                 | ❌                   | ❌                    | ❌                                 |

**On the fly update:** parameters that could be changed during real time execution of the model. Otherwise these parameters must be set prior to model build and deployment to the real time target simulator.

### **Monitoring feature**

|                               | PMSM Open End Winding BLDC | PMSM Six Phase BLDC | PMSM Twelve Phase BLDC |  PMSM VdQ/dQ BLDC |      PMSM SH      | Induction Machine | Synchronous Machine | EESM with saturation | Induction Machine with saturation |
| ----------------------------- | :------------------------: | :-----------------: | :--------------------: | :---------------: | :---------------: | :---------------: | :-----------------: | :------------------: | :-------------------------------: |
| **Power measurement**         |              ❌             |          ❌          |            ❌           |         ❌         |         ❌         |         ✅         |          ✅          |           ✅          |                 ✅                 |
| **Phase currents**            |              ✅             |          ✅          |            ✅           |         ✅         |         ✅         |         ✅         |          ✅          |           ✅          |                 ✅                 |
| **DQ domain currents**        |              ✅             |          ✅          |            ✅           |         ✅         |         ✅         |         ✅         |          ✅          |           ✅          |                 ✅                 |
| **Phase domain voltages**     |              ✅             |          ✅          |            ✅           | Low Pass filtered | Low Pass filtered | Low Pass filtered |  Low Pass filtered  |   Low Pass filtered  |                 ✅                 |
| **DQ domain voltages**        |              ❌             |          ❌          |            ❌           |         ❌         |         ❌         |         ✅         |          ✅          |           ✅          |                 ✅                 |
| **Back EMF induced voltages** |              ✅             |          ✅          |            ✅           |         ❌         |         ❌         |         ❌         |          ❌          |           ❌          |                 ❌                 |
| **DQ domain Flux**            |              ❌             |          ❌          |            ❌           |         ❌         |         ❌         |         ✅         |          ✅          |           ✅          |                 ✅                 |


---

# 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/3.7/model-in-schematic-editor/library-blocks-reference/machines-blocks.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.
