DSS C-API and dss.hpp
DSS C-API and dss.hpp expose a customized and extended implementation of OpenDSS to C and C++.
dss::classic::ISolution Class Reference
Inheritance diagram for dss::classic::ISolution:
[legend]
Collaboration diagram for dss::classic::ISolution:
[legend]

Public Member Functions

 ISolution (dss::APIUtil *util)
 
void BuildYMatrix (int32_t BuildOption, int32_t AllocateVI)
 
void CheckControls ()
 
void CheckFaultStatus ()
 
void Cleanup ()
 
void DoControlActions ()
 
void FinishTimeStep ()
 
void InitSnap ()
 
void SampleControlDevices ()
 
void Sample_DoControlActions ()
 
void Solve ()
 
void SolveDirect ()
 
void SolveNoControl ()
 
void SolvePflow ()
 
void SolvePlusControl ()
 
void SolveSnap ()
 
int32_t AddType ()
 Type of device to add in AutoAdd Mode: {dssGen (Default) | dssCap}.
 
ISolution & AddType (int32_t value)
 
int32_t Algorithm ()
 Base Solution algorithm: {dssNormalSolve | dssNewtonSolve}.
 
ISolution & Algorithm (int32_t value)
 
double Capkvar ()
 Capacitor kvar for adding capacitors in AutoAdd mode.
 
ISolution & Capkvar (double value)
 
bool ControlActionsDone ()
 Flag indicating the control actions are done.
 
ISolution & ControlActionsDone (bool value)
 
int32_t ControlIterations ()
 Value of the control iteration counter.
 
ISolution & ControlIterations (int32_t value)
 
int32_t ControlMode ()
 {dssStatic* | dssEvent | dssTime} Modes for control devices
 
ISolution & ControlMode (int32_t value)
 
bool Converged ()
 Flag to indicate whether the circuit solution converged.
 
ISolution & Converged (bool value)
 
string DefaultDaily ()
 Default daily load shape (defaults to "Default")
 
ISolution & DefaultDaily (const char *value)
 
ISolution & DefaultDaily (const string &value)
 
string DefaultYearly ()
 Default Yearly load shape (defaults to "Default")
 
ISolution & DefaultYearly (const char *value)
 
ISolution & DefaultYearly (const string &value)
 
strings EventLog ()
 Array of strings containing the Event Log.
 
double Frequency ()
 Set the Frequency for next solution.
 
ISolution & Frequency (double value)
 
double GenMult ()
 Default Multiplier applied to generators (like LoadMult)
 
ISolution & GenMult (double value)
 
double GenPF ()
 PF for generators in AutoAdd mode.
 
ISolution & GenPF (double value)
 
double GenkW ()
 Generator kW for AutoAdd mode.
 
ISolution & GenkW (double value)
 
int32_t Hour ()
 Set Hour for time series solutions.
 
ISolution & Hour (int32_t value)
 
double IntervalHrs ()
 Get/Set the Solution.IntervalHrs variable used for devices that integrate / custom solution algorithms.
 
ISolution & IntervalHrs (double value)
 
int32_t Iterations ()
 Number of iterations taken for last solution. More...
 
string LDCurve ()
 Load-Duration Curve name for LD modes.
 
ISolution & LDCurve (const char *value)
 
ISolution & LDCurve (const string &value)
 
int32_t LoadModel ()
 Load Model: {dssPowerFlow (default) | dssAdmittance}.
 
ISolution & LoadModel (int32_t value)
 
double LoadMult ()
 Default load multiplier applied to all non-fixed loads.
 
ISolution & LoadMult (double value)
 
int32_t MaxControlIterations ()
 Maximum allowable control iterations.
 
ISolution & MaxControlIterations (int32_t value)
 
int32_t MaxIterations ()
 Max allowable iterations.
 
ISolution & MaxIterations (int32_t value)
 
int32_t MinIterations ()
 Minimum number of iterations required for a power flow solution.
 
ISolution & MinIterations (int32_t value)
 
int32_t Mode ()
 Set present solution mode (by a text code - see DSS Help)
 
ISolution & Mode (int32_t value)
 
string ModeID ()
 ID (text) of the present solution mode.
 
int32_t MostIterationsDone ()
 Max number of iterations required to converge at any control iteration of the most recent solution.
 
int32_t Number ()
 Number of solutions to perform for Monte Carlo and time series simulations.
 
ISolution & Number (int32_t value)
 
double Process_Time ()
 Gets the time required to perform the latest solution (Read only)
 
int32_t Random ()
 Randomization mode for random variables "Gaussian" or "Uniform".
 
ISolution & Random (int32_t value)
 
double Seconds ()
 Seconds from top of the hour.
 
ISolution & Seconds (double value)
 
double StepSize ()
 Time step size in sec.
 
ISolution & StepSize (double value)
 
bool SystemYChanged ()
 Flag that indicates if elements of the System Y have been changed by recent activity.
 
double Time_of_Step ()
 Get the solution process time + sample time for time step.
 
double Tolerance ()
 Solution convergence tolerance.
 
ISolution & Tolerance (double value)
 
double Total_Time ()
 Gets/sets the accumulated time of the simulation.
 
ISolution & Total_Time (double value)
 
int32_t Totaliterations ()
 Total iterations including control iterations for most recent solution.
 
int32_t Year ()
 Set year for planning studies.
 
ISolution & Year (int32_t value)
 
double dblHour ()
 Hour as a double, including fractional part.
 
ISolution & dblHour (double value)
 
double pctGrowth ()
 Percent default annual load growth rate.
 
ISolution & pctGrowth (double value)
 
ISolution & StepsizeHr (double value)
 (write-only) Set Stepsize in Hr
 
ISolution & StepsizeMin (double value)
 (write-only) Set Stepsize in minutes
 
template<typename VectorT = Eigen::Matrix<int32_t, Eigen::Dynamic, 1>>
VectorT BusLevels ()
 
template<typename VectorT = Eigen::Matrix<int32_t, Eigen::Dynamic, 1>>
VectorT IncMatrix ()
 
strings IncMatrixCols ()
 
strings IncMatrixRows ()
 
template<typename VectorT = Eigen::Matrix<int32_t, Eigen::Dynamic, 1>>
VectorT Laplacian ()
 
- Public Member Functions inherited from dss::ContextState
 ContextState (APIUtil *util)
 

Additional Inherited Members

- Public Attributes inherited from dss::ContextState
void * ctx
 Pointer to the DSSContext for easy access.
 
APIUtil * api_util
 API utility functions.
 

Member Function Documentation

◆ Iterations()

int32_t dss::classic::ISolution::Iterations ( )
inline

Number of iterations taken for last solution.

(Same as TotalIterations)


The documentation for this class was generated from the following file: