altdss.Solution#
Module Contents#
Classes#
API#
- class altdss.Solution.ISolution(api_util, prefer_lists=False)#
Bases:
altdss.common.Base- property AddType: int#
Type of device to add in AutoAdd Mode: {dssGen (Default) | dssCap}
- property Algorithm: dss.enums.SolutionAlgorithms#
Base Solution algorithm: {dssNormalSolve | dssNewtonSolve}
- BuildYMatrix(BuildOption: int, AllocateVI: bool)#
- property BusLevels: altdss.types.Int32Array#
- property Capkvar: float#
Capacitor kvar for adding capacitors in AutoAdd mode
- CheckControls()#
- CheckFaultStatus()#
- Cleanup()#
’ Same as Circuit.EndOfTimeStepUpdate
- property ControlActionsDone: bool#
Flag indicating the control actions are done.
- property ControlIterations: int#
Value of the control iteration counter
- property ControlMode: dss.enums.ControlModes#
{dssStatic* | dssEvent | dssTime} Modes for control devices
- property Converged: bool#
Flag to indicate whether the circuit solution converged
- property DefaultDaily: str#
Default daily load shape (defaults to “Default”)
- property DefaultYearly: str#
Default Yearly load shape (defaults to “Default”)
- DoControlActions()#
- property EventLog: List[str]#
Array of strings containing the Event Log
- FinishTimeStep()#
- property Frequency: float#
Set the Frequency for next solution
- property GenMult: float#
Default Multiplier applied to generators (like LoadMult)
- property GenPF: float#
PF for generators in AutoAdd mode
- property GenkW: float#
Generator kW for AutoAdd mode
- property Hour: int#
Set Hour for time series solutions.
- property IncMatrix: altdss.types.Int32Array#
- property IncMatrixCols: List[str]#
- property IncMatrixRows: List[str]#
- 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)
- property LDCurve: str#
Load-Duration Curve name for LD modes
- property Laplacian: altdss.types.Int32Array#
- property LoadModel: int#
Load Model: {dssPowerFlow (default) | dssAdmittance}
- property LoadMult: float#
Default load multiplier applied to all non-fixed loads
- property MaxControlIterations: int#
Maximum allowable control iterations
- property MaxIterations: int#
Max allowable iterations.
- property MinIterations: int#
Minimum number of iterations required for a power flow solution.
- property Mode: dss.enums.SolveModes#
Set present solution mode
- property Mode_str: str#
Present solution mode as string (classic ModeID)
- property MostIterationsDone: int#
Max number of iterations required to converge at any control iteration of the most recent solution.
- property Number: int#
Number of solutions to perform for Monte Carlo and time series simulations
- property ProcessTime: float#
Gets the time required to perform the latest solution (Read only)
- property Random: int#
Randomization mode for random variables “Gaussian” or “Uniform”
- SampleControlDevices()#
- Sample_DoControlActions()#
- property Seconds: float#
Seconds from top of the hour.
- Solve()#
- SolveAll()#
- SolveDirect()#
- SolveNoControl()#
- SolvePflow()#
- SolvePlusControl()#
- SolveSnap()#
- property StepSize: float#
Time step size in sec
- 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.
- property TimeOfStep: float#
Get the solution process time + sample time for time step
- property Tolerance: float#
Solution convergence tolerance.
- property TotalIterations: int#
Total iterations including control iterations for most recent solution.
- property TotalTime: float#
Gets/sets the accumulated time of the simulation
- property Year: int#
Set year for planning studies
- __init__(api_util, prefer_lists=False)#
- property pctGrowth: float#
Percent default annual load growth rate