 |
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 C-API and dss.hpp
DSS C-API and dss.hpp expose a customized and extended implementation of OpenDSS to C and C++.
|
Public Types | |
| typedef InvControl::Properties | Properties |
| typedef InvControl | BatchElementClass |
| typedef InvControl::InvControlControlMode | InvControlControlMode |
| typedef InvControl::InvControlCombiMode | InvControlCombiMode |
| typedef InvControl::InvControlVoltageCurveXRef | InvControlVoltageCurveXRef |
| typedef InvControl::InvControlVoltWattYAxis | InvControlVoltWattYAxis |
| typedef InvControl::InvControlRateOfChangeMode | InvControlRateOfChangeMode |
| typedef InvControl::InvControlReactivePowerReference | InvControlReactivePowerReference |
Public Member Functions | |
| InvControlBatch (APIUtil *util) | |
| Create a batch of all InvControl elements. | |
| InvControlBatch (APIUtil *util, int32_t prop_idx, int32_t prop_value) | |
| Create a batch of all InvControl elements that match an integer property value. | |
| InvControlBatch (APIUtil *util, const char *regexp) | |
| Create a batch of all InvControl elements that match a regular expression. | |
| InvControlBatch & | begin_edit () |
| InvControlBatch & | end_edit (int32_t num_edits=1) |
| std::vector< strings > | DERList () |
| Array list of PVSystem and/or Storage elements to be controlled. More... | |
| InvControlBatch & | DERList (strings &value) |
| BatchInt32ArrayProxy | Mode () |
| Smart inverter function in which the InvControl will control the PC elements specified in DERList, according to the options below: More... | |
| InvControlBatch & | Mode (string &value) |
| InvControlBatch & | Mode (int32_t value) |
| InvControlBatch & | Mode (InvControl::InvControlControlMode value) |
| InvControlBatch & | Mode (strings &value) |
| InvControlBatch & | Mode (std::vector< int32_t > &value) |
| InvControlBatch & | Mode (std::vector< InvControl::InvControlControlMode > &value) |
| strings | Mode_str () |
| Smart inverter function in which the InvControl will control the PC elements specified in DERList, according to the options below: More... | |
| InvControlBatch & | Mode_str (string &value) |
| InvControlBatch & | Mode_str (strings &value) |
| BatchInt32ArrayProxy | CombiMode () |
| Combination of smart inverter functions in which the InvControl will control the PC elements in DERList, according to the options below: More... | |
| InvControlBatch & | CombiMode (string &value) |
| InvControlBatch & | CombiMode (int32_t value) |
| InvControlBatch & | CombiMode (InvControl::InvControlCombiMode value) |
| InvControlBatch & | CombiMode (strings &value) |
| InvControlBatch & | CombiMode (std::vector< int32_t > &value) |
| InvControlBatch & | CombiMode (std::vector< InvControl::InvControlCombiMode > &value) |
| strings | CombiMode_str () |
| Combination of smart inverter functions in which the InvControl will control the PC elements in DERList, according to the options below: More... | |
| InvControlBatch & | CombiMode_str (string &value) |
| InvControlBatch & | CombiMode_str (strings &value) |
| strings | vvc_curve1 () |
| Required for VOLTVAR mode. More... | |
| InvControlBatch & | vvc_curve1 (dss::obj::XYcurve &value) |
| InvControlBatch & | vvc_curve1 (const string &value) |
| std::vector< dss::obj::XYcurve > | vvc_curve1_obj () |
| Required for VOLTVAR mode. More... | |
| InvControlBatch & | vvc_curve1_obj (dss::obj::XYcurve &value) |
| BatchFloat64ArrayProxy | hysteresis_offset () |
| Required for VOLTVAR mode, and defaults to 0. More... | |
| InvControlBatch & | hysteresis_offset (double value) |
| template<typename T > | |
| InvControlBatch & | hysteresis_offset (T &value) |
| template<typename T > | |
| InvControlBatch & | hysteresis_offset (typename T::iterator it_begin, typename T::iterator it_end) |
| BatchInt32ArrayProxy | voltage_curvex_ref () |
| Required for VOLTVAR and VOLTWATT modes, and defaults to rated. More... | |
| InvControlBatch & | voltage_curvex_ref (string &value) |
| InvControlBatch & | voltage_curvex_ref (int32_t value) |
| InvControlBatch & | voltage_curvex_ref (InvControl::InvControlVoltageCurveXRef value) |
| InvControlBatch & | voltage_curvex_ref (strings &value) |
| InvControlBatch & | voltage_curvex_ref (std::vector< int32_t > &value) |
| InvControlBatch & | voltage_curvex_ref (std::vector< InvControl::InvControlVoltageCurveXRef > &value) |
| strings | voltage_curvex_ref_str () |
| Required for VOLTVAR and VOLTWATT modes, and defaults to rated. More... | |
| InvControlBatch & | voltage_curvex_ref_str (string &value) |
| InvControlBatch & | voltage_curvex_ref_str (strings &value) |
| BatchInt32ArrayProxy | avgwindowlen () |
| Required for VOLTVAR mode and VOLTWATT mode, and defaults to 0 seconds (0s). More... | |
| InvControlBatch & | avgwindowlen (int32_t value) |
| template<typename T > | |
| InvControlBatch & | avgwindowlen (T &value) |
| template<typename T > | |
| InvControlBatch & | avgwindowlen (typename T::iterator it_begin, typename T::iterator it_end) |
| strings | voltwatt_curve () |
| Required for VOLTWATT mode. More... | |
| InvControlBatch & | voltwatt_curve (dss::obj::XYcurve &value) |
| InvControlBatch & | voltwatt_curve (const string &value) |
| std::vector< dss::obj::XYcurve > | voltwatt_curve_obj () |
| Required for VOLTWATT mode. More... | |
| InvControlBatch & | voltwatt_curve_obj (dss::obj::XYcurve &value) |
| BatchFloat64ArrayProxy | DbVMin () |
| Required for the dynamic reactive current mode (DYNAMICREACCURR), and defaults to 0.95 per-unit voltage (referenced to the PVSystem/Storage object rated voltage or a windowed average value). More... | |
| InvControlBatch & | DbVMin (double value) |
| template<typename T > | |
| InvControlBatch & | DbVMin (T &value) |
| template<typename T > | |
| InvControlBatch & | DbVMin (typename T::iterator it_begin, typename T::iterator it_end) |
| BatchFloat64ArrayProxy | DbVMax () |
| Required for the dynamic reactive current mode (DYNAMICREACCURR), and defaults to 1.05 per-unit voltage (referenced to the PVSystem object rated voltage or a windowed average value). More... | |
| InvControlBatch & | DbVMax (double value) |
| template<typename T > | |
| InvControlBatch & | DbVMax (T &value) |
| template<typename T > | |
| InvControlBatch & | DbVMax (typename T::iterator it_begin, typename T::iterator it_end) |
| BatchFloat64ArrayProxy | ArGraLowV () |
| Required for the dynamic reactive current mode (DYNAMICREACCURR), and defaults to 0.1. More... | |
| InvControlBatch & | ArGraLowV (double value) |
| template<typename T > | |
| InvControlBatch & | ArGraLowV (T &value) |
| template<typename T > | |
| InvControlBatch & | ArGraLowV (typename T::iterator it_begin, typename T::iterator it_end) |
| BatchFloat64ArrayProxy | ArGraHiV () |
| Required for the dynamic reactive current mode (DYNAMICREACCURR), and defaults to 0.1. More... | |
| InvControlBatch & | ArGraHiV (double value) |
| template<typename T > | |
| InvControlBatch & | ArGraHiV (T &value) |
| template<typename T > | |
| InvControlBatch & | ArGraHiV (typename T::iterator it_begin, typename T::iterator it_end) |
| BatchInt32ArrayProxy | DynReacavgwindowlen () |
| Required for the dynamic reactive current mode (DYNAMICREACCURR), and defaults to 1 seconds (1s). More... | |
| InvControlBatch & | DynReacavgwindowlen (int32_t value) |
| template<typename T > | |
| InvControlBatch & | DynReacavgwindowlen (T &value) |
| template<typename T > | |
| InvControlBatch & | DynReacavgwindowlen (typename T::iterator it_begin, typename T::iterator it_end) |
| BatchFloat64ArrayProxy | deltaQ_Factor () |
| Required for the VOLTVAR and DYNAMICREACCURR modes. More... | |
| InvControlBatch & | deltaQ_Factor (double value) |
| template<typename T > | |
| InvControlBatch & | deltaQ_Factor (T &value) |
| template<typename T > | |
| InvControlBatch & | deltaQ_Factor (typename T::iterator it_begin, typename T::iterator it_end) |
| BatchFloat64ArrayProxy | VoltageChangeTolerance () |
| Defaults to 0.0001 per-unit voltage. More... | |
| InvControlBatch & | VoltageChangeTolerance (double value) |
| template<typename T > | |
| InvControlBatch & | VoltageChangeTolerance (T &value) |
| template<typename T > | |
| InvControlBatch & | VoltageChangeTolerance (typename T::iterator it_begin, typename T::iterator it_end) |
| BatchFloat64ArrayProxy | VarChangeTolerance () |
| Required for VOLTVAR and DYNAMICREACCURR modes. More... | |
| InvControlBatch & | VarChangeTolerance (double value) |
| template<typename T > | |
| InvControlBatch & | VarChangeTolerance (T &value) |
| template<typename T > | |
| InvControlBatch & | VarChangeTolerance (typename T::iterator it_begin, typename T::iterator it_end) |
| BatchInt32ArrayProxy | VoltwattYAxis () |
| Required for VOLTWATT mode. More... | |
| InvControlBatch & | VoltwattYAxis (string &value) |
| InvControlBatch & | VoltwattYAxis (int32_t value) |
| InvControlBatch & | VoltwattYAxis (InvControl::InvControlVoltWattYAxis value) |
| InvControlBatch & | VoltwattYAxis (strings &value) |
| InvControlBatch & | VoltwattYAxis (std::vector< int32_t > &value) |
| InvControlBatch & | VoltwattYAxis (std::vector< InvControl::InvControlVoltWattYAxis > &value) |
| strings | VoltwattYAxis_str () |
| Required for VOLTWATT mode. More... | |
| InvControlBatch & | VoltwattYAxis_str (string &value) |
| InvControlBatch & | VoltwattYAxis_str (strings &value) |
| BatchInt32ArrayProxy | RateofChangeMode () |
| Required for VOLTWATT and VOLTVAR mode. More... | |
| InvControlBatch & | RateofChangeMode (string &value) |
| InvControlBatch & | RateofChangeMode (int32_t value) |
| InvControlBatch & | RateofChangeMode (InvControl::InvControlRateOfChangeMode value) |
| InvControlBatch & | RateofChangeMode (strings &value) |
| InvControlBatch & | RateofChangeMode (std::vector< int32_t > &value) |
| InvControlBatch & | RateofChangeMode (std::vector< InvControl::InvControlRateOfChangeMode > &value) |
| strings | RateofChangeMode_str () |
| Required for VOLTWATT and VOLTVAR mode. More... | |
| InvControlBatch & | RateofChangeMode_str (string &value) |
| InvControlBatch & | RateofChangeMode_str (strings &value) |
| BatchFloat64ArrayProxy | LPFTau () |
| Not required. More... | |
| InvControlBatch & | LPFTau (double value) |
| template<typename T > | |
| InvControlBatch & | LPFTau (T &value) |
| template<typename T > | |
| InvControlBatch & | LPFTau (typename T::iterator it_begin, typename T::iterator it_end) |
| BatchFloat64ArrayProxy | RiseFallLimit () |
| Not required. More... | |
| InvControlBatch & | RiseFallLimit (double value) |
| template<typename T > | |
| InvControlBatch & | RiseFallLimit (T &value) |
| template<typename T > | |
| InvControlBatch & | RiseFallLimit (typename T::iterator it_begin, typename T::iterator it_end) |
| BatchFloat64ArrayProxy | deltaP_Factor () |
| Required for the VOLTWATT modes. More... | |
| InvControlBatch & | deltaP_Factor (double value) |
| template<typename T > | |
| InvControlBatch & | deltaP_Factor (T &value) |
| template<typename T > | |
| InvControlBatch & | deltaP_Factor (typename T::iterator it_begin, typename T::iterator it_end) |
| bools | EventLog () |
| {Yes/True* | No/False} Default is YES for InvControl. More... | |
| InvControlBatch & | EventLog (bool value) |
| InvControlBatch & | EventLog (bools &value) |
| BatchInt32ArrayProxy | RefReactivePower () |
| Required for any mode that has VOLTVAR, DYNAMICREACCURR and WATTVAR. More... | |
| InvControlBatch & | RefReactivePower (string &value) |
| InvControlBatch & | RefReactivePower (int32_t value) |
| InvControlBatch & | RefReactivePower (InvControl::InvControlReactivePowerReference value) |
| InvControlBatch & | RefReactivePower (strings &value) |
| InvControlBatch & | RefReactivePower (std::vector< int32_t > &value) |
| InvControlBatch & | RefReactivePower (std::vector< InvControl::InvControlReactivePowerReference > &value) |
| strings | RefReactivePower_str () |
| Required for any mode that has VOLTVAR, DYNAMICREACCURR and WATTVAR. More... | |
| InvControlBatch & | RefReactivePower_str (string &value) |
| InvControlBatch & | RefReactivePower_str (strings &value) |
| BatchFloat64ArrayProxy | ActivePChangeTolerance () |
| Required for VOLTWATT. More... | |
| InvControlBatch & | ActivePChangeTolerance (double value) |
| template<typename T > | |
| InvControlBatch & | ActivePChangeTolerance (T &value) |
| template<typename T > | |
| InvControlBatch & | ActivePChangeTolerance (typename T::iterator it_begin, typename T::iterator it_end) |
| BatchInt32ArrayProxy | monVoltageCalc () |
| Number of the phase being monitored or one of {AVG | MAX | MIN} for all phases. More... | |
| InvControlBatch & | monVoltageCalc (string &value) |
| InvControlBatch & | monVoltageCalc (int32_t value) |
| InvControlBatch & | monVoltageCalc (MonitoredPhase value) |
| InvControlBatch & | monVoltageCalc (strings &value) |
| InvControlBatch & | monVoltageCalc (std::vector< int32_t > &value) |
| InvControlBatch & | monVoltageCalc (std::vector< MonitoredPhase > &value) |
| strings | monVoltageCalc_str () |
| Number of the phase being monitored or one of {AVG | MAX | MIN} for all phases. More... | |
| InvControlBatch & | monVoltageCalc_str (string &value) |
| InvControlBatch & | monVoltageCalc_str (strings &value) |
| std::vector< strings > | monBus () |
| Name of monitored bus used by the voltage-dependente control modes. More... | |
| InvControlBatch & | monBus (strings &value) |
| std::vector< VectorXd > | MonBusesVbase () |
| Array list of rated voltages of the buses and their nodes presented in the monBus property. More... | |
| InvControlBatch & | MonBusesVbase (VectorXd &value) |
| strings | voltwattCH_curve () |
| Required for VOLTWATT mode for Storage element in CHARGING state. More... | |
| InvControlBatch & | voltwattCH_curve (dss::obj::XYcurve &value) |
| InvControlBatch & | voltwattCH_curve (const string &value) |
| std::vector< dss::obj::XYcurve > | voltwattCH_curve_obj () |
| Required for VOLTWATT mode for Storage element in CHARGING state. More... | |
| InvControlBatch & | voltwattCH_curve_obj (dss::obj::XYcurve &value) |
| strings | wattpf_curve () |
| Required for WATTPF mode. More... | |
| InvControlBatch & | wattpf_curve (dss::obj::XYcurve &value) |
| InvControlBatch & | wattpf_curve (const string &value) |
| std::vector< dss::obj::XYcurve > | wattpf_curve_obj () |
| Required for WATTPF mode. More... | |
| InvControlBatch & | wattpf_curve_obj (dss::obj::XYcurve &value) |
| strings | wattvar_curve () |
| Required for WATTVAR mode. More... | |
| InvControlBatch & | wattvar_curve (dss::obj::XYcurve &value) |
| InvControlBatch & | wattvar_curve (const string &value) |
| std::vector< dss::obj::XYcurve > | wattvar_curve_obj () |
| Required for WATTVAR mode. More... | |
| InvControlBatch & | wattvar_curve_obj (dss::obj::XYcurve &value) |
| std::vector< strings > | PVSystemList () |
| Deprecated, use DERList instead. More... | |
| InvControlBatch & | PVSystemList (strings &value) |
| BatchFloat64ArrayProxy | Vsetpoint () |
| Required for Active Voltage Regulation (AVR). More... | |
| InvControlBatch & | Vsetpoint (double value) |
| template<typename T > | |
| InvControlBatch & | Vsetpoint (T &value) |
| template<typename T > | |
| InvControlBatch & | Vsetpoint (typename T::iterator it_begin, typename T::iterator it_end) |
| BatchFloat64ArrayProxy | basefreq () |
| Base Frequency for ratings. More... | |
| InvControlBatch & | basefreq (double value) |
| template<typename T > | |
| InvControlBatch & | basefreq (T &value) |
| template<typename T > | |
| InvControlBatch & | basefreq (typename T::iterator it_begin, typename T::iterator it_end) |
| bools | enabled () |
| {Yes|No or True|False} Indicates whether this element is enabled. More... | |
| InvControlBatch & | enabled (bool value) |
| InvControlBatch & | enabled (bools &value) |
| InvControlBatch & | like (const string &value) |
| Make like another object, e.g. More... | |
| InvControlBatch & | like (const char *value) |
| Make like another object, e.g. More... | |
 Public Member Functions inherited from dss::obj::DSSBatch | |
