From 4a79f7f95c4149935b0fa1d5f6a3c6050b1b342f Mon Sep 17 00:00:00 2001 From: Jan Dinkelbach Date: Wed, 22 Nov 2023 11:26:26 +0100 Subject: [PATCH] add docu on scaling of voltages and currents Signed-off-by: Jan Dinkelbach --- .../content/en/docs/Development/Guidelines.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/hugo/content/en/docs/Development/Guidelines.md b/docs/hugo/content/en/docs/Development/Guidelines.md index a2d3a20e1d..ecdcf238d5 100644 --- a/docs/hugo/content/en/docs/Development/Guidelines.md +++ b/docs/hugo/content/en/docs/Development/Guidelines.md @@ -5,6 +5,20 @@ linkTitle: "Guidelines" This is a summary of general guidelines for the development of DPsim. +## Scaling of Voltages and Currents + +Voltage quantities are expressed either as phase-to-phase RMS values (denominated as `RMS3PH`) or as phase-to-ground peak values (denominated as `PEAK1PH`): + +- Initialisation quantities (e.g. `initialSingleVoltage` of `SimPowerComp`) as `RMS3PH` values +- Simulation quantities in both `SP` and `DP` domain (e.g. `mIntfVoltage` of `DP::Ph1::PiLine`) as `RMS3PH values` +- Simulation quantities in the `EMT` domain (e.g. `mIntfVoltage` of `EMT::Ph3::Transformer`) as `PEAK1PH` values + +Current quantities are expressed either as `RMS` or as `PEAK` values: + +- Simulation quantities in both `SP` and `DP` domain (e.g. `mIntfCurrent` of `DP::Ph1::PiLine`) as `RMS` values +- Simulation quantities in the `EMT` domain (e.g. `mIntfCurrent` of `EMT::Ph3::Transformer`) as `PEAK` values + + ## Logging Debug or trace should be the default log level for information that might be nice to have but not necessary for every simulation case. @@ -23,4 +37,4 @@ A new version of DPsim has to be indicated as follows: - Update sonar-project.properties Due to the creation of a new tag, a new PyPi package will be deployed automatically. -To release an updated Docker image, the container workflow needs to be triggered manually. \ No newline at end of file +To release an updated Docker image, the container workflow needs to be triggered manually.