Skip to content

Commit

Permalink
add docu on scaling of voltages and currents
Browse files Browse the repository at this point in the history
Signed-off-by: Jan Dinkelbach <[email protected]>
  • Loading branch information
dinkelbachjan committed Nov 22, 2023
1 parent f2a0cee commit 4a79f7f
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion docs/hugo/content/en/docs/Development/Guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
To release an updated Docker image, the container workflow needs to be triggered manually.

0 comments on commit 4a79f7f

Please sign in to comment.