> 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/model-and-simulation/optimize-the-model/use-parameter-generators/z-based-transformer-parameters.md).

# \[Z]-Based Transformer Parameters

## Overview

In HYPERSIM, transformers with internal fault modeling (**inductance-matrix** type) are typically represented using resistance and inductance parameters, including **self** and **mutual inductances**. In practice, these parameters are often unavailable to users, who instead have access only to **open-circuit** and **short-circuit test data**. To address this, the **Transformer Data** tab automatically calculates the required resistance (R) and inductance (L) values from the provided test data.

To access the **\[Z]-Based Transformer Data** tool, your design must include a **Z-based transformer**. Open the transformer's **Parameter Form** by either double-clicking the component or right-clicking it and selecting **Open Parameter Form**, then navigate to the **Transformer Data** tab.

The following transformer blocks support this feature:

* [2-Winding Impedance-Matrix-Based Transformer](https://www.opal-rt.com/docs/hypersim/library-blocks-reference/network-transformers/2-winding-3-phase-linear-transformer.md)
* [2-Winding Impedance-Matrix-Based Transformer with Internal Fault](https://www.opal-rt.com/docs/hypersim/library-blocks-reference/network-transformers/2-winding-impedance-matrix-based-transformer-with-internal-fault.md)
* [3-Winding Impedance-Matrix-Based Transformer](https://www.opal-rt.com/docs/hypersim/library-blocks-reference/network-transformers/3-winding-impedance-matrix-based-transformer.md)
* [3-Winding Impedance-Matrix-Based Transformer with Internal Fault](https://www.opal-rt.com/docs/hypersim/library-blocks-reference/network-transformers/3-winding-impedance-matrix-based-transformer-with-internal-fault.md)

### Required variables

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-a08ac35e9a69b1bb26059f1eb95ac89c7e9c71cd%2FZ-based-transformer--data-parameter.png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

<table data-search="false"><thead><tr><th width="199.77777099609375">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Frequency</strong></td><td>Specify the frequency in hertz (Hz) to be used</td></tr><tr><td><strong>Units</strong></td><td>In the pull-down menu, select “SI” of “PU”</td></tr><tr><td><strong>Zero sequence data available</strong></td><td><p>Checkbox if the zero sequence data is available</p><ul><li><strong>Checkbox enabled</strong>:</li><li><strong>Checkbox disabled</strong>:</li></ul></td></tr><tr><td><strong>Zero sequence X12 measured with winding 3 delta connected</strong></td><td>Checkbox if the available zero-sequence short circuit tests measurement of winding 3 is connected in Delta.</td></tr><tr><td><strong>Nominal power (VA)</strong></td><td>Specify the nominal power of the transformer in volt-amperes (VA)</td></tr><tr><td><strong>Number of windings</strong></td><td></td></tr><tr><td><strong>Winding 1 voltage (V)</strong></td><td></td></tr><tr><td><strong>Winding 2 voltage (V)</strong></td><td></td></tr><tr><td><strong>Winding 1 resistance (PU)</strong></td><td></td></tr><tr><td><strong>Winding 2 resistance (PU)</strong></td><td></td></tr><tr><td><strong>Excitation current positive sequence (%)</strong></td><td></td></tr><tr><td><strong>No load losses positive sequence (W)</strong></td><td></td></tr><tr><td><strong>Short circuit reactance positive sequence (PU)</strong></td><td></td></tr><tr><td><strong>Excitation current zero-sequence</strong></td><td></td></tr><tr><td><strong>No load losses zero sequence (W)</strong></td><td></td></tr><tr><td><strong>Short circuit reactance zero sequence (PU)</strong></td><td></td></tr></tbody></table>

### Toolbox icons

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-ff78865266675227349d0eff705f1d681d109ab8%2FZ-based-transformer-data-menu.png?alt=media" alt=""><figcaption></figcaption></figure>

<table><thead><tr><th width="200.33331298828125">Button</th><th>Description</th></tr></thead><tbody><tr><td><strong>Compute</strong></td><td>Compute the transformer data, the results are shown in the Log tab.</td></tr><tr><td><strong>Revert</strong></td><td>Revert to default transformer data</td></tr><tr><td><strong>Open</strong></td><td>Load your transformer model *.htd (hypertransfo data file)</td></tr><tr><td><strong>Save</strong></td><td>Saves your transformer data in a new *.htd (hypertransfo data file) file that contains the information of the model</td></tr></tbody></table>

## Generate Transformer Parameters <a href="#how-to-generate-transformer-parameters" id="how-to-generate-transformer-parameters"></a>

Once all the required information has been collected, ensure that a **\[Z]-Based Transformer** is present in the design.

1. Open the transformer's **Parameter Form** by double-clicking the component, then navigate to the **Transformer Data** tab.
2. In the **Units** field, select the desired unit system from the drop-down list (**PU** or **SI**). Ensure that all entered data are consistent with the selected unit system.
3. Enter all required transformer data provided by the manufacturer.
4. Click the **Compute Transformer Parameters** button to generate the transformer parameters, the log tab is displayed.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-d585670f29f5d742d621f64f5add31b8cbe7ccef%2FZ-based-transformer-log-data.png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

5. Click **Load Parameters** to transfer the computed parameters to the transformer model in HYPERSIM. The loaded values can be verified by comparing the results shown in the **Log** tab with the transformer parameters displayed in the block's **General** tab.


---

# 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/model-and-simulation/optimize-the-model/use-parameter-generators/z-based-transformer-parameters.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.
