Inheritance diagram for dss::obj::PVSystemBatch:

Collaboration diagram for dss::obj::PVSystemBatch:

Public Types
typedef PVSystem::Properties	Properties

typedef PVSystem	BatchElementClass

Public Member Functions
	PVSystemBatch (APIUtil *util)
	Create a batch of all PVSystem elements.

	PVSystemBatch (APIUtil *util, int32_t prop_idx, int32_t prop_value)
	Create a batch of all PVSystem elements that match an integer property value.

	PVSystemBatch (APIUtil util, const char regexp)
	Create a batch of all PVSystem elements that match a regular expression.

PVSystemBatch &	begin_edit ()

PVSystemBatch &	end_edit (int32_t num_edits=1)

BatchInt32ArrayProxy	phases ()
	Number of Phases, this PVSystem element. More...

PVSystemBatch &	phases (int32_t value)

template<typename T >
PVSystemBatch &	phases (T &value)

template<typename T >
PVSystemBatch &	phases (typename T::iterator it_begin, typename T::iterator it_end)

strings	bus1 ()
	Bus to which the PVSystem element is connected. More...

PVSystemBatch &	bus1 (const string &value)

PVSystemBatch &	bus1 (strings &value)

BatchFloat64ArrayProxy	kv ()
	Nominal rated (1.0 per unit) voltage, kV, for PVSystem element. More...

PVSystemBatch &	kv (double value)

template<typename T >
PVSystemBatch &	kv (T &value)