| DSSBatch (APIUtil *util, int32_t cls_idx) | |
| Create a batch of all elements in the DSS class. | |
| DSSBatch (APIUtil *util, int32_t cls_idx, int32_t prop_idx, int32_t prop_value) | |
| Create a batch of all elements that match an integer property value. | |
| DSSBatch (APIUtil *util, int32_t cls_idx, const char *regexp) | |
| Create a batch of all elements that match a regular expression. | |
| DSSBatch (APIUtil *util) | |
| Create an uninitialized batch instance. | |
| strings | name () |
Additional Inherited Members | |
| Public Attributes inherited from dss::obj::DSSBatch | |
| APIUtil * | api_util |
| void ** | pointer |
| int32_t | count [2] |
| Protected Member Functions inherited from dss::obj::DSSBatch | |
| void | check_for_error () |
| bools | get_batch_bool (int32_t index) |
| std::vector< complex > | get_batch_complex (int32_t index) |
| template<typename T = VectorXd> | |
| std::vector< T > | get_batch_valarray (int32_t index) |
| void | set_batch_complex_for_each (int32_t index, std::vector< complex > &values) |
| template<typename T > | |
| void | set_batch_val (int32_t index, const T &value) |
| template<typename T = VectorXd> | |
| T | get_batch_val (int32_t index) |
| template<typename T > | |
| void | set_batch_val_for_each (int32_t index, typename T::iterator v, typename T::iterator v_end) |
| Static Protected Member Functions inherited from dss::obj::DSSBatch | |
| template<typename T = VectorXd> | |
| static T | get_batch_val (int32_t index, DSSBatch &batch) |
|
inline |
Required for VOLTWATT.
Default is 0.01
Tolerance in pu of the convergence of the control loop associated with active power. For the same control iteration, this value is compared to the difference between the active power limit in pu resulted from the convergence process and the one resulted from the volt-watt function.
This reactive power tolerance value plus the voltage tolerance value (VoltageChangeTolerance) determine, together, when to stop control iterations by the InvControl.
If an InvControl is controlling more than one PVSystem/Storage, each PVSystem/Storage has this quantity calculated independently, and so an individual PVSystem/Storage may reach the tolerance within different numbers of control iterations.
DSS property name: ActivePChangeTolerance, DSS property index: 24
|
inline |
Required for the dynamic reactive current mode (DYNAMICREACCURR), and defaults to 0.1.
This is a gradient, expressed in unit-less terms of %/%, to establish the ratio by which percentage inductive reactive power production is increased as the percent delta-voltage decreases above DbVMax.
Percent delta-voltage is defined as the present PVSystem/Storage terminal voltage minus the moving average voltage, expressed as a percentage of the rated voltage for the PVSystem/Storage object.
Note, the moving average voltage for the dynamic reactive current mode is different than the mmoving average voltage for the volt-watt and volt-var modes.
DSS property name: ArGraHiV, DSS property index: 12
|
inline |
Required for the dynamic reactive current mode (DYNAMICREACCURR), and defaults to 0.1.
This is a gradient, expressed in unit-less terms of %/%, to establish the ratio by which percentage capacitive reactive power production is increased as the percent delta-voltage decreases below DbVMin.
Percent delta-voltage is defined as the present PVSystem/Storage terminal voltage minus the moving average voltage, expressed as a percentage of the rated voltage for the PVSystem/Storage object.
Note, the moving average voltage for the dynamic reactive current mode is different than the moving average voltage for the volt-watt and volt-var modes.
DSS property name: ArGraLowV, DSS property index: 11
|
inline |
Required for VOLTVAR mode and VOLTWATT mode, and defaults to 0 seconds (0s).
Sets the length of the averaging window over which the average PVSystem/Storage terminal voltage is calculated.
Units are indicated by appending s, m, or h to the integer value.
The averaging window will calculate the average PVSystem/Storage terminal voltage over the specified period of time, up to and including the last power flow solution.
Note, if the solution stepsize is larger than the window length, then the voltage will be assumed to have been constant over the time-frame specified by the window length.
DSS property name: avgwindowlen, DSS property index: 7
|
inline |
Base Frequency for ratings.
DSS property name: basefreq, DSS property index: 33
|
inline |
Combination of smart inverter functions in which the InvControl will control the PC elements in DERList, according to the options below:
Must be a combination of the following: {VV_VW | VV_DRC}. Default is to not set this property, in which case the single control mode in Mode is active.
In combined VV_VW mode, both volt-var and volt-watt control modes are active simultaneously. See help individually for volt-var mode and volt-watt mode in Mode property. Note that the PVSystem/Storage will attempt to achieve both the volt-watt and volt-var set-points based on the capabilities of the inverter in the PVSystem/Storage (kVA rating, etc), any limits set on maximum active power,
In combined VV_DRC, both the volt-var and the dynamic reactive current modes are simultaneously active.
DSS property name: CombiMode, DSS property index: 3
|
inline |
Combination of smart inverter functions in which the InvControl will control the PC elements in DERList, according to the options below:
Must be a combination of the following: {VV_VW | VV_DRC}. Default is to not set this property, in which case the single control mode in Mode is active.
In combined VV_VW mode, both volt-var and volt-watt control modes are active simultaneously. See help individually for volt-var mode and volt-watt mode in Mode property. Note that the PVSystem/Storage will attempt to achieve both the volt-watt and volt-var set-points based on the capabilities of the inverter in the PVSystem/Storage (kVA rating, etc), any limits set on maximum active power,
In combined VV_DRC, both the volt-var and the dynamic reactive current modes are simultaneously active.
DSS property name: CombiMode, DSS property index: 3
|
inline |
Required for the dynamic reactive current mode (DYNAMICREACCURR), and defaults to 1.05 per-unit voltage (referenced to the PVSystem object rated voltage or a windowed average value).
This parameter is the maximum voltage that defines the voltage dead-band within which no reactive power is allowed to be generated.
DSS property name: DbVMax, DSS property index: 10
|
inline |
Required for the dynamic reactive current mode (DYNAMICREACCURR), and defaults to 0.95 per-unit voltage (referenced to the PVSystem/Storage object rated voltage or a windowed average value).
This parameter is the minimum voltage that defines the voltage dead-band within which no reactive power is allowed to be generated.
DSS property name: DbVMin, DSS property index: 9
|
inline |
Required for the VOLTWATT modes.
Defaults to -1.0.
Defining -1.0, OpenDSS takes care internally of delta_P itself. It tries to improve convergence as well as speed up process
Defining between 0.05 and 1.0, it sets the maximum change (in unit of the y-axis) from the prior active power output level to the desired active power output level during each control iteration.
If numerical instability is noticed in solutions such as active power changing substantially from one control iteration to the next and/or voltages oscillating between two values with some separation, this is an indication of numerical instability (use the EventLog to diagnose).
If the maximum control iterations are exceeded, and no numerical instability is seen in the EventLog of via monitors, then try increasing the value of this parameter to reduce the number of control iterations needed to achieve the control criteria, and move to the power flow solution.
DSS property name: deltaP_Factor, DSS property index: 21
|
inline |
Required for the VOLTVAR and DYNAMICREACCURR modes.
Defaults to -1.0.
Defining -1.0, OpenDSS takes care internally of delta_Q itself. It tries to improve convergence as well as speed up process
Sets the maximum change (in per unit) from the prior var output level to the desired var output level during each control iteration.
if numerical instability is noticed in solutions such as var sign changing from one control iteration to the next and voltages oscillating between two values with some separation, this is an indication of numerical instability (use the EventLog to diagnose).
if the maximum control iterations are exceeded, and no numerical instability is seen in the EventLog of via monitors, then try increasing the value of this parameter to reduce the number of control iterations needed to achieve the control criteria, and move to the power flow solution.
DSS property name: deltaQ_Factor, DSS property index: 14
|
inline |
Array list of PVSystem and/or Storage elements to be controlled.
If not specified, all PVSystem and Storage in the circuit are assumed to be controlled by this control.
No capability of hierarchical control between two controls for a single element is implemented at this time.
DSS property name: DERList, DSS property index: 1
|
inline |
Required for the dynamic reactive current mode (DYNAMICREACCURR), and defaults to 1 seconds (1s).
do not use a value smaller than 1.0
Sets the length of the averaging window over which the average PVSystem/Storage terminal voltage is calculated for the dynamic reactive current mode.
Units are indicated by appending s, m, or h to the integer value.
Typically this will be a shorter averaging window than the volt-var and volt-watt averaging window.
The averaging window will calculate the average PVSystem/Storage terminal voltage over the specified period of time, up to and including the last power flow solution. Note, if the solution stepsize is larger than the window length, then the voltage will be assumed to have been constant over the time-frame specified by the window length.
DSS property name: DynReacavgwindowlen, DSS property index: 13
|
inline |
{Yes|No or True|False} Indicates whether this element is enabled.
DSS property name: enabled, DSS property index: 34
|
inline |
{Yes/True* | No/False} Default is YES for InvControl.
Log control actions to Eventlog.
DSS property name: EventLog, DSS property index: 22
|
inline |
Required for VOLTVAR mode, and defaults to 0.
for the times when the terminal voltage is decreasing, this is the off-set in per-unit voltage of a curve whose shape is the same as vvc_curve. It is offset by a certain negative value of per-unit voltage, which is defined by the base quantity for the x-axis of the volt-var curve (see help for voltage_curvex_ref)
if the PVSystem/Storage terminal voltage has been increasing, and has not changed directions, utilize vvc_curve1 for the volt-var response.
if the PVSystem/Storage terminal voltage has been increasing and changes directions and begins to decrease, then move from utilizing vvc_curve1 to a volt-var curve of the same shape, but offset by a certain per-unit voltage value.
Maintain the same per-unit available var output level (unless head-room has changed due to change in active power or kva rating of PVSystem/Storage). Per-unit var values remain the same for this internally constructed second curve (hysteresis curve).
if the terminal voltage has been decreasing and changes directions and begins to increase , then move from utilizing the offset curve, back to the vvc_curve1 for volt-var response, but stay at the same per-unit available vars output level.
DSS property name: hysteresis_offset, DSS property index: 5
|
inline |
Make like another object, e.g.
:
New Capacitor.C2 like=c1 ...
DSS property name: like, DSS property index: 35
|
inline |
Make like another object, e.g.
:
New Capacitor.C2 like=c1 ...
DSS property name: like, DSS property index: 35
|
inline |
Not required.
Defaults to 0 seconds.
Filter time constant of the LPF option of the RateofChangeMode property. The time constant will cause the low-pass filter to achieve 95% of the target value in 3 time constants.
DSS property name: LPFTau, DSS property index: 19
|
inline |
Smart inverter function in which the InvControl will control the PC elements specified in DERList, according to the options below:
Must be one of: {VOLTVAR* | VOLTWATT | DYNAMICREACCURR | WATTPF | WATTVAR} if the user desires to use modes simultaneously, then set the CombiMode property. Setting the Mode to any valid value disables combination mode.
In volt-var mode (Default). This mode attempts to CONTROL the vars, according to one or two volt-var curves, depending on the monitored voltages, present active power output, and the capabilities of the PVSystem/Storage.
In volt-watt mode. This mode attempts to LIMIT the watts, according to one defined volt-watt curve, depending on the monitored voltages and the capabilities of the PVSystem/Storage.
In dynamic reactive current mode. This mode attempts to increasingly counter deviations by CONTROLLING vars, depending on the monitored voltages, present active power output, and the capabilities of the of the PVSystem/Storage.
In watt-pf mode. This mode attempts to CONTROL the vars, according to a watt-pf curve, depending on the present active power output, and the capabilities of the PVSystem/Storage.
In watt-var mode. This mode attempts to CONTROL the vars, according to a watt-var curve, depending on the present active power output, and the capabilities of the PVSystem/Storage.
DSS property name: Mode, DSS property index: 2
|
inline |
Smart inverter function in which the InvControl will control the PC elements specified in DERList, according to the options below:
Must be one of: {VOLTVAR* | VOLTWATT | DYNAMICREACCURR | WATTPF | WATTVAR} if the user desires to use modes simultaneously, then set the CombiMode property. Setting the Mode to any valid value disables combination mode.
In volt-var mode (Default). This mode attempts to CONTROL the vars, according to one or two volt-var curves, depending on the monitored voltages, present active power output, and the capabilities of the PVSystem/Storage.
In volt-watt mode. This mode attempts to LIMIT the watts, according to one defined volt-watt curve, depending on the monitored voltages and the capabilities of the PVSystem/Storage.
In dynamic reactive current mode. This mode attempts to increasingly counter deviations by CONTROLLING vars, depending on the monitored voltages, present active power output, and the capabilities of the of the PVSystem/Storage.
In watt-pf mode. This mode attempts to CONTROL the vars, according to a watt-pf curve, depending on the present active power output, and the capabilities of the PVSystem/Storage.
In watt-var mode. This mode attempts to CONTROL the vars, according to a watt-var curve, depending on the present active power output, and the capabilities of the PVSystem/Storage.
DSS property name: Mode, DSS property index: 2
|
inline |
Name of monitored bus used by the voltage-dependente control modes.
Default is bus of the controlled PVSystem/Storage or Storage.
DSS property name: monBus, DSS property index: 26
|
inline |
Array list of rated voltages of the buses and their nodes presented in the monBus property.
This list may have different line-to-line and/or line-to-ground voltages.
DSS property name: MonBusesVbase, DSS property index: 27
|
inline |
Number of the phase being monitored or one of {AVG | MAX | MIN} for all phases.
Default=AVG.
DSS property name: monVoltageCalc, DSS property index: 25
|
inline |
Number of the phase being monitored or one of {AVG | MAX | MIN} for all phases.
Default=AVG.
DSS property name: monVoltageCalc, DSS property index: 25
|
inline |
Deprecated, use DERList instead.
DSS property name: PVSystemList, DSS property index: 31
|
inline |
Required for VOLTWATT and VOLTVAR mode.
Must be one of: {INACTIVE* | LPF | RISEFALL }. The default is INACTIVE.
Auxiliary option that aims to limit the changes of the desired reactive power and the active power limit between time steps, the alternatives are listed below:
INACTIVE. It indicates there is no limit on rate of change imposed for either active or reactive power output.
LPF. A low-pass RC filter is applied to the desired reactive power and/or the active power limit to determine the output power as a function of a time constant defined in the LPFTau property.
RISEFALL. A rise and fall limit in the change of active and/or reactive power expressed in terms of pu power per second, defined in the RiseFallLimit, is applied to the desired reactive power and/or the active power limit.
DSS property name: RateofChangeMode, DSS property index: 18
|
inline |
Required for VOLTWATT and VOLTVAR mode.
Must be one of: {INACTIVE* | LPF | RISEFALL }. The default is INACTIVE.
Auxiliary option that aims to limit the changes of the desired reactive power and the active power limit between time steps, the alternatives are listed below:
INACTIVE. It indicates there is no limit on rate of change imposed for either active or reactive power output.
LPF. A low-pass RC filter is applied to the desired reactive power and/or the active power limit to determine the output power as a function of a time constant defined in the LPFTau property.
RISEFALL. A rise and fall limit in the change of active and/or reactive power expressed in terms of pu power per second, defined in the RiseFallLimit, is applied to the desired reactive power and/or the active power limit.
DSS property name: RateofChangeMode, DSS property index: 18
|
inline |
Required for any mode that has VOLTVAR, DYNAMICREACCURR and WATTVAR.
Defaults to VARAVAL.
Defines the base reactive power for both the provided and absorbed reactive power, according to one of the following options:
VARAVAL. The base values for the provided and absorbed reactive power are equal to the available reactive power.
VARMAX: The base values of the provided and absorbed reactive power are equal to the value defined in the kvarMax and kvarMaxAbs properties, respectively.
DSS property name: RefReactivePower, DSS property index: 23
|
inline |
Required for any mode that has VOLTVAR, DYNAMICREACCURR and WATTVAR.
Defaults to VARAVAL.
Defines the base reactive power for both the provided and absorbed reactive power, according to one of the following options:
VARAVAL. The base values for the provided and absorbed reactive power are equal to the available reactive power.
VARMAX: The base values of the provided and absorbed reactive power are equal to the value defined in the kvarMax and kvarMaxAbs properties, respectively.
DSS property name: RefReactivePower, DSS property index: 23
|
inline |
Not required.
Defaults to no limit (-1). Must be -1 (no limit) or a positive value.
Limit in power in pu per second used by the RISEFALL option of the RateofChangeMode property.The base value for this ramp is defined in the RefReactivePower property and/or in VoltwattYAxis.
DSS property name: RiseFallLimit, DSS property index: 20
|
inline |
Required for VOLTVAR and DYNAMICREACCURR modes.
Defaults to 0.025 per unit of the base provided or absorbed reactive power described in the RefReactivePower property This parameter should only be modified by advanced users of the InvControl.
Tolerance in pu of the convergence of the control loop associated with reactive power. For the same control iteration, this value is compared to the difference, as an absolute value (without sign), between the desired reactive power value in pu and the output reactive power in pu of the controlled element.
This reactive power tolerance value plus the voltage tolerance value (VoltageChangeTolerance) determine, together, when to stop control iterations by the InvControl.
If an InvControl is controlling more than one PVSystem/Storage, each PVSystem/Storage has this quantity calculated independently, and so an individual PVSystem/Storage may reach the tolerance within different numbers of control iterations.
DSS property name: VarChangeTolerance, DSS property index: 16
|
inline |
Required for VOLTVAR and VOLTWATT modes, and defaults to rated.
Possible values are: {rated|avg|ravg}.
Defines whether the x-axis values (voltage in per unit) for vvc_curve1 and the volt-watt curve corresponds to:
rated. The rated voltage for the PVSystem/Storage object (1.0 in the volt-var curve equals rated voltage).
avg. The average terminal voltage recorded over a certain number of prior power-flow solutions. with the avg setting, 1.0 per unit on the x-axis of the volt-var curve(s) corresponds to the average voltage. from a certain number of prior intervals. See avgwindowlen parameter.
ravg. Same as avg, with the exception that the avgerage terminal voltage is divided by the rated voltage.
DSS property name: voltage_curvex_ref, DSS property index: 6
|
inline |
Required for VOLTVAR and VOLTWATT modes, and defaults to rated.
Possible values are: {rated|avg|ravg}.
Defines whether the x-axis values (voltage in per unit) for vvc_curve1 and the volt-watt curve corresponds to:
rated. The rated voltage for the PVSystem/Storage object (1.0 in the volt-var curve equals rated voltage).
avg. The average terminal voltage recorded over a certain number of prior power-flow solutions. with the avg setting, 1.0 per unit on the x-axis of the volt-var curve(s) corresponds to the average voltage. from a certain number of prior intervals. See avgwindowlen parameter.
ravg. Same as avg, with the exception that the avgerage terminal voltage is divided by the rated voltage.
DSS property name: voltage_curvex_ref, DSS property index: 6
|
inline |
Defaults to 0.0001 per-unit voltage.
This parameter should only be modified by advanced users of the InvControl.
Tolerance in pu of the control loop convergence associated to the monitored voltage in pu. This value is compared with the difference of the monitored voltage in pu of the current and previous control iterations of the control loop
This voltage tolerance value plus the var/watt tolerance value (VarChangeTolerance/ActivePChangeTolerance) determine, together, when to stop control iterations by the InvControl.
If an InvControl is controlling more than one PVSystem/Storage, each PVSystem/Storage has this quantity calculated independently, and so an individual PVSystem/Storage may reach the tolerance within different numbers of control iterations.
DSS property name: VoltageChangeTolerance, DSS property index: 15
|
inline |
Required for VOLTWATT mode.
Name of the XYCurve object containing the volt-watt curve.
Units for the x-axis are per-unit voltage, which may be in per unit of the rated voltage for the PVSystem/Storage, or may be in per unit of the average voltage at the terminals over a user-defined number of prior solutions.
Units for the y-axis are either in one of the options described in the VoltwattYAxis property.
DSS property name: voltwatt_curve, DSS property index: 8
|
inline |
Required for VOLTWATT mode.
Name of the XYCurve object containing the volt-watt curve.
Units for the x-axis are per-unit voltage, which may be in per unit of the rated voltage for the PVSystem/Storage, or may be in per unit of the average voltage at the terminals over a user-defined number of prior solutions.
Units for the y-axis are either in one of the options described in the VoltwattYAxis property.
DSS property name: voltwatt_curve, DSS property index: 8
|
inline |
Required for VOLTWATT mode for Storage element in CHARGING state.
The name of an XYCurve object that describes the variation in active power output (in per unit of maximum active power outut for the Storage).
Units for the x-axis are per-unit voltage, which may be in per unit of the rated voltage for the Storage, or may be in per unit of the average voltage at the terminals over a user-defined number of prior solutions.
Units for the y-axis are either in: (1) per unit of maximum active power output capability of the Storage, or (2) maximum available active power output capability (defined by the parameter: VoltwattYAxis), corresponding to the terminal voltage (x-axis value in per unit).
No default – must be specified for VOLTWATT mode for Storage element in CHARGING state.
DSS property name: voltwattCH_curve, DSS property index: 28
|
inline |
Required for VOLTWATT mode for Storage element in CHARGING state.
The name of an XYCurve object that describes the variation in active power output (in per unit of maximum active power outut for the Storage).
Units for the x-axis are per-unit voltage, which may be in per unit of the rated voltage for the Storage, or may be in per unit of the average voltage at the terminals over a user-defined number of prior solutions.
Units for the y-axis are either in: (1) per unit of maximum active power output capability of the Storage, or (2) maximum available active power output capability (defined by the parameter: VoltwattYAxis), corresponding to the terminal voltage (x-axis value in per unit).
No default – must be specified for VOLTWATT mode for Storage element in CHARGING state.
DSS property name: voltwattCH_curve, DSS property index: 28
|
inline |
Required for VOLTWATT mode.
Must be one of: {PMPPPU* | PAVAILABLEPU| PCTPMPPPU | KVARATINGPU}. The default is PMPPPU.
Units for the y-axis of the volt-watt curve while in volt-watt mode.
When set to PMPPPU. The y-axis corresponds to the value in pu of Pmpp property of the PVSystem.
When set to PAVAILABLEPU. The y-axis corresponds to the value in pu of the available active power of the PVSystem.
When set to PCTPMPPPU. The y-axis corresponds to the value in pu of the power Pmpp multiplied by 1/100 of the Pmpp property of the PVSystem.
When set to KVARATINGPU. The y-axis corresponds to the value in pu of the kVA property of the PVSystem.
DSS property name: VoltwattYAxis, DSS property index: 17
|
inline |
Required for VOLTWATT mode.
Must be one of: {PMPPPU* | PAVAILABLEPU| PCTPMPPPU | KVARATINGPU}. The default is PMPPPU.
Units for the y-axis of the volt-watt curve while in volt-watt mode.
When set to PMPPPU. The y-axis corresponds to the value in pu of Pmpp property of the PVSystem.
When set to PAVAILABLEPU. The y-axis corresponds to the value in pu of the available active power of the PVSystem.
When set to PCTPMPPPU. The y-axis corresponds to the value in pu of the power Pmpp multiplied by 1/100 of the Pmpp property of the PVSystem.
When set to KVARATINGPU. The y-axis corresponds to the value in pu of the kVA property of the PVSystem.
DSS property name: VoltwattYAxis, DSS property index: 17
|
inline |
Required for Active Voltage Regulation (AVR).
DSS property name: Vsetpoint, DSS property index: 32
|
inline |
Required for VOLTVAR mode.
Name of the XYCurve object containing the volt-var curve. The positive values of the y-axis of the volt-var curve represent values in pu of the provided base reactive power. The negative values of the y-axis are values in pu of the absorbed base reactive power. Provided and absorbed base reactive power values are defined in the RefReactivePower property
Units for the x-axis are per-unit voltage, which may be in per unit of the rated voltage for the PVSystem/Storage, or may be in per unit of the average voltage at the terminals over a user-defined number of prior solutions.
DSS property name: vvc_curve1, DSS property index: 4
|
inline |
Required for VOLTVAR mode.
Name of the XYCurve object containing the volt-var curve. The positive values of the y-axis of the volt-var curve represent values in pu of the provided base reactive power. The negative values of the y-axis are values in pu of the absorbed base reactive power. Provided and absorbed base reactive power values are defined in the RefReactivePower property
Units for the x-axis are per-unit voltage, which may be in per unit of the rated voltage for the PVSystem/Storage, or may be in per unit of the average voltage at the terminals over a user-defined number of prior solutions.
DSS property name: vvc_curve1, DSS property index: 4
|
inline |
Required for WATTPF mode.
Name of the XYCurve object containing the watt-pf curve. The positive values of the y-axis are positive power factor values. The negative values of the the y-axis are negative power factor values. When positive, the output reactive power has the same direction of the output active power, and when negative, it has the opposite direction. Units for the x-axis are per-unit output active power, and the base active power is the Pmpp for PVSystem and kWrated for Storage.
The y-axis represents the power factor and the reference is power factor equal to 0.
For example, if the user wants to define the following XY coordinates: (0, 0.9); (0.2, 0.9); (0.5, -0.9); (1, -0.9). Try to plot them considering the y-axis reference equal to unity power factor.
The user needs to translate this curve into a plot in which the y-axis reference is equal to 0 power factor.It means that two new XY coordinates need to be included, in this case they are: (0.35, 1); (0.35, -1). Try to plot them considering the y-axis reference equal to 0 power factor. The discontinity in 0.35pu is not a problem since var is zero for either power factor equal to 1 or -1.
DSS property name: wattpf_curve, DSS property index: 29
|
inline |
Required for WATTPF mode.
Name of the XYCurve object containing the watt-pf curve. The positive values of the y-axis are positive power factor values. The negative values of the the y-axis are negative power factor values. When positive, the output reactive power has the same direction of the output active power, and when negative, it has the opposite direction. Units for the x-axis are per-unit output active power, and the base active power is the Pmpp for PVSystem and kWrated for Storage.
The y-axis represents the power factor and the reference is power factor equal to 0.
For example, if the user wants to define the following XY coordinates: (0, 0.9); (0.2, 0.9); (0.5, -0.9); (1, -0.9). Try to plot them considering the y-axis reference equal to unity power factor.
The user needs to translate this curve into a plot in which the y-axis reference is equal to 0 power factor.It means that two new XY coordinates need to be included, in this case they are: (0.35, 1); (0.35, -1). Try to plot them considering the y-axis reference equal to 0 power factor. The discontinity in 0.35pu is not a problem since var is zero for either power factor equal to 1 or -1.
DSS property name: wattpf_curve, DSS property index: 29
|
inline |
Required for WATTVAR mode.
Name of the XYCurve object containing the watt-var curve. The positive values of the y-axis of the watt-var curve represent values in pu of the provided base reactive power. The negative values of the y-axis are values in pu of the absorbed base reactive power. Provided and absorbed base reactive power values are defined in the RefReactivePower property.
Units for the x-axis are per-unit output active power, and the base active power is the Pmpp for PVSystem and kWrated for Storage.
DSS property name: wattvar_curve, DSS property index: 30
|
inline |
Required for WATTVAR mode.
Name of the XYCurve object containing the watt-var curve. The positive values of the y-axis of the watt-var curve represent values in pu of the provided base reactive power. The negative values of the y-axis are values in pu of the absorbed base reactive power. Provided and absorbed base reactive power values are defined in the RefReactivePower property.
Units for the x-axis are per-unit output active power, and the base active power is the Pmpp for PVSystem and kWrated for Storage.
DSS property name: wattvar_curve, DSS property index: 30
1.9.3