Inheritance diagram for dss::obj::UPFC:

Collaboration diagram for dss::obj::UPFC:

Classes
struct	Properties

Public Member Functions
	UPFC (APIUtil util=nullptr, void ptr_=nullptr)
	Create wrapper directly by a given object handle/pointer.

	UPFC (APIUtil *util, int32_t idx)
	Create a wrapper for an element given by the integer index "idx".

	UPFC (APIUtil util, char name)
	Create a wrapper for an element given its name.

const char *	name ()
	Returns the object's name.

UPFC &	begin_edit ()
	Marks an object for edition. More...

UPFC &	end_edit (int32_t num_edits=1)
	Finalizes an object edition. More...

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

UPFC &	bus1 (const string &value)

UPFC &	bus1 (const char *value)

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

UPFC &	bus2 (const string &value)

UPFC &	bus2 (const char *value)

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

UPFC &	refkv (double value)

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

UPFC &	pf (double value)

double	frequency ()
	UPFC working frequency. More...

UPFC &	frequency (double value)

int32_t	phases ()
	Number of phases. More...

UPFC &	phases (int32_t value)

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

UPFC &	Xs (double value)

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

UPFC &	Tol1 (double value)

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

UPFC &	Mode (int32_t value)

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

UPFC &	VpqMax (double value)

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

UPFC &	LossCurve (const string &value)

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

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

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

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

UPFC &	VHLimit (double value)

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

UPFC &	VLLimit (double value)

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

UPFC &	CLimit (double value)

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

UPFC &	refkv2 (double value)

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

UPFC &	kvarLimit (double value)

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

UPFC &	spectrum (const string &value)

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

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

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

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

UPFC &	basefreq (double value)

bool	enabled ()
	{Yes\|No or True\|False} Indicates whether this element is enabled. More...

UPFC &	enabled (bool value)

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

UPFC &	like (const char *value)
	Make like another object, e.g. More...

Public Member Functions inherited from dss::obj::DSSObj
	DSSObj (APIUtil util=nullptr, void ptr_=nullptr)

Static Public Attributes
static const char	dss_cls_name [] = "UPFC"

static const int32_t	dss_cls_idx = 35

Additional Inherited Members
Public Attributes inherited from dss::obj::DSSObj
APIUtil *	api_util

void *	ptr

Protected Member Functions inherited from dss::obj::DSSObj
void	check_for_error ()

void	set_string (int32_t index, const string &value)

void	set_string (int32_t index, const char *value)

string	get_prop_string (int32_t index)

complex	get_complex (int32_t index)

void	set_complex (int32_t index, complex value)

void	set_string_array (int32_t index, strings &value)

void	set_obj (int32_t index, DSSObj &value)

template<typename T >
T	get_obj (int32_t index)

template<typename T = VectorXd>
T	get_array (int32_t index)

template<typename T = VectorXd>
void	set_array (int32_t index, T value)

Static Protected Member Functions inherited from dss::obj::DSSObj
template<typename T = VectorXd>
static void	set_array (void *ptr, int32_t index, T value)

Protected Attributes inherited from dss::obj::DSSObj
friend	DSSBatch

Member Function Documentation

◆ basefreq()

double dss::obj::UPFC::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 18

◆ begin_edit()

UPFC & dss::obj::UPFC::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

◆ bus1()

string dss::obj::UPFC::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()

string dss::obj::UPFC::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()

double dss::obj::UPFC::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()

bool dss::obj::UPFC::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 19

◆ end_edit()

UPFC & dss::obj::UPFC::end_edit ( int32_t num_edits = 1 )

inline

Finalizes an object edition.

This will result more compelx side-effects like Yprim and other internal data recalculation, for example.

◆ frequency()

double dss::obj::UPFC::frequency ( )

inline

UPFC working frequency.

Defaults to system default base frequency.

DSS property name: frequency, DSS property index: 5

◆ kvarLimit()

double dss::obj::UPFC::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]

UPFC & dss::obj::UPFC::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]

UPFC & dss::obj::UPFC::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()

string dss::obj::UPFC::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()

dss::obj::XYcurve dss::obj::UPFC::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()

int32_t dss::obj::UPFC::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()

double dss::obj::UPFC::pf ( )

inline

Power factor target at the input terminal.

DSS property name: pf, DSS property index: 4

◆ phases()

int32_t dss::obj::UPFC::phases ( )

inline

Number of phases.

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

DSS property name: phases, DSS property index: 6

◆ refkv()

double dss::obj::UPFC::refkv ( )

inline

Base Voltage expected at the output of the UPFC.

"refkv=0.24"

DSS property name: refkv, DSS property index: 3

◆ refkv2()

double dss::obj::UPFC::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()

string dss::obj::UPFC::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()

dss::obj::Spectrum dss::obj::UPFC::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()

double dss::obj::UPFC::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()

double dss::obj::UPFC::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()

double dss::obj::UPFC::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()

double dss::obj::UPFC::VpqMax ( )

inline

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

DSS property name: VpqMax, DSS property index: 10

◆ Xs()

double dss::obj::UPFC::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

Classes

Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Function Documentation

◆ basefreq()

◆ begin_edit()

◆ bus1()

◆ bus2()

◆ CLimit()

◆ enabled()

◆ end_edit()

◆ frequency()

◆ kvarLimit()

◆ like() [1/2]

◆ like() [2/2]

◆ LossCurve()

◆ LossCurve_obj()

◆ Mode()

◆ pf()

◆ phases()

◆ refkv()

◆ refkv2()

◆ spectrum()

◆ spectrum_obj()

◆ Tol1()

◆ VHLimit()

◆ VLLimit()

◆ VpqMax()

◆ Xs()