Inheritance diagram for dss::obj::GeneratorBatch:

Collaboration diagram for dss::obj::GeneratorBatch:

Public Types
typedef Generator::Properties	Properties

typedef Generator	BatchElementClass

typedef Generator::GeneratorDispatchMode	GeneratorDispatchMode

typedef Generator::GeneratorStatus	GeneratorStatus

Public Member Functions
	GeneratorBatch (APIUtil *util)
	Create a batch of all Generator elements.

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

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

GeneratorBatch &	begin_edit ()

GeneratorBatch &	end_edit (int32_t num_edits=1)

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

GeneratorBatch &	phases (int32_t value)

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

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

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

GeneratorBatch &	bus1 (const string &value)

GeneratorBatch &	bus1 (strings &value)

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

GeneratorBatch &	kv (double value)

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

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

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

GeneratorBatch &	kW (double value)

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

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

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

GeneratorBatch &	pf (double value)

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

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

BatchFloat64ArrayProxy	kvar ()
	Specify the base kvar. More...

GeneratorBatch &	kvar (double value)

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

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

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

GeneratorBatch &	model (int32_t value)

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

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

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

GeneratorBatch &	Vminpu (double value)

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

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

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

GeneratorBatch &	Vmaxpu (double value)

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

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

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

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

GeneratorBatch &	yearly (const string &value)

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

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

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

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

GeneratorBatch &	daily (const string &value)

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

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

strings	duty ()
	Load shape to use for duty cycle dispatch simulations such as for wind generation. More...

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

GeneratorBatch &	duty (const string &value)

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

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

BatchInt32ArrayProxy	dispmode ()
	{Default* \| Loadlevel \| Price } Default = Default. More...

GeneratorBatch &	dispmode (string &value)

GeneratorBatch &	dispmode (int32_t value)

GeneratorBatch &	dispmode (Generator::GeneratorDispatchMode value)

GeneratorBatch &	dispmode (strings &value)

GeneratorBatch &	dispmode (std::vector< int32_t > &value)

GeneratorBatch &	dispmode (std::vector< Generator::GeneratorDispatchMode > &value)

strings	dispmode_str ()
	{Default* \| Loadlevel \| Price } Default = Default. More...

GeneratorBatch &	dispmode_str (string &value)

GeneratorBatch &	dispmode_str (strings &value)

BatchFloat64ArrayProxy	dispvalue ()
	Dispatch value. More...

GeneratorBatch &	dispvalue (double value)

template<typename T >
GeneratorBatch &	dispvalue (T &value)

template<typename T >
GeneratorBatch &	dispvalue (typename T::iterator it_begin, typename T::iterator it_end)

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

GeneratorBatch &	conn (string &value)

GeneratorBatch &	conn (int32_t value)

GeneratorBatch &	conn (Connection value)

GeneratorBatch &	conn (strings &value)

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

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

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

GeneratorBatch &	conn_str (string &value)

GeneratorBatch &	conn_str (strings &value)

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

GeneratorBatch &	status (string &value)

GeneratorBatch &	status (int32_t value)

GeneratorBatch &	status (Generator::GeneratorStatus value)

GeneratorBatch &	status (strings &value)

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

GeneratorBatch &	status (std::vector< Generator::GeneratorStatus > &value)

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

GeneratorBatch &	status_str (string &value)

GeneratorBatch &	status_str (strings &value)

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

GeneratorBatch &	cls (int32_t value)

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

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

BatchFloat64ArrayProxy	Vpu ()
	Per Unit voltage set point for Model = 3 (typical power flow model). More...

GeneratorBatch &	Vpu (double value)

template<typename T >
GeneratorBatch &	Vpu (T &value)

