> 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-loads/harmonic-load.md).

# Harmonic Load

## Description

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

The **Harmonic Load** block, located in the **Network Loads library**, represents industrial loads with high harmonic content and optional random power variations. It combines three elements: a dynamic load, a random load, and a harmonic current source.

### The load model

For details on the dynamic load behavior, see [Dynamic Load](https://www.opal-rt.com/docs/hypersim/library-blocks-reference/network-loads/dynamic-load.md).

The two main differences between the dynamic and the harmonic loads are the following:

1. A programmable random variation part can be added to the P1 and Q1 power components provided by the internal source.
2. The same load calculates a percentage of harmonics based on the fundamental and can then re-inject these harmonics as current.

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

## Mask parameters

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

| Parameter                   | Description                                                                                                                                                                                                                                                                                                                         |
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Description**             | Use this field to add information about the component.                                                                                                                                                                                                                                                                              |
| **Dynamic load status**     | If Enable, the load is ON; if Disable, the load is OFF.                                                                                                                                                                                                                                                                             |
| **Measuring filter status** | If Enable, the measuring filter is ON; if Disable, it is OFF. The measuring filter is a second‑order Butterworth filter applied to the Vd and Vq components extracted from the positive-sequence voltage input.                                                                                                                     |
| **External control**        | <p>Select the mode :</p><ul><li>Internal: Use the internal algorithm.</li><li>External P and Q: Inputs P\_i and Q\_i are used to control P and Q in the load equations.</li><li>External P<sub>0</sub> and Q<sub>0:</sub> Inputs P\_i and Q\_i are used to control P<sub>0</sub> and Q<sub>0</sub> in the load equations.</li></ul> |
| **Base power (total)**      | Base value for per-unit conversion (MVA).                                                                                                                                                                                                                                                                                           |
| **Base voltage (rmsLL)**    | Base value for per-unit conversion (kV).                                                                                                                                                                                                                                                                                            |
| **Base frequency**          | Base value for per-unit conversion (Hz).                                                                                                                                                                                                                                                                                            |
| **V**<sub>**min**</sub>     | Voltage threshold below which the load behaves as a constant impedance (pu).                                                                                                                                                                                                                                                        |
| **U**<sub>**0**</sub>       | Nominal voltage relative to the base voltage (pu).                                                                                                                                                                                                                                                                                  |
| **P**<sub>**0**</sub>       | Nominal active power at U<sub>0</sub> (MW).                                                                                                                                                                                                                                                                                         |
| **Q**<sub>**0**</sub>       | Nominal reactive power at U<sub>0</sub> (Mvar).                                                                                                                                                                                                                                                                                     |
| **R**<sub>**s**</sub>       | Series resistance (ohm).                                                                                                                                                                                                                                                                                                            |
| **L**<sub>**s**</sub>       | Series inductance (H).                                                                                                                                                                                                                                                                                                              |
| **R**<sub>**p**</sub>       | Shunt resistance (ohm).                                                                                                                                                                                                                                                                                                             |
| **L**<sub>**p**</sub>       | Shunt inductance (H).                                                                                                                                                                                                                                                                                                               |
| **C**<sub>**p**</sub>       | Shunt capacitance (F).                                                                                                                                                                                                                                                                                                              |
| **n**<sub>**p**</sub>       | Active power variation coefficient as a function of voltage.                                                                                                                                                                                                                                                                        |
| **n**<sub>**q**</sub>       | Reactive power variation coefficient as a function of voltage.                                                                                                                                                                                                                                                                      |
| **k**<sub>**p**</sub>       | Active power variation coefficient as a function of frequency.                                                                                                                                                                                                                                                                      |
| **T**<sub>**p1**</sub>      | Time constant used to calculate the active power of the load.                                                                                                                                                                                                                                                                       |
| **T**<sub>**p2**</sub>      | Time constant used to calculate the active power of the load.                                                                                                                                                                                                                                                                       |
| **T**<sub>**q1**</sub>      | Time constant used to calculate the reactive power of the load.                                                                                                                                                                                                                                                                     |
| **T**<sub>**q2**</sub>      | Time constant used to calculate the reactive power of the load.                                                                                                                                                                                                                                                                     |
| {% endtab %}                |                                                                                                                                                                                                                                                                                                                                     |

{% tab title="Random" %}

| Parameter              | Description                                                                                                |
| ---------------------- | ---------------------------------------------------------------------------------------------------------- |
| **Seed for P0 and Q0** | Seed for the random generation of P0 and Q0.                                                               |
| **Seed for T**         | Seed for the random generation of each interval.                                                           |
| **Tmin**               | Minimum time interval between two changes of P0 and Q0. The distribution is uniform between Tmin and Tmax. |
| **Tmax**               | Maximum time interval between two changes of P0 and Q0. The distribution is uniform between Tmin and Tmax. |
| **P0 distribution**    | Distribution type for P0 (Uniform / Gaussian).                                                             |
| **P0min**              | For Uniform distribution: minimum value of P0 (MW).                                                        |
| **P0max**              | For Uniform distribution: maximum value of P0 (MW).                                                        |
| **P0avg**              | For Gaussian distribution: average value of P0 (MW).                                                       |
| **P0var**              | For Gaussian distribution: variance of P0 (MW).                                                            |
| **Q0 distribution**    | Distribution type for Q0 (Uniform / Gaussian).                                                             |
| **Q0min**              | For Uniform distribution: minimum value of Q0 (Mvar).                                                      |
| **Q0max**              | For Uniform distribution: maximum value of Q0 (Mvar).                                                      |
| **Q0avg**              | For Gaussian distribution: average value of Q0 (Mvar).                                                     |
| **Q0var**              | For Gaussian distribution: variance of Q0 (Mvar).                                                          |
| {% endtab %}           |                                                                                                            |

{% tab title="Harmonic" %}

| Parameter                                               | Description                                                                  |
| ------------------------------------------------------- | ---------------------------------------------------------------------------- |
| **Harmonic numbers**                                    | Harmonic orders to inject as current.                                        |
| **Harmonic current amplitudes relative to fundamental** | Current amplitude for each harmonic (% of the fundamental current).          |
| **Harmonic current phases relative to fundamental**     | Current phase for each harmonic (degrees relative to the fundamental phase). |
| {% endtab %}                                            |                                                                              |
| {% endtabs %}                                           |                                                                              |

## Conserving ports

| Parameter  | Description                                            |
| ---------- | ------------------------------------------------------ |
| **Net\_1** | Network connection (supports only 3-phase connections) |

## Inputs

This block has no inputs.

## 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.

| Signal            | Description                                                                                                            |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------- |
| **E(a,b,c)**      | Output voltage of the dynamic load (V).                                                                                |
| **Ed**            | Direct (D) axis output voltage (pu).                                                                                   |
| **Eq**            | Quadrature (Q) axis output voltage (pu).                                                                               |
| **Frequency**     | Network frequency (Hz).                                                                                                |
| **FundAng\_a**    | Angle value of the fundamental current of the load for phase A (degrees)                                               |
| **Harmo**         | (deg)                                                                                                                  |
| **I(a,b,c)**      | Dynamic load current (A).                                                                                              |
| **I(a,b,c)Fund**  | Value of the current of the fundamental (A)                                                                            |
| **I(a,b,c)Harm**  | Harmonic current to be injected by the current source only (A)                                                         |
| **I(a,b,c)Total** | Total current of the harmonic load; includes the dynamic and random parts along with the injected harmonic current (A) |
| **P**             | Total active power of the load (pu).                                                                                   |
| **Pcomp**         | Compensating active power from the internal voltage source (pu).                                                       |
| **Period**        | Inverse of the frequency (s).                                                                                          |
| **Q**             | Total reactive power of the load (pu).                                                                                 |
| **Qcomp**         | Compensating reactive power from the internal voltage source (pu).                                                     |
| **V(a,b,c)**      | Value of the internal voltage of the source allowing to inject the desired power (V)                                   |
| **Vd**            | Direct (D) axis voltage (pu).                                                                                          |
| **Vq**            | Quadrature (Q) axis voltage (pu).                                                                                      |
| **Vrms**          | Average value of the positive-sequence voltage (pu).                                                                   |


---

# 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-loads/harmonic-load.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.