template<typename T >
PVSystemBatch &	kv (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	irradiance ()
	Get/set the present irradiance value in kW/sq-m. More...

PVSystemBatch &	irradiance (double value)

template<typename T >
PVSystemBatch &	irradiance (T &value)

template<typename T >
PVSystemBatch &	irradiance (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Pmpp ()
	Get/set the rated max power of the PV array for 1.0 kW/sq-m irradiance and a user-selected array temperature. More...

PVSystemBatch &	Pmpp (double value)

template<typename T >
PVSystemBatch &	Pmpp (T &value)

template<typename T >
PVSystemBatch &	Pmpp (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pctPmpp ()
	Upper limit on active power as a percentage of Pmpp. More...

PVSystemBatch &	pctPmpp (double value)

template<typename T >
PVSystemBatch &	pctPmpp (T &value)

template<typename T >
PVSystemBatch &	pctPmpp (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Temperature ()
	Get/set the present Temperature. More...

PVSystemBatch &	Temperature (double value)

template<typename T >
PVSystemBatch &	Temperature (T &value)

template<typename T >
PVSystemBatch &	Temperature (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pf ()
	Nominally, the power factor for the output power. More...

PVSystemBatch &	pf (double value)

template<typename T >
PVSystemBatch &	pf (T &value)

template<typename T >
PVSystemBatch &	pf (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	conn ()
	={wye\|LN\|delta\|LL}. More...

PVSystemBatch &	conn (string &value)

PVSystemBatch &	conn (int32_t value)

PVSystemBatch &	conn (Connection value)

PVSystemBatch &	conn (strings &value)

PVSystemBatch &	conn (std::vector< int32_t > &value)

PVSystemBatch &	conn (std::vector< Connection > &value)

strings	conn_str ()
	={wye\|LN\|delta\|LL}. More...

PVSystemBatch &	conn_str (string &value)

PVSystemBatch &	conn_str (strings &value)

BatchFloat64ArrayProxy	kvar ()
	Get/set the present kvar value. More...

PVSystemBatch &	kvar (double value)

template<typename T >
PVSystemBatch &	kvar (T &value)

template<typename T >
PVSystemBatch &	kvar (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	kVA ()
	kVA rating of inverter. More...

PVSystemBatch &	kVA (double value)

template<typename T >
PVSystemBatch &	kVA (T &value)

template<typename T >
PVSystemBatch &	kVA (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pctCutin ()
	% cut-in power – % of kVA rating of inverter. More...

PVSystemBatch &	pctCutin (double value)

template<typename T >
PVSystemBatch &	pctCutin (T &value)

template<typename T >
PVSystemBatch &	pctCutin (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pctCutout ()
	% cut-out power – % of kVA rating of inverter. More...

PVSystemBatch &	pctCutout (double value)

template<typename T >
PVSystemBatch &	pctCutout (T &value)

template<typename T >
PVSystemBatch &	pctCutout (typename T::iterator it_begin, typename T::iterator it_end)

strings	EffCurve ()
	An XYCurve object, previously defined, that describes the PER UNIT efficiency vs PER UNIT of rated kVA for the inverter. More...

PVSystemBatch &	EffCurve (dss::obj::XYcurve &value)

PVSystemBatch &	EffCurve (const string &value)

std::vector< dss::obj::XYcurve >	EffCurve_obj ()
	An XYCurve object, previously defined, that describes the PER UNIT efficiency vs PER UNIT of rated kVA for the inverter. More...

PVSystemBatch &	EffCurve_obj (dss::obj::XYcurve &value)

strings	PTCurve ()
	An XYCurve object, previously defined, that describes the PV array PER UNIT Pmpp vs Temperature curve. More...

PVSystemBatch &	PTCurve (dss::obj::XYcurve &value)

PVSystemBatch &	PTCurve (const string &value)

std::vector< dss::obj::XYcurve >	PTCurve_obj ()
	An XYCurve object, previously defined, that describes the PV array PER UNIT Pmpp vs Temperature curve. More...

PVSystemBatch &	PTCurve_obj (dss::obj::XYcurve &value)

BatchFloat64ArrayProxy	pctR ()
	Equivalent percent internal resistance, ohms. More...

PVSystemBatch &	pctR (double value)

template<typename T >
PVSystemBatch &	pctR (T &value)

template<typename T >
PVSystemBatch &	pctR (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pctX ()
	Equivalent percent internal reactance, ohms. More...

PVSystemBatch &	pctX (double value)

template<typename T >
PVSystemBatch &	pctX (T &value)

template<typename T >
PVSystemBatch &	pctX (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	model ()
	Integer code (default=1) for the model to use for power output variation with voltage. More...

PVSystemBatch &	model (int32_t value)

template<typename T >
PVSystemBatch &	model (T &value)

template<typename T >
PVSystemBatch &	model (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Vminpu ()
	Default = 0.90. More...

PVSystemBatch &	Vminpu (double value)

template<typename T >
PVSystemBatch &	Vminpu (T &value)

template<typename T >
PVSystemBatch &	Vminpu (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Vmaxpu ()
	Default = 1.10. More...

PVSystemBatch &	Vmaxpu (double value)

template<typename T >
PVSystemBatch &	Vmaxpu (T &value)

template<typename T >
PVSystemBatch &	Vmaxpu (typename T::iterator it_begin, typename T::iterator it_end)

bools	Balanced ()
	{Yes \| No*} Default is No. More...

PVSystemBatch &	Balanced (bool value)

PVSystemBatch &	Balanced (bools &value)

bools	LimitCurrent ()
	Limits current magnitude to Vminpu value for both 1-phase and 3-phase PVSystems similar to Generator Model 7. More...

PVSystemBatch &	LimitCurrent (bool value)

PVSystemBatch &	LimitCurrent (bools &value)

strings	yearly ()
	Dispatch shape to use for yearly simulations. More...

PVSystemBatch &	yearly (dss::obj::LoadShape &value)

PVSystemBatch &	yearly (const string &value)

std::vector< dss::obj::LoadShape >	yearly_obj ()
	Dispatch shape to use for yearly simulations. More...

PVSystemBatch &	yearly_obj (dss::obj::LoadShape &value)

strings	daily ()
	Dispatch shape to use for daily simulations. More...

PVSystemBatch &	daily (dss::obj::LoadShape &value)

PVSystemBatch &	daily (const string &value)

std::vector< dss::obj::LoadShape >	daily_obj ()
	Dispatch shape to use for daily simulations. More...

PVSystemBatch &	daily_obj (dss::obj::LoadShape &value)

strings	duty ()
	Load shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. More...

PVSystemBatch &	duty (dss::obj::LoadShape &value)

PVSystemBatch &	duty (const string &value)

std::vector< dss::obj::LoadShape >	duty_obj ()
	Load shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. More...

PVSystemBatch &	duty_obj (dss::obj::LoadShape &value)

strings	Tyearly ()
	Temperature shape to use for yearly simulations. More...

PVSystemBatch &	Tyearly (dss::obj::TShape &value)

PVSystemBatch &	Tyearly (const string &value)

std::vector< dss::obj::TShape >	Tyearly_obj ()
	Temperature shape to use for yearly simulations. More...

PVSystemBatch &	Tyearly_obj (dss::obj::TShape &value)

strings	Tdaily ()
	Temperature shape to use for daily simulations. More...

PVSystemBatch &	Tdaily (dss::obj::TShape &value)

PVSystemBatch &	Tdaily (const string &value)

std::vector< dss::obj::TShape >	Tdaily_obj ()
	Temperature shape to use for daily simulations. More...

PVSystemBatch &	Tdaily_obj (dss::obj::TShape &value)

strings	Tduty ()
	Temperature shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. More...

PVSystemBatch &	Tduty (dss::obj::TShape &value)

PVSystemBatch &	Tduty (const string &value)

std::vector< dss::obj::TShape >	Tduty_obj ()
	Temperature shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. More...

PVSystemBatch &	Tduty_obj (dss::obj::TShape &value)

BatchInt32ArrayProxy	cls ()
	An arbitrary integer number representing the class of PVSystem element so that PVSystem values may be segregated by class. More...

PVSystemBatch &	cls (int32_t value)

template<typename T >
PVSystemBatch &	cls (T &value)

template<typename T >
PVSystemBatch &	cls (typename T::iterator it_begin, typename T::iterator it_end)

strings	UserModel ()
	Name of DLL containing user-written model, which computes the terminal currents for Dynamics studies, overriding the default model. More...

PVSystemBatch &	UserModel (const string &value)

PVSystemBatch &	UserModel (strings &value)

strings	UserData ()
	String (in quotes or parentheses) that gets passed to user-written model for defining the data required for that model. More...

PVSystemBatch &	UserData (const string &value)

PVSystemBatch &	UserData (strings &value)

bools	debugtrace ()
	{Yes \| No } Default is no. More...

PVSystemBatch &	debugtrace (bool value)

PVSystemBatch &	debugtrace (bools &value)

bools	VarFollowInverter ()
	Boolean variable (Yes\|No) or (True\|False). More...

PVSystemBatch &	VarFollowInverter (bool value)

PVSystemBatch &	VarFollowInverter (bools &value)

BatchFloat64ArrayProxy	DutyStart ()
	Starting time offset [hours] into the duty cycle shape for this PVSystem, defaults to 0. More...

PVSystemBatch &	DutyStart (double value)

template<typename T >
PVSystemBatch &	DutyStart (T &value)

template<typename T >
PVSystemBatch &	DutyStart (typename T::iterator it_begin, typename T::iterator it_end)

bools	WattPriority ()
	{Yes/No*‍/True/False} Set inverter to watt priority instead of the default var priority More...

PVSystemBatch &	WattPriority (bool value)

PVSystemBatch &	WattPriority (bools &value)

bools	PFPriority ()
	{Yes/No*‍/True/False} Set inverter to operate with PF priority when in constant PF mode. More...

PVSystemBatch &	PFPriority (bool value)

PVSystemBatch &	PFPriority (bools &value)

BatchFloat64ArrayProxy	pctPminNoVars ()
	Minimum active power as percentage of Pmpp under which there is no vars production/absorption. More...

PVSystemBatch &	pctPminNoVars (double value)

template<typename T >
PVSystemBatch &	pctPminNoVars (T &value)

template<typename T >
PVSystemBatch &	pctPminNoVars (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pctPminkvarMax ()
	Minimum active power as percentage of Pmpp that allows the inverter to produce/absorb reactive power up to its kvarMax or kvarMaxAbs. More...

PVSystemBatch &	pctPminkvarMax (double value)

template<typename T >
PVSystemBatch &	pctPminkvarMax (T &value)

template<typename T >
PVSystemBatch &	pctPminkvarMax (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	kvarMax ()
	Indicates the maximum reactive power GENERATION (un-signed numerical variable in kvar) for the inverter (as an un-signed value). More...

PVSystemBatch &	kvarMax (double value)

template<typename T >
PVSystemBatch &	kvarMax (T &value)

template<typename T >
PVSystemBatch &	kvarMax (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	kvarMaxAbs ()
	Indicates the maximum reactive power ABSORPTION (un-signed numerical variable in kvar) for the inverter (as an un-signed value). More...

PVSystemBatch &	kvarMaxAbs (double value)

template<typename T >
PVSystemBatch &	kvarMaxAbs (T &value)

template<typename T >
PVSystemBatch &	kvarMaxAbs (typename T::iterator it_begin, typename T::iterator it_end)

strings	spectrum ()
	Name of harmonic voltage or current spectrum for this PVSystem element. More...

PVSystemBatch &	spectrum (dss::obj::Spectrum &value)

PVSystemBatch &	spectrum (const string &value)

std::vector< dss::obj::Spectrum >	spectrum_obj ()
	Name of harmonic voltage or current spectrum for this PVSystem element. More...

PVSystemBatch &	spectrum_obj (dss::obj::Spectrum &value)

BatchFloat64ArrayProxy	basefreq ()
	Base Frequency for ratings. More...

PVSystemBatch &	basefreq (double value)

template<typename T >
PVSystemBatch &	basefreq (T &value)

template<typename T >
PVSystemBatch &	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...

PVSystemBatch &	enabled (bool value)

PVSystemBatch &	enabled (bools &value)

PVSystemBatch &	like (const string &value)
	Make like another object, e.g. More...

PVSystemBatch &	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)

Member Function Documentation

◆ Balanced()

bools dss::obj::PVSystemBatch::Balanced ( )

inline

{Yes | No*} Default is No.

Force balanced current only for 3-phase PVSystems. Forces zero- and negative-sequence to zero.

DSS property name: Balanced, DSS property index: 21

◆ basefreq()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 42

◆ bus1()

strings dss::obj::PVSystemBatch::bus1 ( )

inline

Bus to which the PVSystem element is connected.

May include specific node specification.

DSS property name: bus1, DSS property index: 2

◆ cls()

BatchInt32ArrayProxy dss::obj::PVSystemBatch::cls ( )

inline

An arbitrary integer number representing the class of PVSystem element so that PVSystem values may be segregated by class.

DSS property name: class, DSS property index: 29

◆ conn()

BatchInt32ArrayProxy dss::obj::PVSystemBatch::conn ( )

inline

={wye|LN|delta|LL}.

Default is wye.

DSS property name: conn, DSS property index: 9

◆ conn_str()

strings dss::obj::PVSystemBatch::conn_str ( )

inline

={wye|LN|delta|LL}.

Default is wye.

DSS property name: conn, DSS property index: 9

◆ daily()

strings dss::obj::PVSystemBatch::daily ( )

inline

Dispatch shape to use for daily simulations.

Must be previously defined as a Loadshape object of 24 hrs, typically. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

DSS property name: daily, DSS property index: 24

◆ daily_obj()

std::vector< dss::obj::LoadShape > dss::obj::PVSystemBatch::daily_obj ( )

inline

Dispatch shape to use for daily simulations.

Must be previously defined as a Loadshape object of 24 hrs, typically. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

DSS property name: daily, DSS property index: 24

◆ debugtrace()

bools dss::obj::PVSystemBatch::debugtrace ( )

inline

{Yes | No } Default is no.

Turn this on to capture the progress of the PVSystem model for each iteration. Creates a separate file for each PVSystem element named "PVSystem_name.CSV".

DSS property name: debugtrace, DSS property index: 32

◆ duty()

strings dss::obj::PVSystemBatch::duty ( )

inline

Load shape to use for duty cycle dispatch simulations such as for solar ramp rate studies.

Must be previously defined as a Loadshape object. Typically would have time intervals of 1-5 seconds. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.

DSS property name: duty, DSS property index: 25

◆ duty_obj()

std::vector< dss::obj::LoadShape > dss::obj::PVSystemBatch::duty_obj ( )

inline

Load shape to use for duty cycle dispatch simulations such as for solar ramp rate studies.

Must be previously defined as a Loadshape object. Typically would have time intervals of 1-5 seconds. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.

DSS property name: duty, DSS property index: 25

◆ DutyStart()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::DutyStart ( )

inline

Starting time offset [hours] into the duty cycle shape for this PVSystem, defaults to 0.

DSS property name: DutyStart, DSS property index: 34

◆ EffCurve()

strings dss::obj::PVSystemBatch::EffCurve ( )

inline

An XYCurve object, previously defined, that describes the PER UNIT efficiency vs PER UNIT of rated kVA for the inverter.

Inverter output power is discounted by the multiplier obtained from this curve.

DSS property name: EffCurve, DSS property index: 14

◆ EffCurve_obj()

std::vector< dss::obj::XYcurve > dss::obj::PVSystemBatch::EffCurve_obj ( )

inline

An XYCurve object, previously defined, that describes the PER UNIT efficiency vs PER UNIT of rated kVA for the inverter.

Inverter output power is discounted by the multiplier obtained from this curve.

DSS property name: EffCurve, DSS property index: 14

◆ enabled()

bools dss::obj::PVSystemBatch::enabled ( )

inline

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 43

◆ irradiance()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::irradiance ( )

inline

Get/set the present irradiance value in kW/sq-m.

Used as base value for shape multipliers. Generally entered as peak value for the time period of interest and the yearly, daily, and duty load shape objects are defined as per unit multipliers (just like Loads/Generators).

DSS property name: irradiance, DSS property index: 4

◆ kv()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::kv ( )

inline

Nominal rated (1.0 per unit) voltage, kV, for PVSystem element.

For 2- and 3-phase PVSystem elements, specify phase-phase kV. Otherwise, specify actual kV across each branch of the PVSystem element. If 1-phase wye (star or LN), specify phase-neutral kV. If 1-phase delta or phase-phase connected, specify phase-phase kV.

DSS property name: kv, DSS property index: 3

◆ kVA()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::kVA ( )

inline

kVA rating of inverter.

Used as the base for Dynamics mode and Harmonics mode values.

DSS property name: kVA, DSS property index: 11

◆ kvar()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::kvar ( )

inline

Get/set the present kvar value.

Setting this property forces the inverter to operate in constant kvar mode.

DSS property name: kvar, DSS property index: 10

◆ kvarMax()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::kvarMax ( )

inline

Indicates the maximum reactive power GENERATION (un-signed numerical variable in kvar) for the inverter (as an un-signed value).

Defaults to kVA rating of the inverter.

DSS property name: kvarMax, DSS property index: 39

◆ kvarMaxAbs()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::kvarMaxAbs ( )

inline

Indicates the maximum reactive power ABSORPTION (un-signed numerical variable in kvar) for the inverter (as an un-signed value).

Defaults to kVA rating of the inverter.

DSS property name: kvarMaxAbs, DSS property index: 40

◆ like() [1/2]

PVSystemBatch & dss::obj::PVSystemBatch::like ( const char * value )

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 44

◆ like() [2/2]

PVSystemBatch & dss::obj::PVSystemBatch::like ( const string & value )

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 44

◆ LimitCurrent()

bools dss::obj::PVSystemBatch::LimitCurrent ( )

inline

Limits current magnitude to Vminpu value for both 1-phase and 3-phase PVSystems similar to Generator Model 7.

For 3-phase, limits the positive-sequence current but not the negative-sequence.

DSS property name: LimitCurrent, DSS property index: 22

◆ model()

BatchInt32ArrayProxy dss::obj::PVSystemBatch::model ( )

inline

Integer code (default=1) for the model to use for power output variation with voltage.

Valid values are:

1:PVSystem element injects a CONSTANT kW at specified power factor. 2:PVSystem element is modeled as a CONSTANT ADMITTANCE. 3:Compute load injection from User-written Model.

DSS property name: model, DSS property index: 18

◆ pctCutin()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::pctCutin ( )

inline

% cut-in power – % of kVA rating of inverter.

When the inverter is OFF, the power from the array must be greater than this for the inverter to turn on.

DSS property name: Cutin, DSS property index: 12

◆ pctCutout()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::pctCutout ( )

inline

% cut-out power – % of kVA rating of inverter.

When the inverter is ON, the inverter turns OFF when the power from the array drops below this value.

DSS property name: Cutout, DSS property index: 13

◆ pctPminkvarMax()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::pctPminkvarMax ( )

inline

Minimum active power as percentage of Pmpp that allows the inverter to produce/absorb reactive power up to its kvarMax or kvarMaxAbs.

DSS property name: PminkvarMax, DSS property index: 38

◆ pctPminNoVars()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::pctPminNoVars ( )

inline

Minimum active power as percentage of Pmpp under which there is no vars production/absorption.

DSS property name: PminNoVars, DSS property index: 37

◆ pctPmpp()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::pctPmpp ( )

inline

Upper limit on active power as a percentage of Pmpp.

DSS property name: Pmpp, DSS property index: 6

◆ pctR()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::pctR ( )

inline

Equivalent percent internal resistance, ohms.

Default is 50%. Placed in series with internal voltage source for harmonics and dynamics modes. (Limits fault current to about 2 pu if not current limited – see LimitCurrent)

DSS property name: R, DSS property index: 16

◆ pctX()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::pctX ( )

inline

Equivalent percent internal reactance, ohms.

Default is 0%. Placed in series with internal voltage source for harmonics and dynamics modes.

DSS property name: X, DSS property index: 17

◆ pf()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::pf ( )

inline

Nominally, the power factor for the output power.

Default is 1.0. Setting this property will cause the inverter to operate in constant power factor mode.Enter negative when kW and kvar have opposite signs. A positive power factor signifies that the PVSystem element produces vars as is typical for a generator.

DSS property name: pf, DSS property index: 8

◆ PFPriority()

bools dss::obj::PVSystemBatch::PFPriority ( )

inline

{Yes/No*‍/True/False} Set inverter to operate with PF priority when in constant PF mode.

If "Yes", value assigned to "WattPriority" is neglected. If controlled by an InvControl with either Volt-Var or DRC or both functions activated, PF priority is neglected and "WattPriority" is considered. Default = No.

DSS property name: PFPriority, DSS property index: 36

◆ phases()

BatchInt32ArrayProxy dss::obj::PVSystemBatch::phases ( )

inline

Number of Phases, this PVSystem element.

Power is evenly divided among phases.

DSS property name: phases, DSS property index: 1

◆ Pmpp()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::Pmpp ( )

inline

Get/set the rated max power of the PV array for 1.0 kW/sq-m irradiance and a user-selected array temperature.

The P-TCurve should be defined relative to the selected array temperature.

DSS property name: Pmpp, DSS property index: 5

◆ PTCurve()

strings dss::obj::PVSystemBatch::PTCurve ( )

inline

An XYCurve object, previously defined, that describes the PV array PER UNIT Pmpp vs Temperature curve.

Temperature units must agree with the Temperature property and the Temperature shapes used for simulations. The Pmpp values are specified in per unit of the Pmpp value for 1 kW/sq-m irradiance. The value for the temperature at which Pmpp is defined should be 1.0. The net array power is determined by the irradiance * Pmpp * f(Temperature)

DSS property name: P-TCurve, DSS property index: 15

◆ PTCurve_obj()

std::vector< dss::obj::XYcurve > dss::obj::PVSystemBatch::PTCurve_obj ( )

inline

An XYCurve object, previously defined, that describes the PV array PER UNIT Pmpp vs Temperature curve.

Temperature units must agree with the Temperature property and the Temperature shapes used for simulations. The Pmpp values are specified in per unit of the Pmpp value for 1 kW/sq-m irradiance. The value for the temperature at which Pmpp is defined should be 1.0. The net array power is determined by the irradiance * Pmpp * f(Temperature)

DSS property name: P-TCurve, DSS property index: 15

◆ spectrum()

strings dss::obj::PVSystemBatch::spectrum ( )

inline

Name of harmonic voltage or current spectrum for this PVSystem element.

A harmonic voltage source is assumed for the inverter. Default value is "default", which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 41

◆ spectrum_obj()

std::vector< dss::obj::Spectrum > dss::obj::PVSystemBatch::spectrum_obj ( )

inline

Name of harmonic voltage or current spectrum for this PVSystem element.

A harmonic voltage source is assumed for the inverter. Default value is "default", which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 41

◆ Tdaily()

strings dss::obj::PVSystemBatch::Tdaily ( )

inline

Temperature shape to use for daily simulations.

Must be previously defined as a TShape object of 24 hrs, typically. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: Tdaily, DSS property index: 27

◆ Tdaily_obj()

std::vector< dss::obj::TShape > dss::obj::PVSystemBatch::Tdaily_obj ( )

inline

Temperature shape to use for daily simulations.

Must be previously defined as a TShape object of 24 hrs, typically. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: Tdaily, DSS property index: 27

◆ Tduty()

strings dss::obj::PVSystemBatch::Tduty ( )

inline

Temperature shape to use for duty cycle dispatch simulations such as for solar ramp rate studies.

Must be previously defined as a TShape object. Typically would have time intervals of 1-5 seconds. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat. The PVSystem model uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: Tduty, DSS property index: 28

◆ Tduty_obj()

std::vector< dss::obj::TShape > dss::obj::PVSystemBatch::Tduty_obj ( )

inline

Temperature shape to use for duty cycle dispatch simulations such as for solar ramp rate studies.

Must be previously defined as a TShape object. Typically would have time intervals of 1-5 seconds. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat. The PVSystem model uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: Tduty, DSS property index: 28

◆ Temperature()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::Temperature ( )

inline

Get/set the present Temperature.

Used as fixed value corresponding to PTCurve property. A multiplier is obtained from the Pmpp-Temp curve and applied to the nominal Pmpp from the irradiance to determine the net array output.

DSS property name: Temperature, DSS property index: 7

◆ Tyearly()

strings dss::obj::PVSystemBatch::Tyearly ( )

inline

Temperature shape to use for yearly simulations.

Must be previously defined as a TShape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: Tyearly, DSS property index: 26

◆ Tyearly_obj()

std::vector< dss::obj::TShape > dss::obj::PVSystemBatch::Tyearly_obj ( )

inline

Temperature shape to use for yearly simulations.

Must be previously defined as a TShape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: Tyearly, DSS property index: 26

◆ UserData()

strings dss::obj::PVSystemBatch::UserData ( )

inline

String (in quotes or parentheses) that gets passed to user-written model for defining the data required for that model.

DSS property name: UserData, DSS property index: 31

◆ UserModel()

strings dss::obj::PVSystemBatch::UserModel ( )

inline

Name of DLL containing user-written model, which computes the terminal currents for Dynamics studies, overriding the default model.

Set to "none" to negate previous setting.

DSS property name: UserModel, DSS property index: 30

◆ VarFollowInverter()

bools dss::obj::PVSystemBatch::VarFollowInverter ( )

inline

Boolean variable (Yes|No) or (True|False).

Defaults to False which indicates that the reactive power generation/absorption does not respect the inverter status.When set to True, the PVSystem reactive power generation/absorption will cease when the inverter status is off, due to panel kW dropping below Cutout. The reactive power generation/absorption will begin again when the panel kW is above Cutin. When set to False, the PVSystem will generate/absorb reactive power regardless of the status of the inverter.

DSS property name: VarFollowInverter, DSS property index: 33

◆ Vmaxpu()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::Vmaxpu ( )

inline

Default = 1.10.

Maximum per unit voltage for which the Model is assumed to apply. Above this value, the load model reverts to a constant impedance model.

DSS property name: Vmaxpu, DSS property index: 20

◆ Vminpu()

BatchFloat64ArrayProxy dss::obj::PVSystemBatch::Vminpu ( )

inline

Default = 0.90.

Minimum per unit voltage for which the Model is assumed to apply. Below this value, the load model reverts to a constant impedance model except for Dynamics model. In Dynamics mode, the current magnitude is limited to the value the power flow would compute for this voltage.

DSS property name: Vminpu, DSS property index: 19

◆ WattPriority()

bools dss::obj::PVSystemBatch::WattPriority ( )

inline

{Yes/No*‍/True/False} Set inverter to watt priority instead of the default var priority

DSS property name: WattPriority, DSS property index: 35

◆ yearly()

strings dss::obj::PVSystemBatch::yearly ( )

inline

Dispatch shape to use for yearly simulations.

Must be previously defined as a Loadshape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

DSS property name: yearly, DSS property index: 23

◆ yearly_obj()

std::vector< dss::obj::LoadShape > dss::obj::PVSystemBatch::yearly_obj ( )

inline

Dispatch shape to use for yearly simulations.

Must be previously defined as a Loadshape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

DSS property name: yearly, DSS property index: 23

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

include/dss_obj.hpp

Public Types

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ Balanced()

◆ basefreq()

◆ bus1()

◆ cls()

◆ conn()

◆ conn_str()

◆ daily()

◆ daily_obj()

◆ debugtrace()

◆ duty()

◆ duty_obj()

◆ DutyStart()

◆ EffCurve()

◆ EffCurve_obj()

◆ enabled()

◆ irradiance()

◆ kv()

◆ kVA()

◆ kvar()

◆ kvarMax()

◆ kvarMaxAbs()

◆ like() [1/2]

◆ like() [2/2]

◆ LimitCurrent()

◆ model()

◆ pctCutin()

◆ pctCutout()

◆ pctPminkvarMax()

◆ pctPminNoVars()

◆ pctPmpp()

◆ pctR()

◆ pctX()

◆ pf()

◆ PFPriority()

◆ phases()

◆ Pmpp()

◆ PTCurve()

◆ PTCurve_obj()

◆ spectrum()

◆ spectrum_obj()

◆ Tdaily()

◆ Tdaily_obj()

◆ Tduty()

◆ Tduty_obj()

◆ Temperature()

◆ Tyearly()

◆ Tyearly_obj()

◆ UserData()

◆ UserModel()

◆ VarFollowInverter()

◆ Vmaxpu()

◆ Vminpu()

◆ WattPriority()

◆ yearly()

◆ yearly_obj()