dss.ISolution

Module Contents

Classes

ISolution

API

class dss.ISolution.ISolution(api_util, prefer_lists=False)

Bases: dss._cffi_api_util.Base

property AddType: int

Type of device to add in AutoAdd Mode: {dssGen (Default) | dssCap}

Original COM help: https://opendss.epri.com/AddType.html

property Algorithm: dss.enums.SolutionAlgorithms

Base Solution algorithm

Original COM help: https://opendss.epri.com/Algorithm.html

BuildYMatrix(BuildOption: int, AllocateVI: bool)

property BusLevels: dss._types.Int32Array

Bus levels for all the buses in the model.

The bus levels are calculated after calculating the incidence branch-to-node (B2N) matrix and they represent the distance from the buses to a reference that goes from the feeder head to the farthest bus in the model. The bus level index matches with the bus list obtained with the circuit interface.

Original COM help: https://opendss.epri.com/BusLevels.html

property Capkvar: float

Capacitor kvar for adding capacitors in AutoAdd mode

Original COM help: https://opendss.epri.com/Capkvar.html

CheckControls()

CheckFaultStatus()

Cleanup()

property ControlActionsDone: bool

Flag indicating the control actions are done.

Original COM help: https://opendss.epri.com/ControlActionsDone.html

property ControlIterations: int

Value of the control iteration counter

Original COM help: https://opendss.epri.com/ControlIterations.html

property ControlMode: dss.enums.ControlModes

Modes for control devices

Original COM help: https://opendss.epri.com/ControlMode.html

property Converged: bool

Flag to indicate whether the circuit solution converged

Original COM help: https://opendss.epri.com/Converged.html

property DefaultDaily: str

Default daily load shape (defaults to “Default”)

Original COM help: https://opendss.epri.com/DefaultDaily.html

property DefaultYearly: str

Default Yearly load shape (defaults to “Default”)

Original COM help: https://opendss.epri.com/DefaultYearly.html

DoControlActions()

property EventLog: List[str]

Array of strings containing the Event Log

Original COM help: https://opendss.epri.com/EventLog.html

FinishTimeStep()

property Frequency: float

Set the Frequency for next solution

Original COM help: https://opendss.epri.com/Frequency1.html

property GenMult: float

Default Multiplier applied to generators (like LoadMult)

Original COM help: https://opendss.epri.com/GenMult.html

property GenPF: float

PF for generators in AutoAdd mode

Original COM help: https://opendss.epri.com/GenPF.html

property GenkW: float

Generator kW for AutoAdd mode

Original COM help: https://opendss.epri.com/GenkW.html

property Hour: int

Set Hour for time series solutions.

Original COM help: https://opendss.epri.com/Hour.html

property IncMatrix: dss._types.Int32Array

Incidence branch-to-node (B2N) matrix calculated for the model as a vector of integers.

The vector represents a sparse matrix (non-zero values are the only ones delivered) and can be interpreted as follows: The first element is the row number, the second one is the column and the third is the value, this way, by dividing the number of elements in the array by 3 the user can obtain the number of rows in case of wanting to sort the vector values within a matrix.

Original COM help: https://opendss.epri.com/IncMatrix.html

property IncMatrixCols: List[str]

Names of the columns of the branch-to-node (B2N) matrix.

Original COM help: https://opendss.epri.com/IncMatrixCols.html

property IncMatrixRows: List[str]

Names of the rows of the branch-to-node (B2N) matrix.

Original COM help: https://opendss.epri.com/IncMatrixRows.html

InitSnap()

property IntervalHrs: float

Get/Set the Solution.IntervalHrs variable used for devices that integrate / custom solution algorithms

property Iterations: int

Number of iterations taken for last solution. (Same as Totaliterations)

Original COM help: https://opendss.epri.com/Iterations.html

property LDCurve: str

Load-Duration Curve name for LD modes

Original COM help: https://opendss.epri.com/LDCurve.html

property Laplacian: dss._types.Int32Array

Laplacian matrix calculated in OpenDSS based on the latest branch-to-node (B2N) matrix.

The vector represents a sparse matrix (non-zero values are the only ones delivered) and can be interpreted as follows: The first element is the row number, the second one is the column and the third is the value, this way, by dividing the number of elements in the array by 3 the user can obtain the number of rows in case of wanting to sort the vector values within a matrix. The tables for the columns and rows are the same as the columns for the B2N columns (square matrix).

Original COM help: https://opendss.epri.com/Laplacian.html

property LoadModel: int

Load Model: {dssPowerFlow (default) | dssAdmittance}

Original COM help: https://opendss.epri.com/LoadModel.html

property LoadMult: float

Default load multiplier applied to all non-fixed loads

Original COM help: https://opendss.epri.com/LoadMult.html

property MaxControlIterations: int

Maximum allowable control iterations

Original COM help: https://opendss.epri.com/MaxControlIterations.html

property MaxIterations: int

Max allowable iterations.

Original COM help: https://opendss.epri.com/MaxIterations.html

property MinIterations: int

Minimum number of iterations required for a power flow solution.

Original COM help: https://opendss.epri.com/MinIterations.html

property Mode: dss.enums.SolveModes

Set present solution mode

Original COM help: https://opendss.epri.com/Mode2.html

property ModeID: str

ID (text) of the present solution mode

Original COM help: https://opendss.epri.com/ModeID.html

property MostIterationsDone: int

Max number of iterations required to converge at any control iteration of the most recent solution.

Original COM help: https://opendss.epri.com/MostIterationsDone.html

property Number: int

Number of solutions to perform for Monte Carlo and time series simulations

Original COM help: https://opendss.epri.com/Number1.html

property Process_Time: float

Gets the time required to perform the latest solution (Read only)

Original COM help: https://opendss.epri.com/Process_Time.html

property Random: int

Randomization mode for random variables “Gaussian” or “Uniform”

Original COM help: https://opendss.epri.com/Random.html

SampleControlDevices()

Sample_DoControlActions()

property Seconds: float

Seconds from top of the hour.

Original COM help: https://opendss.epri.com/Seconds.html

Solve()

SolveAll()

Solves all the circuits (Actors) loaded into memory by the user.

Original COM help: https://opendss.epri.com/SolveAll.html

SolveDirect()

SolveNoControl()

SolvePflow()

SolvePlusControl()

SolveSnap()

property StepSize: float

Time step size in sec

Original COM help: https://opendss.epri.com/StepSize.html

property StepsizeHr: float

(write-only) Set Stepsize in Hr

property StepsizeMin: float

(write-only) Set Stepsize in minutes

property SystemYChanged: bool

Flag that indicates if elements of the System Y have been changed by recent activity.

Original COM help: https://opendss.epri.com/SystemYChanged.html

property Time_of_Step: float

Get the solution process time + sample time for time step

Original COM help: https://opendss.epri.com/Time_of_Step.html

property Tolerance: float

Solution convergence tolerance.

Original COM help: https://opendss.epri.com/Tolerance.html

property Total_Time: float

Gets/sets the accumulated time of the simulation

This accumulator has to be reset manually.

Original COM help: https://opendss.epri.com/Total_Time.html

property Totaliterations: int

Total iterations including control iterations for most recent solution.

Original COM help: https://opendss.epri.com/Totaliterations.html

property Year: int

Set year for planning studies

Original COM help: https://opendss.epri.com/Year.html

__init__(api_util, prefer_lists=False)

property dblHour: float

Hour as a double, including fractional part

Original COM help: https://opendss.epri.com/dblHour1.html

property pctGrowth: float

Percent default annual load growth rate

Original COM help: https://opendss.epri.com/pctGrowth.html