template<typename T >
GeneratorBatch &	Vpu (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	maxkvar ()
	Maximum kvar limit for Model = 3. More...

GeneratorBatch &	maxkvar (double value)

template<typename T >
GeneratorBatch &	maxkvar (T &value)

template<typename T >
GeneratorBatch &	maxkvar (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	minkvar ()
	Minimum kvar limit for Model = 3. More...

GeneratorBatch &	minkvar (double value)

template<typename T >
GeneratorBatch &	minkvar (T &value)

template<typename T >
GeneratorBatch &	minkvar (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pvfactor ()
	Deceleration factor for P-V generator model (Model=3). More...

GeneratorBatch &	pvfactor (double value)

template<typename T >
GeneratorBatch &	pvfactor (T &value)

template<typename T >
GeneratorBatch &	pvfactor (typename T::iterator it_begin, typename T::iterator it_end)

bools	forceon ()
	{Yes \| No} Forces generator ON despite requirements of other dispatch modes. More...

GeneratorBatch &	forceon (bool value)

GeneratorBatch &	forceon (bools &value)

BatchFloat64ArrayProxy	kVA ()
	kVA rating of electrical machine. More...

GeneratorBatch &	kVA (double value)

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

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

BatchFloat64ArrayProxy	MVA ()
	MVA rating of electrical machine. More...

GeneratorBatch &	MVA (double value)

template<typename T >
GeneratorBatch &	MVA (T &value)

template<typename T >
GeneratorBatch &	MVA (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Xd ()
	Per unit synchronous reactance of machine. More...

GeneratorBatch &	Xd (double value)

template<typename T >
GeneratorBatch &	Xd (T &value)

template<typename T >
GeneratorBatch &	Xd (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Xdp ()
	Per unit transient reactance of the machine. More...

GeneratorBatch &	Xdp (double value)

template<typename T >
GeneratorBatch &	Xdp (T &value)

template<typename T >
GeneratorBatch &	Xdp (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Xdpp ()
	Per unit subtransient reactance of the machine. More...

GeneratorBatch &	Xdpp (double value)

template<typename T >
GeneratorBatch &	Xdpp (T &value)

template<typename T >
GeneratorBatch &	Xdpp (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	H ()
	Per unit mass constant of the machine. More...

GeneratorBatch &	H (double value)

template<typename T >
GeneratorBatch &	H (T &value)

template<typename T >
GeneratorBatch &	H (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	D ()
	Damping constant. More...

GeneratorBatch &	D (double value)

template<typename T >
GeneratorBatch &	D (T &value)

template<typename T >
GeneratorBatch &	D (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...

GeneratorBatch &	UserModel (const string &value)

GeneratorBatch &	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...

GeneratorBatch &	UserData (const string &value)

GeneratorBatch &	UserData (strings &value)

strings	ShaftModel ()
	Name of user-written DLL containing a Shaft model, which models the prime mover and determines the power on the shaft for Dynamics studies. More...

GeneratorBatch &	ShaftModel (const string &value)

GeneratorBatch &	ShaftModel (strings &value)

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

GeneratorBatch &	ShaftData (const string &value)

GeneratorBatch &	ShaftData (strings &value)

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

GeneratorBatch &	DutyStart (double value)

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

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

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

GeneratorBatch &	debugtrace (bool value)

GeneratorBatch &	debugtrace (bools &value)

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

GeneratorBatch &	Balanced (bool value)

GeneratorBatch &	Balanced (bools &value)

BatchFloat64ArrayProxy	XRdp ()
	Default is 20. More...

GeneratorBatch &	XRdp (double value)

template<typename T >
GeneratorBatch &	XRdp (T &value)

template<typename T >
GeneratorBatch &	XRdp (typename T::iterator it_begin, typename T::iterator it_end)

bools	UseFuel ()
	{Yes \| *No}. More...

GeneratorBatch &	UseFuel (bool value)

GeneratorBatch &	UseFuel (bools &value)

BatchFloat64ArrayProxy	FuelkWh ()
	{*0}Is the nominal level of fuel for the generator (kWh). More...

GeneratorBatch &	FuelkWh (double value)

template<typename T >
GeneratorBatch &	FuelkWh (T &value)

template<typename T >
GeneratorBatch &	FuelkWh (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pctFuel ()
	It is a number between 0 and 100 representing the current amount of fuel avaiable in percentage of FuelkWh. More...

GeneratorBatch &	pctFuel (double value)

template<typename T >
GeneratorBatch &	pctFuel (T &value)

template<typename T >
GeneratorBatch &	pctFuel (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pctReserve ()
	It is a number between 0 and 100 representing the reserve level in percentage of FuelkWh. More...

GeneratorBatch &	pctReserve (double value)

template<typename T >
GeneratorBatch &	pctReserve (T &value)

template<typename T >
GeneratorBatch &	pctReserve (typename T::iterator it_begin, typename T::iterator it_end)

GeneratorBatch &	Refuel (bool value)
	It is a boolean value (Yes/True, No/False) that can be used to manually refuel the generator when needed. More...

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

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

GeneratorBatch &	spectrum (const string &value)

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

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

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

GeneratorBatch &	basefreq (double value)

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

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

GeneratorBatch &	enabled (bool value)

GeneratorBatch &	enabled (bools &value)

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

GeneratorBatch &	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::GeneratorBatch::Balanced ( )

inline

{Yes | No*} Default is No.

For Model=7, force balanced current only for 3-phase generators. Force zero- and negative-sequence to zero.

DSS property name: Balanced, DSS property index: 36

◆ basefreq()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 44

◆ bus1()

strings dss::obj::GeneratorBatch::bus1 ( )

inline

Bus to which the Generator is connected.

May include specific node specification.

DSS property name: bus1, DSS property index: 2

◆ cls()

BatchInt32ArrayProxy dss::obj::GeneratorBatch::cls ( )

inline

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

DSS property name: class, DSS property index: 17

◆ conn()

BatchInt32ArrayProxy dss::obj::GeneratorBatch::conn ( )

inline

={wye|LN|delta|LL}.

Default is wye.

DSS property name: conn, DSS property index: 15

◆ conn_str()

strings dss::obj::GeneratorBatch::conn_str ( )

inline

={wye|LN|delta|LL}.

Default is wye.

DSS property name: conn, DSS property index: 15

◆ D()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::D ( )

inline

Damping constant.

Usual range is 0 to 4. Default is 1.0. Adjust to get damping

DSS property name: D, DSS property index: 29

◆ daily()

strings dss::obj::GeneratorBatch::daily ( )

inline

Dispatch shape to use for daily simulations.

Must be previously defined as a Loadshape object of 24 hrs, typically. If generator is assumed to be ON continuously, specify Status=FIXED, or designate a Loadshape objectthat is 1.0 perunit for all hours. Set to NONE to reset to no loadahape.

DSS property name: daily, DSS property index: 11

◆ daily_obj()

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

inline

Dispatch shape to use for daily simulations.

Must be previously defined as a Loadshape object of 24 hrs, typically. If generator is assumed to be ON continuously, specify Status=FIXED, or designate a Loadshape objectthat is 1.0 perunit for all hours. Set to NONE to reset to no loadahape.

DSS property name: daily, DSS property index: 11

◆ debugtrace()

bools dss::obj::GeneratorBatch::debugtrace ( )

inline

{Yes | No } Default is no.

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

DSS property name: debugtrace, DSS property index: 35

◆ dispmode()

BatchInt32ArrayProxy dss::obj::GeneratorBatch::dispmode ( )

inline

{Default* | Loadlevel | Price } Default = Default.

Dispatch mode. In default mode, gen is either always on or follows dispatch curve as specified. Otherwise, the gen comes on when either the global default load level (Loadshape "default") or the price level exceeds the dispatch value.

DSS property name: dispmode, DSS property index: 13

◆ dispmode_str()

strings dss::obj::GeneratorBatch::dispmode_str ( )

inline

{Default* | Loadlevel | Price } Default = Default.

Dispatch mode. In default mode, gen is either always on or follows dispatch curve as specified. Otherwise, the gen comes on when either the global default load level (Loadshape "default") or the price level exceeds the dispatch value.

DSS property name: dispmode, DSS property index: 13

◆ dispvalue()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::dispvalue ( )

inline

Dispatch value.

If = 0.0 (default) then Generator follow dispatch curves, if any. If > 0 then Generator is ON only when either the price signal (in Price dispatch mode) exceeds this value or the active circuit load multiplier * "default" loadshape value * the default yearly growth factor exceeds this value. Then the generator follows dispatch curves (duty, daily, or yearly), if any (see also Status).

DSS property name: dispvalue, DSS property index: 14

◆ duty()

strings dss::obj::GeneratorBatch::duty ( )

inline

Load shape to use for duty cycle dispatch simulations such as for wind generation.

Must be previously defined as a Loadshape object. Typically would have time intervals less than 1 hr – perhaps, in seconds. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. 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: 12

◆ duty_obj()

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

inline

Load shape to use for duty cycle dispatch simulations such as for wind generation.

Must be previously defined as a Loadshape object. Typically would have time intervals less than 1 hr – perhaps, in seconds. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. 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: 12

◆ DutyStart()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::DutyStart ( )

inline

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

DSS property name: DutyStart, DSS property index: 34

◆ enabled()

bools dss::obj::GeneratorBatch::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 45

◆ forceon()

bools dss::obj::GeneratorBatch::forceon ( )

inline

{Yes | No} Forces generator ON despite requirements of other dispatch modes.

Stays ON until this property is set to NO, or an internal algorithm cancels the forced ON state.

DSS property name: forceon, DSS property index: 22

◆ FuelkWh()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::FuelkWh ( )

inline

{*0}Is the nominal level of fuel for the generator (kWh).

It only applies if UseFuel = Yes/True

DSS property name: FuelkWh, DSS property index: 39

◆ H()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::H ( )

inline

Per unit mass constant of the machine.

MW-sec/MVA. Default is 1.0.

DSS property name: H, DSS property index: 28

◆ kv()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::kv ( )

inline

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

For 2- and 3-phase Generators, specify phase-phase kV. Otherwise, for phases=1 or phases>3, specify actual kV across each branch of the Generator. 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::GeneratorBatch::kVA ( )

inline

kVA rating of electrical machine.

Defaults to 1.2* kW if not specified. Applied to machine or inverter definition for Dynamics mode solutions.

DSS property name: kVA, DSS property index: 23

◆ kvar()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::kvar ( )

inline

Specify the base kvar.

Alternative to specifying the power factor. Side effect: the power factor value is altered to agree based on present value of kW.

DSS property name: kvar, DSS property index: 6

◆ kW()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::kW ( )

inline

Total base kW for the Generator.

A positive value denotes power coming OUT of the element, which is the opposite of a load. This value is modified depending on the dispatch mode. Unaffected by the global load multiplier and growth curves. If you want there to be more generation, you must add more generators or change this value.

DSS property name: kW, DSS property index: 4

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 46

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 46

◆ maxkvar()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::maxkvar ( )

inline

Maximum kvar limit for Model = 3.

Defaults to twice the specified load kvar. Always reset this if you change PF or kvar properties.

DSS property name: maxkvar, DSS property index: 19

◆ minkvar()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::minkvar ( )

inline

Minimum kvar limit for Model = 3.

Enter a negative number if generator can absorb vars. Defaults to negative of Maxkvar. Always reset this if you change PF or kvar properties.

DSS property name: minkvar, DSS property index: 20

◆ model()

BatchInt32ArrayProxy dss::obj::GeneratorBatch::model ( )

inline

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

Valid values are:

1:Generator injects a constant kW at specified power factor. 2:Generator is modeled as a constant admittance. 3:Const kW, constant kV. Somewhat like a conventional transmission power flow P-V generator. 4:Const kW, Fixed Q (Q never varies) 5:Const kW, Fixed Q(as a constant reactance) 6:Compute load injection from User-written Model.(see usage of Xd, Xdp) 7:Constant kW, kvar, but current-limited below Vminpu. Approximates a simple inverter. See also Balanced.

DSS property name: model, DSS property index: 7

◆ MVA()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::MVA ( )

inline

MVA rating of electrical machine.

Alternative to using kVA=.

DSS property name: MVA, DSS property index: 24

◆ pctFuel()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::pctFuel ( )

inline

It is a number between 0 and 100 representing the current amount of fuel avaiable in percentage of FuelkWh.

It only applies if UseFuel = Yes/True

DSS property name: Fuel, DSS property index: 40

◆ pctReserve()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::pctReserve ( )

inline

It is a number between 0 and 100 representing the reserve level in percentage of FuelkWh.

It only applies if UseFuel = Yes/True

DSS property name: Reserve, DSS property index: 41

◆ pf()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::pf ( )

inline

Generator power factor.

Default is 0.80. Enter negative for leading powerfactor (when kW and kvar have opposite signs.) A positive power factor for a generator signifies that the generator produces vars as is typical for a synchronous generator. Induction machines would be specified with a negative power factor.

DSS property name: pf, DSS property index: 5

◆ phases()

BatchInt32ArrayProxy dss::obj::GeneratorBatch::phases ( )

inline

Number of Phases, this Generator.

Power is evenly divided among phases.

DSS property name: phases, DSS property index: 1

◆ pvfactor()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::pvfactor ( )

inline

Deceleration factor for P-V generator model (Model=3).

Default is 0.1. If the circuit converges easily, you may want to use a higher number such as 1.0. Use a lower number if solution diverges. Use Debugtrace=yes to create a file that will trace the convergence of a generator model.

DSS property name: pvfactor, DSS property index: 21

◆ Refuel()

GeneratorBatch & dss::obj::GeneratorBatch::Refuel ( bool value )

inline

It is a boolean value (Yes/True, No/False) that can be used to manually refuel the generator when needed.

It only applies if UseFuel = Yes/True

DSS property name: Refuel, DSS property index: 42

◆ ShaftData()

strings dss::obj::GeneratorBatch::ShaftData ( )

inline

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

DSS property name: ShaftData, DSS property index: 33

◆ ShaftModel()

strings dss::obj::GeneratorBatch::ShaftModel ( )

inline

Name of user-written DLL containing a Shaft model, which models the prime mover and determines the power on the shaft for Dynamics studies.

Models additional mass elements other than the single-mass model in the DSS default model. Set to "none" to negate previous setting.

DSS property name: ShaftModel, DSS property index: 32

◆ spectrum()

strings dss::obj::GeneratorBatch::spectrum ( )

inline

Name of harmonic voltage or current spectrum for this generator.

Voltage behind Xd" for machine - default. Current injection for inverter. Default value is "default", which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 43

◆ spectrum_obj()

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

inline

Name of harmonic voltage or current spectrum for this generator.

Voltage behind Xd" for machine - default. Current injection for inverter. Default value is "default", which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 43

◆ status()

BatchInt32ArrayProxy dss::obj::GeneratorBatch::status ( )

inline

={Fixed | Variable*}.

If Fixed, then dispatch multipliers do not apply. The generator is alway at full power when it is ON. Default is Variable (follows curves).

DSS property name: status, DSS property index: 16

◆ status_str()

strings dss::obj::GeneratorBatch::status_str ( )

inline

={Fixed | Variable*}.

If Fixed, then dispatch multipliers do not apply. The generator is alway at full power when it is ON. Default is Variable (follows curves).

DSS property name: status, DSS property index: 16

◆ UseFuel()

bools dss::obj::GeneratorBatch::UseFuel ( )

inline

{Yes | *No}.

Activates the use of fuel for the operation of the generator. When the fuel level reaches the reserve level, the generator stops until it gets refueled. By default, the generator is connected to a continuous fuel supply, Use this mode to mimic dependency on fuel level for different generation technologies.

DSS property name: UseFuel, DSS property index: 38

◆ UserData()

strings dss::obj::GeneratorBatch::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::GeneratorBatch::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

◆ Vmaxpu()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::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: 9

◆ Vminpu()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::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. For model 7, the current is limited to the value computed for constant power at Vminpu.

DSS property name: Vminpu, DSS property index: 8

◆ Vpu()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::Vpu ( )

inline

Per Unit voltage set point for Model = 3 (typical power flow model).

Default is 1.0.

DSS property name: Vpu, DSS property index: 18

◆ Xd()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::Xd ( )

inline

Per unit synchronous reactance of machine.

Presently used only for Thevinen impedance for power flow calcs of user models (model=6). Typically use a value 0.4 to 1.0. Default is 1.0

DSS property name: Xd, DSS property index: 25

◆ Xdp()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::Xdp ( )

inline

Per unit transient reactance of the machine.

Used for Dynamics mode and Fault studies. Default is 0.27.For user models, this value is used for the Thevinen/Norton impedance for Dynamics Mode.

DSS property name: Xdp, DSS property index: 26

◆ Xdpp()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::Xdpp ( )

inline

Per unit subtransient reactance of the machine.

Used for Harmonics. Default is 0.20.

DSS property name: Xdpp, DSS property index: 27

◆ XRdp()

BatchFloat64ArrayProxy dss::obj::GeneratorBatch::XRdp ( )

inline

Default is 20.

X/R ratio for Xdp property for FaultStudy and Dynamic modes.

DSS property name: XRdp, DSS property index: 37

◆ yearly()

strings dss::obj::GeneratorBatch::yearly ( )

inline

Dispatch shape to use for yearly simulations.

Must be previously defined as a Loadshape object. If this is not specified, a constant value is assumed (no variation). If the generator is assumed to be ON continuously, specify Status=FIXED, or designate a curve that is 1.0 per unit at all times. Set to NONE to reset to no loadahape. Nominally for 8760 simulations. If there are fewer points in the designated shape than the number of points in the solution, the curve is repeated.

DSS property name: yearly, DSS property index: 10

◆ yearly_obj()

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

inline

Dispatch shape to use for yearly simulations.

Must be previously defined as a Loadshape object. If this is not specified, a constant value is assumed (no variation). If the generator is assumed to be ON continuously, specify Status=FIXED, or designate a curve that is 1.0 per unit at all times. Set to NONE to reset to no loadahape. Nominally for 8760 simulations. If there are fewer points in the designated shape than the number of points in the solution, the curve is repeated.

DSS property name: yearly, DSS property index: 10

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()

◆ D()

◆ daily()

◆ daily_obj()

◆ debugtrace()

◆ dispmode()

◆ dispmode_str()

◆ dispvalue()

◆ duty()

◆ duty_obj()

◆ DutyStart()

◆ enabled()

◆ forceon()

◆ FuelkWh()

◆ H()

◆ kv()

◆ kVA()

◆ kvar()

◆ kW()

◆ like() [1/2]

◆ like() [2/2]

◆ maxkvar()

◆ minkvar()

◆ model()

◆ MVA()

◆ pctFuel()

◆ pctReserve()

◆ pf()

◆ phases()

◆ pvfactor()

◆ Refuel()

◆ ShaftData()

◆ ShaftModel()

◆ spectrum()

◆ spectrum_obj()

◆ status()

◆ status_str()

◆ UseFuel()

◆ UserData()

◆ UserModel()

◆ Vmaxpu()

◆ Vminpu()

◆ Vpu()

◆ Xd()

◆ Xdp()

◆ Xdpp()

◆ XRdp()

◆ yearly()

◆ yearly_obj()