Click or drag to resize

Solution Class

[This is preliminary documentation and is subject to change.]

[Missing <summary> documentation for "T:dss_sharp.Solution"]

Inheritance Hierarchy

Namespace:  dss_sharp
Assembly:  dss_sharp (in dss_sharp.dll) Version: 1.0.0
Syntax
Copy
public class Solution : ContextState

The Solution type exposes the following members.

Constructors
  NameDescription
Public methodSolution
Initializes a new instance of the Solution class
Top
Properties
  NameDescription
Public propertyAddType
Type of device to add in AutoAdd Mode: {dssGen (Default) | dssCap}
Public propertyAlgorithm
Base Solution algorithm: {dssNormalSolve | dssNewtonSolve}
Public propertyBusLevels
Public propertyCapkvar
Capacitor kvar for adding capacitors in AutoAdd mode
Public propertyControlActionsDone
Flag indicating the control actions are done.
Public propertyControlIterations
Value of the control iteration counter
Public propertyControlMode
{dssStatic* | dssEvent | dssTime} Modes for control devices
Public propertyConverged
Flag to indicate whether the circuit solution converged
Public propertydblHour
Hour as a double, including fractional part
Public propertyDefaultDaily
Default daily load shape (defaults to "Default")
Public propertyDefaultYearly
Default Yearly load shape (defaults to "Default")
Public propertyEventLog
Array of strings containing the Event Log
Public propertyFrequency
Set the Frequency for next solution
Public propertyGenkW
Generator kW for AutoAdd mode
Public propertyGenMult
Default Multiplier applied to generators (like LoadMult)
Public propertyGenPF
PF for generators in AutoAdd mode
Public propertyHour
Set Hour for time series solutions.
Public propertyIncMatrix
Public propertyIncMatrixCols
Public propertyIncMatrixRows
Public propertyIntervalHrs
Get/Set the Solution.IntervalHrs variable used for devices that integrate / custom solution algorithms
Public propertyIterations
Number of iterations taken for last solution. (Same as TotalIterations)
Public propertyLaplacian
Public propertyLDCurve
Load-Duration Curve name for LD modes
Public propertyLoadModel
Load Model: {dssPowerFlow (default) | dssAdmittance}
Public propertyLoadMult
Default load multiplier applied to all non-fixed loads
Public propertyMaxControlIterations
Maximum allowable control iterations
Public propertyMaxIterations
Max allowable iterations.
Public propertyMinIterations
Minimum number of iterations required for a power flow solution.
Public propertyMode
Set present solution mode (by a text code - see DSS Help)
Public propertyModeID
ID (text) of the present solution mode
Public propertyMostIterationsDone
Max number of iterations required to converge at any control iteration of the most recent solution.
Public propertyNumber
Number of solutions to perform for Monte Carlo and time series simulations
Public propertypctGrowth
Percent default annual load growth rate
Public propertyProcess_Time
Gets the time required to perform the latest solution (Read only)
Public propertyRandom
Randomization mode for random variables "Gaussian" or "Uniform"
Public propertySeconds
Seconds from top of the hour.
Public propertyStepSize
Time step size in sec
Public propertyStepsizeHr
(write-only) Set Stepsize in Hr
Public propertyStepsizeMin
(write-only) Set Stepsize in minutes
Public propertySystemYChanged
Flag that indicates if elements of the System Y have been changed by recent activity.
Public propertyTime_of_Step
Get the solution process time + sample time for time step
Public propertyTolerance
Solution convergence tolerance.
Public propertyTotal_Time
Gets/sets the accumulated time of the simulation
Public propertyTotaliterations
Total iterations including control iterations for most recent solution.
Public propertyYear
Set year for planning studies
Top
Methods
  NameDescription
Public methodBuildYMatrix
Public methodCheckControls
Public methodCheckFaultStatus
Protected methodCheckForError (Inherited from ContextState.)
Public methodCleanup
Public methodDoControlActions
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodFinishTimeStep
Public methodGetContextHandle
Returns the low-level handle of the current OpenDSS/DSS-CAPI instance.
(Inherited from ContextState.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInitSnap
Protected methodMemberwiseClone (Inherited from Object.)
Public methodSample_DoControlActions
Public methodSampleControlDevices
Public methodSolve
Public methodSolveDirect
Public methodSolveNoControl
Public methodSolvePflow
Public methodSolvePlusControl
Public methodSolveSnap
Public methodToString (Inherited from Object.)
Top
Fields
  NameDescription
Protected fieldapiutil (Inherited from ContextState.)
Protected fieldctx (Inherited from ContextState.)
Top
See Also