Skip to content

Commit

Permalink
Revert "Update documentation to new shunt API (#125)" (#128)
Browse files Browse the repository at this point in the history
This reverts commit c584079.

Signed-off-by: RALAMBOTIANA MIORA <miora.ralambotiana@rte-france.com>
  • Loading branch information
miovd committed Apr 23, 2020
1 parent b73c2b4 commit 8676d13
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 86 deletions.
50 changes: 11 additions & 39 deletions docs/iidm/model/shuntCompensator.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The `com.powsybl.iidm.network.ShuntCompensator` interface is used to model a shu

| Attribute | Type | Unit | Required | Default value | Description |
| --------- | ---- | ---- |-------- | ------------- | ----------- |
| Model | [`ShuntCompensatorModel`](shuntCompensatorModel.md) | - | yes | - | Model describing how susceptance and conductance are split amongst the shunt compensator's sections |
| bPerSection | double | S | yes | - | The Positive sequence shunt (charging) susceptance per section |
| MaximumSectionCount| integer | int | yes | - | The maximum number of sections that may be switched on |
| CurrentSectionCount | integer | int | yes | - | The current number of section that may be switched on |
| RegulatingTerminal | [`Terminal`](terminal.md) | - | no | The shunt compensator's terminal | The terminal used for regulation |
Expand All @@ -19,21 +19,18 @@ The `com.powsybl.iidm.network.ShuntCompensator` interface is used to model a shu

## Section
A section of a shunt compensator is an individual capacitor or reactor.
A specified susceptance and conductance are linked to each section of the shunt compensator.

## Model
There are two possible shunt compensator's models: linear and non linear. The attribute `model` describes the characteristics of the shunt compensator's distribution of susceptance
and conductance amongst its sections. Depending on these characteristics, the shunt compensator could be a capacitor or a reactor.
To know more, go to the documentation page of the [Shunt compensator's models](shuntCompensatorModel.md).
A value of bPerSection positive means it is modeling a capacitor, an equipment that injects reactive
power into the bus.
A value of bPerSection negative means a reactor, an equipment that can absorb excess reactive power
from the network.

## Current Section Count
The current section count is the index of the section to which the shunt compensator is currently pointing.
It is expected to be greater than or equal to zero and lesser than or equal to the maximum section count.
The current section count is expected to be greater than one and lesser or equal to the maximum section count.

## Regulation
Regulation for shunt compensators does not necessarily model automation, it can represent human actions on the network
i.e. an operator activating a shunt compensator, deactivating a shunt compensator or changing the current section of a shunt compensator.
However, it can of course be integrated on a power flow calculation or not, depending of what is wanted to be shown.
e.g. an operator activating or deactivating a shunt compensator). However, it can of course be integrated on a power flow
calculation or not, depending of what is wanted to be shown.

# Flow sign convention
Shunt compensators follow a load sign convention:
Expand All @@ -44,39 +41,14 @@ In case of a capacitor, the value for its Q will be negative.
In case of a reactor, the value for its Q will be positive.

# Examples
This example shows how to create a new linear `ShuntCompensator` in the network:
```java
ShuntCompensator shunt = network.getVoltageLevel("VL").newShunt()
.setId("SHUNT")
.setBus("BUS1")
.setConnectableBus("BUS1")
.setCurrentSectionCount(6)
.newLinearModel()
.setbPerSection(5.0)
.setgPerSection(2.0)
.setMaximumSectionCount(10)
.add()
.add();
```

This example shows how to create a new non-linear `ShuntCompensator` in the network:
This example shows how to create a new `ShuntCompensator` in the network:
```java
ShuntCompensator shunt = network.getVoltageLevel("VL").newShunt()
.setId("SHUNT")
.setBus("BUS1")
.setConnectableBus("BUS1")
.setbPerSection(5.0)
.setCurrentSectionCount(6)
.newNonLinearModel()
.beginSection()
.setSectionNumber(0)
.setB(5.0)
.setG(2.0)
.endSection()
.beginSection()
.setSectionNumber(1)
.setB(4.0)
.setG(1.0)
.endSection()
.add()
.setMaximumSectionCount(10)
.add();
```
47 changes: 0 additions & 47 deletions docs/iidm/model/shuntCompensatorModel.md

This file was deleted.

0 comments on commit 8676d13

Please sign in to comment.