Inheritance diagram for dss::obj::UPFCBatch:

Collaboration diagram for dss::obj::UPFCBatch:

Public Types
typedef UPFC::Properties	Properties

typedef UPFC	BatchElementClass

Public Member Functions
	UPFCBatch (APIUtil *util)
	Create a batch of all UPFC elements.

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

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

UPFCBatch &	begin_edit ()

UPFCBatch &	end_edit (int32_t num_edits=1)

strings	bus1 ()
	Name of bus to which the input terminal (1) is connected. More...

UPFCBatch &	bus1 (const string &value)

UPFCBatch &	bus1 (strings &value)

strings	bus2 ()
	Name of bus to which the output terminal (2) is connected. More...

UPFCBatch &	bus2 (const string &value)

UPFCBatch &	bus2 (strings &value)

BatchFloat64ArrayProxy	refkv ()
	Base Voltage expected at the output of the UPFC. More...

UPFCBatch &	refkv (double value)

template<typename T >
UPFCBatch &	refkv (T &value)

template<typename T >
UPFCBatch &	refkv (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pf ()
	Power factor target at the input terminal. More...

UPFCBatch &	pf (double value)

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

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

BatchFloat64ArrayProxy	frequency ()
	UPFC working frequency. More...

UPFCBatch &	frequency (double value)

template<typename T >
UPFCBatch &	frequency (T &value)

template<typename T >
UPFCBatch &	frequency (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	phases ()
	Number of phases. More...

UPFCBatch &	phases (int32_t value)

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

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

BatchFloat64ArrayProxy	Xs ()
	Reactance of the series transformer of the UPFC, ohms (default=0.7540 ... 2 mH) More...

UPFCBatch &	Xs (double value)

template<typename T >
UPFCBatch &	Xs (T &value)

template<typename T >
UPFCBatch &	Xs (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Tol1 ()
	Tolerance in pu for the series PI controller Tol1=0.02 is the format used to define 2% tolerance (Default=2%) More...

UPFCBatch &	Tol1 (double value)

template<typename T >
UPFCBatch &	Tol1 (T &value)

template<typename T >
UPFCBatch &	Tol1 (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	Mode ()
	Integer used to define the control mode of the UPFC: More...

UPFCBatch &	Mode (int32_t value)

template<typename T >
UPFCBatch &	Mode (T &value)

template<typename T >
UPFCBatch &	Mode (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	VpqMax ()
	Maximum voltage (in volts) delivered by the series voltage source (Default = 24 V) More...

UPFCBatch &	VpqMax (double value)

template<typename T >
UPFCBatch &	VpqMax (T &value)

template<typename T >
UPFCBatch &	VpqMax (typename T::iterator it_begin, typename T::iterator it_end)

strings	LossCurve ()
	Name of the XYCurve for describing the losses behavior as a function of the voltage at the input of the UPFC. More...

UPFCBatch &	LossCurve (dss::obj::XYcurve &value)

UPFCBatch &	LossCurve (const string &value)

std::vector< dss::obj::XYcurve >	LossCurve_obj ()
	Name of the XYCurve for describing the losses behavior as a function of the voltage at the input of the UPFC. More...

UPFCBatch &	LossCurve_obj (dss::obj::XYcurve &value)

BatchFloat64ArrayProxy	VHLimit ()
	High limit for the voltage at the input of the UPFC, if the voltage is above this value the UPFC turns off. More...

UPFCBatch &	VHLimit (double value)

template<typename T >
UPFCBatch &	VHLimit (T &value)

template<typename T >
UPFCBatch &	VHLimit (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	VLLimit ()
	low limit for the voltage at the input of the UPFC, if voltage is below this value the UPFC turns off. More...

UPFCBatch &	VLLimit (double value)

template<typename T >
UPFCBatch &	VLLimit (T &value)

template<typename T >
UPFCBatch &	VLLimit (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	CLimit ()
	Current Limit for the UPFC, if the current passing through the UPFC is higher than this value the UPFC turns off. More...

UPFCBatch &	CLimit (double value)

template<typename T >
UPFCBatch &	CLimit (T &value)

template<typename T >
UPFCBatch &	CLimit (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	refkv2 ()
	Base Voltage expected at the output of the UPFC for control modes 4 and 5. More...

UPFCBatch &	refkv2 (double value)

template<typename T >
UPFCBatch &	refkv2 (T &value)

template<typename T >
UPFCBatch &	refkv2 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	kvarLimit ()
	Maximum amount of reactive power (kvar) that can be absorved by the UPFC (Default = 5) More...

UPFCBatch &	kvarLimit (double value)

template<typename T >
UPFCBatch &	kvarLimit (T &value)

template<typename T >
UPFCBatch &	kvarLimit (typename T::iterator it_begin, typename T::iterator it_end)

strings	spectrum ()
	Name of harmonic spectrum for this source. More...

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

UPFCBatch &	spectrum (const string &value)

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

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

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

UPFCBatch &	basefreq (double value)

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

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

UPFCBatch &	enabled (bool value)

UPFCBatch &	enabled (bools &value)

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

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

◆ basefreq()

BatchFloat64ArrayProxy dss::obj::UPFCBatch::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 18

◆ bus1()

strings dss::obj::UPFCBatch::bus1 ( )

inline

Name of bus to which the input terminal (1) is connected.

bus1=busname.1.3 bus1=busname.1.2.3

DSS property name: bus1, DSS property index: 1

◆ bus2()

strings dss::obj::UPFCBatch::bus2 ( )

inline

Name of bus to which the output terminal (2) is connected.

bus2=busname.1.2 bus2=busname.1.2.3

DSS property name: bus2, DSS property index: 2

◆ CLimit()

BatchFloat64ArrayProxy dss::obj::UPFCBatch::CLimit ( )

inline

Current Limit for the UPFC, if the current passing through the UPFC is higher than this value the UPFC turns off.

This value is specified in Amps (Default 265 A)

DSS property name: CLimit, DSS property index: 14

◆ enabled()

bools dss::obj::UPFCBatch::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 19

◆ frequency()

BatchFloat64ArrayProxy dss::obj::UPFCBatch::frequency ( )

inline

UPFC working frequency.

Defaults to system default base frequency.

DSS property name: frequency, DSS property index: 5

◆ kvarLimit()

BatchFloat64ArrayProxy dss::obj::UPFCBatch::kvarLimit ( )

inline

Maximum amount of reactive power (kvar) that can be absorved by the UPFC (Default = 5)

DSS property name: kvarLimit, DSS property index: 16

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 20

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 20

◆ LossCurve()

strings dss::obj::UPFCBatch::LossCurve ( )

inline

Name of the XYCurve for describing the losses behavior as a function of the voltage at the input of the UPFC.

DSS property name: LossCurve, DSS property index: 11

◆ LossCurve_obj()

std::vector< dss::obj::XYcurve > dss::obj::UPFCBatch::LossCurve_obj ( )

inline

Name of the XYCurve for describing the losses behavior as a function of the voltage at the input of the UPFC.

DSS property name: LossCurve, DSS property index: 11

◆ Mode()

BatchInt32ArrayProxy dss::obj::UPFCBatch::Mode ( )

inline

Integer used to define the control mode of the UPFC:

0 = Off, 1 = Voltage regulator, 2 = Phase angle regulator, 3 = Dual mode 4 = It is a control mode where the user can set two different set points to create a secure GAP, these references must be defined in the parameters RefkV and RefkV2. The only restriction when setting these values is that RefkV must be higher than RefkV2. 5 = In this mode the user can define the same GAP using two set points as in control mode 4. The only difference between mode 5 and mode 4 is that in mode 5, the UPFC controller performs dual control actions just as in control mode 3

DSS property name: Mode, DSS property index: 9

◆ pf()

BatchFloat64ArrayProxy dss::obj::UPFCBatch::pf ( )

inline

Power factor target at the input terminal.

DSS property name: pf, DSS property index: 4

◆ phases()

BatchInt32ArrayProxy dss::obj::UPFCBatch::phases ( )

inline

Number of phases.

Defaults to 1 phase (2 terminals, 1 conductor per terminal).

DSS property name: phases, DSS property index: 6

◆ refkv()

BatchFloat64ArrayProxy dss::obj::UPFCBatch::refkv ( )

inline

Base Voltage expected at the output of the UPFC.

"refkv=0.24"

DSS property name: refkv, DSS property index: 3

◆ refkv2()

BatchFloat64ArrayProxy dss::obj::UPFCBatch::refkv2 ( )

inline

Base Voltage expected at the output of the UPFC for control modes 4 and 5.

This reference must be lower than refkv, see control modes 4 and 5 for details

DSS property name: refkv2, DSS property index: 15

◆ spectrum()

strings dss::obj::UPFCBatch::spectrum ( )

inline

Name of harmonic spectrum for this source.

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

DSS property name: spectrum, DSS property index: 17

◆ spectrum_obj()

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

inline

Name of harmonic spectrum for this source.

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

DSS property name: spectrum, DSS property index: 17

◆ Tol1()

BatchFloat64ArrayProxy dss::obj::UPFCBatch::Tol1 ( )

inline

Tolerance in pu for the series PI controller Tol1=0.02 is the format used to define 2% tolerance (Default=2%)

DSS property name: Tol1, DSS property index: 8

◆ VHLimit()

BatchFloat64ArrayProxy dss::obj::UPFCBatch::VHLimit ( )

inline

High limit for the voltage at the input of the UPFC, if the voltage is above this value the UPFC turns off.

This value is specified in Volts (default 300 V)

DSS property name: VHLimit, DSS property index: 12

◆ VLLimit()

BatchFloat64ArrayProxy dss::obj::UPFCBatch::VLLimit ( )

inline

low limit for the voltage at the input of the UPFC, if voltage is below this value the UPFC turns off.

This value is specified in Volts (default 125 V)

DSS property name: VLLimit, DSS property index: 13

◆ VpqMax()

BatchFloat64ArrayProxy dss::obj::UPFCBatch::VpqMax ( )

inline

Maximum voltage (in volts) delivered by the series voltage source (Default = 24 V)

DSS property name: VpqMax, DSS property index: 10

◆ Xs()

BatchFloat64ArrayProxy dss::obj::UPFCBatch::Xs ( )

inline

Reactance of the series transformer of the UPFC, ohms (default=0.7540 ... 2 mH)

DSS property name: Xs, DSS property index: 7

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

◆ basefreq()

◆ bus1()

◆ bus2()

◆ CLimit()

◆ enabled()

◆ frequency()

◆ kvarLimit()

◆ like() [1/2]

◆ like() [2/2]

◆ LossCurve()

◆ LossCurve_obj()

◆ Mode()

◆ pf()

◆ phases()

◆ refkv()

◆ refkv2()

◆ spectrum()

◆ spectrum_obj()

◆ Tol1()

◆ VHLimit()

◆ VLLimit()

◆ VpqMax()

◆ Xs()