ElmRes attributesPowerFactory Results
Every attribute of the PowerFactory Results (ElmRes): 59 input parameters and 9 result variables, with units and meaning. Copy a name into GetAttribute or SetAttribute.
What ElmRes is
A results object: it stores the variables recorded during a calculation or simulation (chosen with IntMon objects), one column per variable and one row per time step or case.
- Class
ElmRes, element class- PowerFactory name
- Results
- Attributes
- 59 input parameters and 9 result variables, in 3 calculations
Read and write ElmRes in Python
import powerfactory
app = powerfactory.GetApplication() # GetApplicationExt() from outside PowerFactory
case = app.GetActiveStudyCase() # a study case with a simulation set up
inc, sim = app.GetFromStudyCase("ComInc"), app.GetFromStudyCase("ComSim")
bus = app.GetCalcRelevantObjects("*.ElmTerm")[0]
res = case.CreateObject("ElmRes", "My results") # a results object of your own
res.AddVariable(bus, "m:fehz") # what to record: the busbar frequency
inc.SetAttribute("p_resvar", res) # the simulation writes to it
inc.Execute()
sim.Execute()
res.Load()
col = res.FindColumn(bus, "m:fehz") # -1 when it was not recorded
rows = range(res.GetNumberOfRows())
t = [res.GetValue(row, -1)[1] for row in rows] # column -1 is the time, s
f = [res.GetValue(row, col)[1] for row in rows]
res.Release()- An input parameter is read and written with or without its
e:prefix:GetAttribute("outserv")andGetAttribute("e:outserv")give the same value. - RMS and EMT variables change over time: record them in a results object (
ElmRes) to read the whole curve.GetAttributeafter a run gives the value at the last time step.
- Input parameters59
- RMS simulation results3
- EMT simulation results3
- Modal analysis results3
- Basic data232
ElmRes input parameters
The element data, as typed in GetAttribute and SetAttribute (the e: prefix is optional). Setting one changes the model.
| Attribute | Unit | Description |
|---|---|---|
loc_name | · | Name |
FileType | · | File type |
calTp | · | Default for |
calTpSub | · | Method |
calTpTop | · | Usage |
cab_meth | · | Method |
host_meth | · | Method |
df_meth | · | Method |
powpark_meth | · | Method |
powpark_sub | · | Sub-result |
dbCalculationRunId | · | Calculation Run |
trg_pre | s | Pre- |
trg_post | s | Post- |
trg_pmax | s | Max. |
monitorStep | s | Sample period |
cnttime | · | Study time |
desc | · | Description |
cases | · | Cases |
header | · | Headlines |
dbOdbcSettings | · | Database settingsObject: SetDatabase |
cFilename | · | File name |
cnumcont | · | Number of contingencies |
ctimeph | · | Number of time phases |
ctricnt | · | Points of time |
cnumrow | · | Number of rows |
ctotrow | · | Total number of rows |
cnumHmOd | · | Number of Harmonic Orders |
cnumCase | · | Number of cases |
cnumFrq | · | Number of frequencies |
cnumEigen | · | Number of eigenvalues |
cnumFFT | · | Number of harmonic orders |
fileSize | · | File size |
cnumfiles | · | Number of result files |
csteps | · | Average step size |
cFFTstep | · | Step size |
avgStep | · | Average step size |
unit | · | Unit |
cLdfMethod | · | Load Flow method |
cPosStep | · | Average position step size |
cvars | · | Number of variables |
cFlowNum | · | Number of flowgates |
cOpScenNum | · | Number of operation scenarios |
cAllRegNum | · | Number of transactions |
calTpSwp | · | Method |
calTpShc | · | Fault Type |
calTpSto | · | Method |
calTpStoCom | · | Command |
calTpStoLdfMethod | · | Load Flow method |
calTpHrmMethod | · | Load Flow method |
calTpFlowDecomp | · | Method |
calTpStoOpfMethod | · | Optimisation method |
calTpStoSimMethod | · | Simulation type |
cContingency | · | Contingency |
cFnom | Hz | Nominal Frequency |
cOrigCurve | · | Analysed curve |
cStudyBus | · | Study Bus |
cActivePower | · | Active Power |
calTpCoord | · | Usage |
monitorFreq | Hz | Frequency |
ElmRes rms simulation results
Read after ComInc (RMS) with GetAttribute. c: calculation parameter, s: signal (state or model variable).
| Attribute | Unit | Description |
|---|---|---|
c:ready | · | Ready-Signal |
c:monitorFreq | Hz | Time between recordings |
s:writeTime | · | Write Time |
ElmRes emt simulation results
Read after ComInc (EMT) with GetAttribute. c: calculation parameter, s: signal (state or model variable).
| Attribute | Unit | Description |
|---|---|---|
c:ready | · | Ready-Signal |
c:monitorFreq | Hz | Time between recordings |
s:writeTime | · | Write Time |
ElmRes modal analysis results
Read after ComMod with GetAttribute. c: calculation parameter, s: signal (state or model variable).
| Attribute | Unit | Description |
|---|---|---|
c:ready | · | Ready-Signal |
c:monitorFreq | Hz | Time between recordings |
s:writeTime | · | Write Time |
ElmRes basic data
b: values are worked out from the input data. Read them; they are not set.
| Attribute | Unit | Description |
|---|---|---|
b:loc_name | · | Name |
b:i_obj | · | Object index |
b:violation | · | Restoration with violations |
b:nrActions | · | Number of switching actions |
b:interruptedPower | MW | Interrupted power |
b:restoredPower | MW | Restored power |
b:interruptedCust | · | Interrupted customers |
b:restoredCust | · | Restored customers |
b:eigno | · | Mode index |
b:eigvalr | 1/s | Mode, Real Part |
b:eigvali | rad/s | Mode, Imaginary Part |
b:sigma | 1/s | Damping |
b:Tp | s | Period |
b:ratio | · | Ratio |
b:frequ | Hz | Frequency |
b:index | · | Index |
b:feeder | · | Total Hosting Feeder(s) |
b:node | · | Total Hosting Node(s) |
b:iconn | · | Connection type |
b:pmax | MW | Max. hosting power |
b:pmin | MW | Min. hosting power |
b:pavg | MW | Average hosting power |
b:eval | · | Evaluation |
b:iter | · | Iteration |
b:failedCalc | · | Failed calculation |
b:objectiveValue | · | Objective function value |
b:iterBestObjective | · | Iteration with best objective value |
b:evalBestObjective | · | Evaluation with best objective value |
b:bestObjective | · | Best objective function value |
b:tnow | s | Time |
b:treal | · | Realtime |
b:isOptimalLoc | · | Detected as optimal location for a recloser |
b:contrBeforeEns | MWh/a | Contribution to ENS without reclosing functionality |
b:contrAfterEns | MWh/a | Contributions to ENS with reclosing functionality |
b:contrBeforeEic | USD/a | Contribution to EIC without reclosing functionality |
b:contrAfterEic | USD/a | Contributions to EIC with reclosing functionality |
b:contrBeforeSaidi | h/Ca | Contribution to SAIDI without reclosing functionality |
b:contrAfterSaidi | h/Ca | Contributions to SAIDI with reclosing functionality |
b:contrBeforeMaifi | 1/Ca | Contribution to MAIFI without reclosing functionality |
b:contrAfterMaifi | 1/Ca | Contributions to MAIFI with reclosing functionality |
b:calcmethod | · | Calculation method |
b:calctype | · | Calculation type |
b:calcres | · | Calculation result |
b:optemp | degC | Operating temperature |
b:wspeed | m/s | Wind speed |
b:prob | % | Probability |
b:cprob | % | Cumulative probability |
b:currency | · | Currency |
b:objid | · | Object ID |
b:olobjid | · | Overloaded object ID |
b:pnom | MW | Rated power |
b:pinst | MW | Installed power |
b:scaleA | m/s | Scale factor, A |
b:shapeK | · | Shape factor, k |
b:vavg | m/s | Average wind speed |
b:qmc | · | Quasi-Monte-Carlo |
b:ftariff | USD/kWh | Feed-in tariff |
b:ctariff | USD/kWh | Consumer tariff |
b:Hour | h | Year hour |
b:ucttime | s | Time |
b:cnfLvlUp | % | Confidence interval (upper bound) |
b:cnfLvlLo | % | Confidence interval (lower bound) |
b:sample | · | Sample |
b:number | · | Number |
b:inoconv | · | Load flow did not converge |
b:iShcFail | · | Short-Circuit Calculation failed |
b:iShcAtLine | · | Short-Circuit at Line |
b:pos | km | Distance |
b:posX | Ohm | Distance |
b:posZ | Ohm | Distance |
b:objIndex | · | Object index |
b:sideIndex | · | Side |
b:relPos | km | Position on element |
b:numRngDrawsInit | · | Number of initial random number generator draws |
b:method | · | Calculation method of Probabilistic Analysis |
b:calcAnalysed | · | Analysed command type |
b:comMethod | · | Calculation method of analysed command |
b:numSamplesExec | · | Number of iterations |
b:failures | · | Number of failed iterations |
b:numRngDraws | · | Number of calls of the random number generator |
b:seed | · | Used seed for random number generation |
b:considerCorrelations | · | Distribution correlations considered |
b:loadingLimit | · | Loading recording limit |
b:minVLimit | · | Minimum voltage recording limit |
b:maxVLimit | · | Maximum voltage recording limit |
b:maxDropLimit | · | Maximum feeder voltage drop recording limit |
b:maxRiseLimit | · | Minimum feeder voltage rise recording limit |
b:complyConstraints | · | Partial restoration to comply with constraints |
b:calcFail | · | Calculation failed. |
b:studyBBvoltage | p.u. | Voltage at study Busbar |
b:totDemand | MW | Active Power of scaled loads |
b:from | · | Exchange from |
b:to | · | Exchange to |
b:scen | · | Active Operation Scenario |
b:calcmod | · | Calculation mode |
b:outid | · | Contingency Case Index |
b:errbs | · | Error for bus equations |
b:errfi | · | Error for network model equations |
b:errgrd | · | Error for dynamic model equations |
b:errdxs | · | Error for A-stable dynamic model equations |
b:errdxi | · | Error for network state equations |
b:itrgr | · | Number of inner-loop iterations for network model equations |
b:ipjac | · | Number of Jacobian matrix updates for network model equations |
b:icjac | · | Number of network Jacobian matrix factorisations |
b:icadm | · | Number of admittance computations |
b:numNonZerosLU | · | Number of entries in factorisation |
b:ibvec | · | Number of evaluations for network model equation mismatches |
b:ibchk | · | Number of convergence checks for network model equations |
b:itreq | · | Number of whole system iterations |
b:itevt | · | Number of repeat event loops |
b:itevtmin | · | Number of reschedule event loops |
b:itout | · | Number of outer-loop iterations for network model equations |
b:itrstgrd | · | Number of inner-loop iterations for dynamic model equations |
b:ijgrd | · | Number of Jacobian matrix factorisations for dynamic model equations |
b:itoutgrd | · | Number of outer-loop iterations for dynamic model equations |
b:ierremt | · | Integration error for dynamic model equations (EMT) |
b:ierrgrd | · | Integration error for dynamic model equations (GRD) |
b:ierremtadapt | · | Integration error for dynamic model equations used for the automatic step size adaptation (EMT) |
b:ierrgrdadapt | · | Integration error for dynamic model equations used for the automatic step size adaptation (GRD) |
b:dtemt | · | Integration step size for dynamic model equations (EMT) |
b:dtgrd | · | Integration step size for dynamic model equations (GRD) |
b:dtint | · | Interruption step |
b:dtset | · | Default step |
b:warnA | · | Number of type-A warnings |
b:warnB | · | Number of type-B warnings |
b:warnC | · | Number of type-C warnings |
b:ierrthd | · | Maximum error in the EMT to RMS transformation during co-simulation |
b:ierrunb | · | Maximum unbalance factor during co-simulation |
b:i_eul | · | Integration formula restoration index |
b:fnow | Hz | Frequency |
b:ifnow | · | Harmonic Order |
b:df | Hz | Frequency step size (harmonics) |
b:ierrhmc | · | Prediction error (harmonics) |
b:ierrgnrl | · | Prediction error (ComStep) |
b:step | · | Step size (ComStep) |
b:dcase | · | Case |
b:identObjective | · | Objective function value for parameter identification |
b:stepDtact | · | Step size |
b:stepDtDefault | · | Default step size |
b:stepAlpha | · | Damping factor |
b:stepType | · | Simulation step type |
b:level | · | Level |
b:bbfail | · | Busbar failure |
b:tmphase | min | Time Phase |
b:outer | · | Number of outer loops |
b:iterTotal | · | Total number of (inner) iterations |
b:iter1 | · | Number of iterations for outer loop 1 |
b:iter2 | · | Number of iterations for outer loop 2 |
b:iter3 | · | Number of iterations for outer loop 3 |
b:iter4 | · | Number of iterations for outer loop 4 |
b:iter5 | · | Number of iterations for outer loop 5 |
b:isLinear | · | Calculated using linearised method |
b:isIslanding | · | Causes islanding |
b:isBlackout | · | Causes blackout |
b:isSubstSplit | · | Causes substation split or merge |
b:nrOfLostLoads | · | Number of loads lost |
b:nrOfLostGens | · | Number of generators lost |
b:lostPLoad | · | Load lost in MW |
b:lostPGeneration | · | Generation lost in MW |
b:lostQLoad | · | Load lost in Mvar |
b:lostQGeneration | · | Generation lost in Mvar |
b:asynchOfNextBB | deg | Max. asynchronism of busbars next to the fault |
b:asynchBB1 | · | Max. asynchronism - busbar 1 |
b:asynchBB2 | · | Max. asynchronism - busbar 2 |
b:nrUnsolvedCnt | · | Number of unsolved contingencies |
b:nrProcessedCnt | · | Number of processed contingencies |
b:nrInactiveCnt | · | Number of inactive contingencies |
b:nrEarthCnt | · | Number of contingencies causing grounding |
b:nrCntIslanding | · | Number of contingencies causing islanding |
b:nrCntBlackout | · | Number of contingencies causing blackouts |
b:nrCntSubSplit | · | Number of contingencies causing substation split or merge |
b:nrCntLostLoad | · | Number of contingencies causing loss of load |
b:nrCntLostGen | · | Number of contingencies causing loss of generation |
b:casenum | · | Case |
b:ldfmethod | · | Load Flow Calculation |
b:noconv | · | Load flow calculation failed. |
b:isCalcSucc | · | Calculation successful. |
b:isContUc | · | Contingencies considered |
b:isLinearCont | · | Linearised contingency analysis method used |
b:calcPeriod | · | Time period |
b:stepSize | · | Step Size |
b:objective | · | Objective Function |
b:isMinVREcurt | · | Minimise curtailment of renewable energy sources (VREs) |
b:isMinLoadshed | · | Minimise load shedding |
b:isMinNetRemAct | · | Minimise network-based remedial actions |
b:isMinStartUpShutDownCosts | · | Minimise generator start-up/shut-down costs |
b:isMinOperatingCosts | · | Minimise generator operating costs |
b:isMinRedispCosts | · | Minimise generator redispatch costs |
b:isCtrlP | · | Active power dispatch |
b:isCtrlTap | · | Transformer tap positions |
b:isCtrlLdShed | · | Load shedding |
b:isCtrlQ | · | Reactive power dispatch |
b:isCtrlShunt | · | Switchable shunts |
b:isCtrlVRE | · | Allow curtailment of variable renewable energy sources (VREs) |
b:isCtrlHvDc | · | HVDC active/reactive power controls |
b:isRoundDiscreteCtrls | · | Round discrete controls |
b:isLimP | · | Active power limits |
b:isLimTap | · | Transformer tap limits |
b:isLimLdShed | · | Load shedding limits |
b:isLimQ | · | Reactive power limits |
b:isLimShunt | · | Shunt tap limits |
b:isConstrLoading | · | Max. branch flows (max. loading) |
b:isConstrBoundary | · | Boundary flow constraints |
b:isConstrVoltage | · | Voltage limits of busbars/terminals |
b:isConstrRamp | · | Ramp rate constraints |
b:isConstrMinUpDownTime | · | Minimum up-/down-times |
b:isConstrSpinReserve | · | Spinning reserve of regions |
b:isCheckOptSolution | · | Calculate and record load flow results with optimal controls |
b:recordCtrlVarsOpt | · | All optimal control variables recorded |
b:recordCnstrVarsOpt | · | All constraint results (after optimisation) recorded |
b:recordRedispResPerStep | · | Redispatch results per study time additionally recorded |
b:isWriteElmResCont | · | Contingency results recorded |
b:recordCnstrVarsOrg | · | All constraint results (before optimisation) additionally recorded |
b:isPlanedOutages | · | Planned outages |
b:isRollingHorizonAlgo | · | Restrict simultaneous optimisation period |
b:numStudyTimesHorizon | · | Number of study times |
b:numOverlapHorizon | · | Number of overlapping study times with next period |
b:maxAllowedConstrError | % | Max. acceptable error for constraints |
b:minEff_dP | % | Min. Generator effectiveness |
b:minEff_dTap | % | Min. Transformer effectiveness |
b:isFilterPowerConstr | · | Constraint filter for power flow constraints |
b:powerConstrMarginGeneral | % | Active constraint margin |
b:powerConstrMarginLazy | % | Lazy constraint margin |
b:powerConstrMarginCallback | % | Low priority constraint margin |
b:isFilterVoltConstr | · | Constraint filter for voltage constraints |
b:voltConstrMarginGeneral | p.u. | Active constraint margin |
b:voltConstrMarginLazy | p.u. | Lazy constraint margin |
b:voltConstrMarginCallback | p.u. | Low priority constraint margin |
b:penaltySoftConstr | · | Penalty factor for soft constraints |
b:isParallel | · | Parallel contingency computation |
b:minNumCnt4Parallel | · | Minimum number of contingencies |
b:isAllowCurativeCtrl | · | Curative controls allowed |
Related
- All 73 classes in the attribute reference
- RMS and EMT simulation batch runs in Python
- PowerFactory Python API: getting started
← ElmFile Measurement File · TypAsm Asynchronous Machine Type - old →