Inheritance diagram for dss::obj::LoadBatch:

Collaboration diagram for dss::obj::LoadBatch:

Public Types
typedef Load::Properties	Properties

typedef Load	BatchElementClass

typedef Load::LoadModel	LoadModel

typedef Load::LoadStatus	LoadStatus

Public Member Functions
	LoadBatch (APIUtil *util)
	Create a batch of all Load elements.

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

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

LoadBatch &	begin_edit ()

LoadBatch &	end_edit (int32_t num_edits=1)

BatchInt32ArrayProxy	phases ()
	Number of Phases, this load. More...

LoadBatch &	phases (int32_t value)

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

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

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

LoadBatch &	bus1 (const string &value)

LoadBatch &	bus1 (strings &value)

BatchFloat64ArrayProxy	kV ()
	Nominal rated (1.0 per unit) voltage, kV, for load. More...

LoadBatch &	kV (double value)

template<typename T >
LoadBatch &	kV (T &value)

template<typename T >
LoadBatch &	kV (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	kW ()
	Total base kW for the load. More...

LoadBatch &	kW (double value)

template<typename T >
LoadBatch &	kW (T &value)

template<typename T >
LoadBatch &	kW (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pf ()
	Load power factor. More...

LoadBatch &	pf (double value)

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

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

BatchInt32ArrayProxy	model ()
	Integer code for the model to use for load variation with voltage. More...

LoadBatch &	model (int32_t value)

LoadBatch &	model (Load::LoadModel value)

strings	yearly ()
	LOADSHAPE object to use for yearly simulations. More...

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

LoadBatch &	yearly (const string &value)

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

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

strings	daily ()
	LOADSHAPE object to use for daily simulations. More...

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

LoadBatch &	daily (const string &value)

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

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

strings	duty ()
	LOADSHAPE object to use for duty cycle simulations. More...

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

LoadBatch &	duty (const string &value)

std::vector< dss::obj::LoadShape >	duty_obj ()
	LOADSHAPE object to use for duty cycle simulations. More...

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

strings	growth ()
	Characteristic to use for growth factors by years. More...

LoadBatch &	growth (dss::obj::GrowthShape &value)

LoadBatch &	growth (const string &value)

std::vector< dss::obj::GrowthShape >	growth_obj ()
	Characteristic to use for growth factors by years. More...

LoadBatch &	growth_obj (dss::obj::GrowthShape &value)

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

LoadBatch &	conn (string &value)

LoadBatch &	conn (int32_t value)

LoadBatch &	conn (Connection value)

LoadBatch &	conn (strings &value)

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

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

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

LoadBatch &	conn_str (string &value)

LoadBatch &	conn_str (strings &value)

BatchFloat64ArrayProxy	kvar ()
	Specify the base kvar for specifying load as kW & kvar. More...

LoadBatch &	kvar (double value)

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

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

BatchFloat64ArrayProxy	Rneut ()
	Default is -1. More...

LoadBatch &	Rneut (double value)

template<typename T >
LoadBatch &	Rneut (T &value)

template<typename T >
LoadBatch &	Rneut (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Xneut ()
	Neutral reactance of wye(star)-connected load in actual ohms. More...

LoadBatch &	Xneut (double value)

template<typename T >
LoadBatch &	Xneut (T &value)

template<typename T >
LoadBatch &	Xneut (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	status ()
	={Variable \| Fixed \| Exempt}. More...

LoadBatch &	status (string &value)

LoadBatch &	status (int32_t value)

LoadBatch &	status (Load::LoadStatus value)

LoadBatch &	status (strings &value)

LoadBatch &	status (std::vector< int32_t > &value)

LoadBatch &	status (std::vector< Load::LoadStatus > &value)

strings	status_str ()
	={Variable \| Fixed \| Exempt}. More...

LoadBatch &	status_str (string &value)

LoadBatch &	status_str (strings &value)

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

LoadBatch &	cls (int32_t value)

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

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

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

LoadBatch &	Vminpu (double value)

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

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

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

LoadBatch &	Vmaxpu (double value)

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

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

BatchFloat64ArrayProxy	Vminnorm ()
	Minimum per unit voltage for load EEN evaluations, Normal limit. More...

LoadBatch &	Vminnorm (double value)

template<typename T >
LoadBatch &	Vminnorm (T &value)

template<typename T >
LoadBatch &	Vminnorm (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Vminemerg ()
	Minimum per unit voltage for load UE evaluations, Emergency limit. More...

LoadBatch &	Vminemerg (double value)

template<typename T >
LoadBatch &	Vminemerg (T &value)

template<typename T >
LoadBatch &	Vminemerg (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	xfkVA ()
	Default = 0.0. More...

LoadBatch &	xfkVA (double value)

template<typename T >
LoadBatch &	xfkVA (T &value)

template<typename T >
LoadBatch &	xfkVA (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	allocationfactor ()
	Default = 0.5. More...

LoadBatch &	allocationfactor (double value)

template<typename T >
LoadBatch &	allocationfactor (T &value)

template<typename T >
LoadBatch &	allocationfactor (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	kVA ()
	Specify base Load in kVA (and power factor) More...

LoadBatch &	kVA (double value)

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

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

BatchFloat64ArrayProxy	pctmean ()
	Percent mean value for load to use for monte carlo studies if no loadshape is assigned to this load. More...

LoadBatch &	pctmean (double value)

template<typename T >
LoadBatch &	pctmean (T &value)

template<typename T >
LoadBatch &	pctmean (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pctstddev ()
	Percent Std deviation value for load to use for monte carlo studies if no loadshape is assigned to this load. More...

LoadBatch &	pctstddev (double value)

template<typename T >
LoadBatch &	pctstddev (T &value)

template<typename T >
LoadBatch &	pctstddev (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	CVRwatts ()
	Percent reduction in active power (watts) per 1% reduction in voltage from 100% rated. More...

LoadBatch &	CVRwatts (double value)

template<typename T >
LoadBatch &	CVRwatts (T &value)

template<typename T >
LoadBatch &	CVRwatts (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	CVRvars ()
	Percent reduction in reactive power (vars) per 1% reduction in voltage from 100% rated. More...

LoadBatch &	CVRvars (double value)

template<typename T >
LoadBatch &	CVRvars (T &value)

template<typename T >
LoadBatch &	CVRvars (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	kwh ()
	kWh billed for this period. More...

LoadBatch &	kwh (double value)

template<typename T >
LoadBatch &	kwh (T &value)

template<typename T >
LoadBatch &	kwh (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	kwhdays ()
	Length of kWh billing period in days (24 hr days). More...

LoadBatch &	kwhdays (double value)

template<typename T >
LoadBatch &	kwhdays (T &value)

template<typename T >
LoadBatch &	kwhdays (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Cfactor ()
	Factor relating average kW to peak kW. More...

LoadBatch &	Cfactor (double value)

template<typename T >
LoadBatch &	Cfactor (T &value)

template<typename T >
LoadBatch &	Cfactor (typename T::iterator it_begin, typename T::iterator it_end)

strings	CVRcurve ()
	Default is NONE. More...

LoadBatch &	CVRcurve (dss::obj::LoadShape &value)

LoadBatch &	CVRcurve (const string &value)

std::vector< dss::obj::LoadShape >	CVRcurve_obj ()
	Default is NONE. More...

LoadBatch &	CVRcurve_obj (dss::obj::LoadShape &value)

BatchInt32ArrayProxy	NumCust ()
	Number of customers, this load. More...

LoadBatch &	NumCust (int32_t value)

template<typename T >
LoadBatch &	NumCust (T &value)

template<typename T >
LoadBatch &	NumCust (typename T::iterator it_begin, typename T::iterator it_end)

std::vector< VectorXd >	ZIPV ()
	Array of 7 coefficients: More...

LoadBatch &	ZIPV (VectorXd &value)

BatchFloat64ArrayProxy	pctSeriesRL ()
	Percent of load that is series R-L for Harmonic studies. More...

LoadBatch &	pctSeriesRL (double value)

template<typename T >
LoadBatch &	pctSeriesRL (T &value)

template<typename T >
LoadBatch &	pctSeriesRL (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	RelWeight ()
	Relative weighting factor for reliability calcs. More...

LoadBatch &	RelWeight (double value)

template<typename T >
LoadBatch &	RelWeight (T &value)

template<typename T >
LoadBatch &	RelWeight (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Vlowpu ()
	Default = 0.50. More...

LoadBatch &	Vlowpu (double value)

template<typename T >
LoadBatch &	Vlowpu (T &value)

template<typename T >
LoadBatch &	Vlowpu (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	puXharm ()
	Special reactance, pu (based on kVA, kV properties), for the series impedance branch in the load model for HARMONICS analysis. More...

LoadBatch &	puXharm (double value)

template<typename T >
LoadBatch &	puXharm (T &value)

template<typename T >
LoadBatch &	puXharm (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	XRharm ()
	X/R ratio of the special harmonics mode reactance specified by the puXHARM property at fundamental frequency. More...

LoadBatch &	XRharm (double value)

template<typename T >
LoadBatch &	XRharm (T &value)

template<typename T >
LoadBatch &	XRharm (typename T::iterator it_begin, typename T::iterator it_end)

strings	spectrum ()
	Name of harmonic current spectrum for this load. More...

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

LoadBatch &	spectrum (const string &value)

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

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

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

LoadBatch &	basefreq (double value)

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

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

LoadBatch &	enabled (bool value)

LoadBatch &	enabled (bools &value)

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

LoadBatch &	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

◆ allocationfactor()

BatchFloat64ArrayProxy dss::obj::LoadBatch::allocationfactor ( )

inline

Default = 0.5.

Allocation factor for allocating loads based on connected kVA at a bus. Side effect: kW, PF, and kvar are modified by multiplying this factor times the XFKVA (if > 0).

DSS property name: allocationfactor, DSS property index: 22

◆ basefreq()

BatchFloat64ArrayProxy dss::obj::LoadBatch::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 40

◆ bus1()

strings dss::obj::LoadBatch::bus1 ( )

inline

Bus to which the load is connected.

May include specific node specification.

DSS property name: bus1, DSS property index: 2

◆ Cfactor()

BatchFloat64ArrayProxy dss::obj::LoadBatch::Cfactor ( )

inline

Factor relating average kW to peak kW.

Default is 4.0. See kWh and kWhdays. See kVA.

DSS property name: Cfactor, DSS property index: 30

◆ cls()

BatchInt32ArrayProxy dss::obj::LoadBatch::cls ( )

inline

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

Default is 1; not used internally.

DSS property name: class, DSS property index: 16

◆ conn()

BatchInt32ArrayProxy dss::obj::LoadBatch::conn ( )

inline

={wye or LN | delta or LL}.

Default is wye.

DSS property name: conn, DSS property index: 11

◆ conn_str()

strings dss::obj::LoadBatch::conn_str ( )

inline

={wye or LN | delta or LL}.

Default is wye.

DSS property name: conn, DSS property index: 11

◆ CVRcurve()

strings dss::obj::LoadBatch::CVRcurve ( )

inline

Default is NONE.

Curve describing both watt and var factors as a function of time. Refers to a LoadShape object with both Mult and Qmult defined. Define a Loadshape to agree with yearly or daily curve according to the type of analysis being done. If NONE, the CVRwatts and CVRvars factors are used and assumed constant.

DSS property name: CVRcurve, DSS property index: 31

◆ CVRcurve_obj()

std::vector< dss::obj::LoadShape > dss::obj::LoadBatch::CVRcurve_obj ( )

inline

Default is NONE.

Curve describing both watt and var factors as a function of time. Refers to a LoadShape object with both Mult and Qmult defined. Define a Loadshape to agree with yearly or daily curve according to the type of analysis being done. If NONE, the CVRwatts and CVRvars factors are used and assumed constant.

DSS property name: CVRcurve, DSS property index: 31

◆ CVRvars()

BatchFloat64ArrayProxy dss::obj::LoadBatch::CVRvars ( )

inline

Percent reduction in reactive power (vars) per 1% reduction in voltage from 100% rated.

Default=2. Typical values range from 2 to 3. Applies to Model=4 only. Intended to represent conservation voltage reduction or voltage optimization measures.

DSS property name: CVRvars, DSS property index: 27

◆ CVRwatts()

BatchFloat64ArrayProxy dss::obj::LoadBatch::CVRwatts ( )

inline

Percent reduction in active power (watts) per 1% reduction in voltage from 100% rated.

Default=1. Typical values range from 0.4 to 0.8. Applies to Model=4 only. Intended to represent conservation voltage reduction or voltage optimization measures.

DSS property name: CVRwatts, DSS property index: 26

◆ daily()

strings dss::obj::LoadBatch::daily ( )

inline

LOADSHAPE object to use for daily simulations.

Must be previously defined as a Loadshape object of 24 hrs, typically. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. Default is no variation (constant) if not defined. Side effect: Sets Yearly load shape if not already defined.

DSS property name: daily, DSS property index: 8

◆ daily_obj()

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

inline

LOADSHAPE object to use for daily simulations.

Must be previously defined as a Loadshape object of 24 hrs, typically. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. Default is no variation (constant) if not defined. Side effect: Sets Yearly load shape if not already defined.

DSS property name: daily, DSS property index: 8

◆ duty()

strings dss::obj::LoadBatch::duty ( )

inline

LOADSHAPE object to use for duty cycle simulations.

Must be previously defined as a Loadshape object. Typically would have time intervals less than 1 hr. 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.Set to NONE to reset to no loadahape. Set Status=Fixed to ignore Loadshape designation. Defaults to Daily curve If not specified.

DSS property name: duty, DSS property index: 9

◆ duty_obj()

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

inline

LOADSHAPE object to use for duty cycle simulations.

Must be previously defined as a Loadshape object. Typically would have time intervals less than 1 hr. 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.Set to NONE to reset to no loadahape. Set Status=Fixed to ignore Loadshape designation. Defaults to Daily curve If not specified.

DSS property name: duty, DSS property index: 9

◆ enabled()

bools dss::obj::LoadBatch::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 41

◆ growth()

strings dss::obj::LoadBatch::growth ( )

inline

Characteristic to use for growth factors by years.

Must be previously defined as a Growthshape object. Defaults to circuit default growth factor (see Set Growth command).

DSS property name: growth, DSS property index: 10

◆ growth_obj()

std::vector< dss::obj::GrowthShape > dss::obj::LoadBatch::growth_obj ( )

inline

Characteristic to use for growth factors by years.

Must be previously defined as a Growthshape object. Defaults to circuit default growth factor (see Set Growth command).

DSS property name: growth, DSS property index: 10

◆ kV()

BatchFloat64ArrayProxy dss::obj::LoadBatch::kV ( )

inline

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

For 2- and 3-phase loads, specify phase-phase kV. Otherwise, specify actual kV across each branch of the load. If wye (star), specify phase-neutral kV. If delta or phase-phase connected, specify phase-phase kV.

DSS property name: kV, DSS property index: 3

◆ kVA()

BatchFloat64ArrayProxy dss::obj::LoadBatch::kVA ( )

inline

Specify base Load in kVA (and power factor)

Legal ways to define base load: kW, PF kW, kvar kVA, PF XFKVA * Allocationfactor, PF kWh/(kWhdays*24) * Cfactor, PF

DSS property name: kVA, DSS property index: 23

◆ kvar()

BatchFloat64ArrayProxy dss::obj::LoadBatch::kvar ( )

inline

Specify the base kvar for specifying load as kW & kvar.

Assumes kW has been already defined. Alternative to specifying the power factor. Side effect: the power factor and kVA is altered to agree.

DSS property name: kvar, DSS property index: 12

◆ kW()

BatchFloat64ArrayProxy dss::obj::LoadBatch::kW ( )

inline

Total base kW for the load.

Normally, you would enter the maximum kW for the load for the first year and allow it to be adjusted by the load shapes, growth shapes, and global load multiplier.

Legal ways to define base load: kW, PF kW, kvar kVA, PF XFKVA * Allocationfactor, PF kWh/(kWhdays*24) * Cfactor, PF

DSS property name: kW, DSS property index: 4

◆ kwh()

BatchFloat64ArrayProxy dss::obj::LoadBatch::kwh ( )

inline

kWh billed for this period.

Default is 0. See help on kVA and Cfactor and kWhDays.

DSS property name: kwh, DSS property index: 28

◆ kwhdays()

BatchFloat64ArrayProxy dss::obj::LoadBatch::kwhdays ( )

inline

Length of kWh billing period in days (24 hr days).

Default is 30. Average demand is computed using this value.

DSS property name: kwhdays, DSS property index: 29

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 42

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 42

◆ model()

BatchInt32ArrayProxy dss::obj::LoadBatch::model ( )

inline

Integer code for the model to use for load variation with voltage.

Valid values are:

1:Standard constant P+jQ load. (Default) 2:Constant impedance load. 3:Const P, Quadratic Q (like a motor). 4:Nominal Linear P, Quadratic Q (feeder mix). Use this with CVRfactor. 5:Constant Current Magnitude 6:Const P, Fixed Q 7:Const P, Fixed Impedance Q 8:ZIPV (7 values)

For Types 6 and 7, only the P is modified by load multipliers.

DSS property name: model, DSS property index: 6

◆ NumCust()

BatchInt32ArrayProxy dss::obj::LoadBatch::NumCust ( )

inline

Number of customers, this load.

Default is 1.

DSS property name: NumCust, DSS property index: 32

◆ pctmean()

BatchFloat64ArrayProxy dss::obj::LoadBatch::pctmean ( )

inline

Percent mean value for load to use for monte carlo studies if no loadshape is assigned to this load.

Default is 50.

DSS property name: mean, DSS property index: 24

◆ pctSeriesRL()

BatchFloat64ArrayProxy dss::obj::LoadBatch::pctSeriesRL ( )

inline

Percent of load that is series R-L for Harmonic studies.

Default is 50. Remainder is assumed to be parallel R and L. This can have a significant impact on the amount of damping observed in Harmonics solutions.

DSS property name: SeriesRL, DSS property index: 34

◆ pctstddev()

BatchFloat64ArrayProxy dss::obj::LoadBatch::pctstddev ( )

inline

Percent Std deviation value for load to use for monte carlo studies if no loadshape is assigned to this load.

Default is 10.

DSS property name: stddev, DSS property index: 25

◆ pf()

BatchFloat64ArrayProxy dss::obj::LoadBatch::pf ( )

inline

Load power factor.

Enter negative for leading powerfactor (when kW and kvar have opposite signs.)

DSS property name: pf, DSS property index: 5

◆ phases()

BatchInt32ArrayProxy dss::obj::LoadBatch::phases ( )

inline

Number of Phases, this load.

Load is evenly divided among phases.

DSS property name: phases, DSS property index: 1

◆ puXharm()

BatchFloat64ArrayProxy dss::obj::LoadBatch::puXharm ( )

inline

Special reactance, pu (based on kVA, kV properties), for the series impedance branch in the load model for HARMONICS analysis.

Generally used to represent motor load blocked rotor reactance. If not specified (that is, set =0, the default value), the series branch is computed from the percentage of the nominal load at fundamental frequency specified by the SERIESRL property.

Applies to load model in HARMONICS mode only.

A typical value would be approximately 0.20 pu based on kVA * SeriesRL / 100.0.

DSS property name: puXharm, DSS property index: 37

◆ RelWeight()

BatchFloat64ArrayProxy dss::obj::LoadBatch::RelWeight ( )

inline

Relative weighting factor for reliability calcs.

Default = 1. Used to designate high priority loads such as hospitals, etc.

Is multiplied by number of customers and load kW during reliability calcs.

DSS property name: RelWeight, DSS property index: 35

◆ Rneut()

BatchFloat64ArrayProxy dss::obj::LoadBatch::Rneut ( )

inline

Default is -1.

Neutral resistance of wye (star)-connected load in actual ohms. If entered as a negative value, the neutral can be open, or floating, or it can be connected to node 0 (ground), which is the usual default. If >=0 be sure to explicitly specify the node connection for the neutral, or last, conductor. Otherwise, the neutral impedance will be shorted to ground.

DSS property name: Rneut, DSS property index: 13

◆ spectrum()

strings dss::obj::LoadBatch::spectrum ( )

inline

Name of harmonic current spectrum for this load.

Default is "defaultload", which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 39

◆ spectrum_obj()

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

inline

Name of harmonic current spectrum for this load.

Default is "defaultload", which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 39

◆ status()

BatchInt32ArrayProxy dss::obj::LoadBatch::status ( )

inline

={Variable | Fixed | Exempt}.

Default is variable. If Fixed, no load multipliers apply; however, growth multipliers do apply. All multipliers apply to Variable loads. Exempt loads are not modified by the global load multiplier, such as in load duration curves, etc. Daily multipliers do apply, so setting this property to Exempt is a good way to represent industrial load that stays the same day-after-day for the period study.

DSS property name: status, DSS property index: 15

◆ status_str()

strings dss::obj::LoadBatch::status_str ( )

inline

={Variable | Fixed | Exempt}.

Default is variable. If Fixed, no load multipliers apply; however, growth multipliers do apply. All multipliers apply to Variable loads. Exempt loads are not modified by the global load multiplier, such as in load duration curves, etc. Daily multipliers do apply, so setting this property to Exempt is a good way to represent industrial load that stays the same day-after-day for the period study.

DSS property name: status, DSS property index: 15

◆ Vlowpu()

BatchFloat64ArrayProxy dss::obj::LoadBatch::Vlowpu ( )

inline

Default = 0.50.

Per unit voltage at which the model switches to same as constant Z model (model=2). This allows more consistent convergence at very low voltaes due to opening switches or solving for fault situations.

DSS property name: Vlowpu, DSS property index: 36

◆ Vmaxpu()

BatchFloat64ArrayProxy dss::obj::LoadBatch::Vmaxpu ( )

inline

Default = 1.05.

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: 18

◆ Vminemerg()

BatchFloat64ArrayProxy dss::obj::LoadBatch::Vminemerg ( )

inline

Minimum per unit voltage for load UE evaluations, Emergency limit.

Default = 0, which defaults to system "vminemerg" property (see Set Command under Executive). If this property is specified, it ALWAYS overrides the system specification. This allows you to have different criteria for different loads. Set to zero to revert to the default system value.

DSS property name: Vminemerg, DSS property index: 20

◆ Vminnorm()

BatchFloat64ArrayProxy dss::obj::LoadBatch::Vminnorm ( )

inline

Minimum per unit voltage for load EEN evaluations, Normal limit.

Default = 0, which defaults to system "vminnorm" property (see Set Command under Executive). If this property is specified, it ALWAYS overrides the system specification. This allows you to have different criteria for different loads. Set to zero to revert to the default system value.

DSS property name: Vminnorm, DSS property index: 19

◆ Vminpu()

BatchFloat64ArrayProxy dss::obj::LoadBatch::Vminpu ( )

inline

Default = 0.95.

Minimum per unit voltage for which the MODEL is assumed to apply. Lower end of normal voltage range.Below this value, the load model reverts to a constant impedance model that matches the model at the transition voltage. See also "Vlowpu" which causes the model to match Model=2 below the transition voltage.

DSS property name: Vminpu, DSS property index: 17

◆ xfkVA()

BatchFloat64ArrayProxy dss::obj::LoadBatch::xfkVA ( )

inline

Default = 0.0.

Rated kVA of service transformer for allocating loads based on connected kVA at a bus. Side effect: kW, PF, and kvar are modified. See help on kVA.

DSS property name: xfkVA, DSS property index: 21

◆ Xneut()

BatchFloat64ArrayProxy dss::obj::LoadBatch::Xneut ( )

inline

Neutral reactance of wye(star)-connected load in actual ohms.

May be + or -.

DSS property name: Xneut, DSS property index: 14

◆ XRharm()

BatchFloat64ArrayProxy dss::obj::LoadBatch::XRharm ( )

inline

X/R ratio of the special harmonics mode reactance specified by the puXHARM property at fundamental frequency.

Default is 6.

DSS property name: XRharm, DSS property index: 38

◆ yearly()

strings dss::obj::LoadBatch::yearly ( )

inline

LOADSHAPE object to use for yearly simulations.

Must be previously defined as a Loadshape object. Is set to the Daily load shape when Daily is defined. The daily load shape is repeated in this case. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. The default is no variation.

DSS property name: yearly, DSS property index: 7

◆ yearly_obj()

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

inline

LOADSHAPE object to use for yearly simulations.

Must be previously defined as a Loadshape object. Is set to the Daily load shape when Daily is defined. The daily load shape is repeated in this case. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. The default is no variation.

DSS property name: yearly, DSS property index: 7

◆ ZIPV()

std::vector< VectorXd > dss::obj::LoadBatch::ZIPV ( )

inline

Array of 7 coefficients:

First 3 are ZIP weighting factors for real power (should sum to 1) Next 3 are ZIP weighting factors for reactive power (should sum to 1) Last 1 is cut-off voltage in p.u. of base kV; load is 0 below this cut-off No defaults; all coefficients must be specified if using model=8.

DSS property name: ZIPV, DSS property index: 33

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

◆ allocationfactor()

◆ basefreq()

◆ bus1()

◆ Cfactor()

◆ cls()

◆ conn()

◆ conn_str()

◆ CVRcurve()

◆ CVRcurve_obj()

◆ CVRvars()

◆ CVRwatts()

◆ daily()

◆ daily_obj()

◆ duty()

◆ duty_obj()

◆ enabled()

◆ growth()

◆ growth_obj()

◆ kV()

◆ kVA()

◆ kvar()

◆ kW()

◆ kwh()

◆ kwhdays()

◆ like() [1/2]

◆ like() [2/2]

◆ model()

◆ NumCust()

◆ pctmean()

◆ pctSeriesRL()

◆ pctstddev()

◆ pf()

◆ phases()

◆ puXharm()

◆ RelWeight()

◆ Rneut()

◆ spectrum()

◆ spectrum_obj()

◆ status()

◆ status_str()

◆ Vlowpu()

◆ Vmaxpu()

◆ Vminemerg()

◆ Vminnorm()

◆ Vminpu()

◆ xfkVA()

◆ Xneut()

◆ XRharm()

◆ yearly()

◆ yearly_obj()

◆ ZIPV()