From 3eb600d541cbe40778ce93bc35c9d6ec85ff359b Mon Sep 17 00:00:00 2001 From: Coline PILOQUET Date: Mon, 25 Nov 2024 16:42:28 +0100 Subject: [PATCH] Add some documentation about voltage attribute of voltage ranges. Signed-off-by: Coline PILOQUET --- docs/simulation/shortcircuit/parameters.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/simulation/shortcircuit/parameters.md b/docs/simulation/shortcircuit/parameters.md index 6f53f70e9c4..0c312cd46ac 100644 --- a/docs/simulation/shortcircuit/parameters.md +++ b/docs/simulation/shortcircuit/parameters.md @@ -106,25 +106,31 @@ This property defines the voltage profile that should be used for the calculatio **voltage-ranges** This property specifies a path to a JSON file containing the voltage ranges and associated coefficients to be used when `initial-voltage-profile-mode` is set to `CONFIGURED`. -The JSON file must contain a list of voltage ranges and coefficients. Then, for each nominal voltage in the network that belongs to the range, the given coefficient is applied to calculate the voltage to be used -in the calculation. All the coefficients should be between 0.8 and 1.2. +The JSON file must contain a list of voltage ranges and for each range, coefficients and/or voltages. +Then, for each nominal voltage in the network that belongs to the range, the coefficient is applied to calculate the voltage to be used +in the calculation. All the coefficients should be between 0.8 and 1.2. They are optional, and if they are missing for a range, 1 will be used. +The voltage attribute of the voltage range defines the nominal voltage of all the voltage levels in the network that are in the range. +It is also optional, and if it is not defined, then the nominal voltage already in the network will be used. Here is an example of this JSON file: ````json [ { "minimumNominalVoltage": 350.0, "maximumNominalVoltage": 400.0, - "voltageRangeCoefficient": 1.1 + "voltageRangeCoefficient": 1.1, + "voltage": 380.0 }, { "minimumNominalVoltage": 215.0, "maximumNominalVoltage": 235.0, - "voltageRangeCoefficient": 1.2 + "voltageRangeCoefficient": 1.2, + "voltage": 225.0 }, { "minimumNominalVoltage": 80.0, "maximumNominalVoltage": 150.0, - "voltageRangeCoefficient": 1.05 + "voltageRangeCoefficient": 1.05, + "voltage": 105.0 } ] ````