Inheritance diagram for dss::obj::GICTransformer:

Collaboration diagram for dss::obj::GICTransformer:

Classes
struct	Properties

Public Types
enum class	GICTransformerType : int32_t { GSU = 1 , Auto = 2 , YY = 3 }
	GICTransformer: Type (DSS enumeration for GICTransformer) More...

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

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

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

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

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

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

string	BusH ()
	Name of High-side(H) bus. More...

GICTransformer &	BusH (const string &value)

GICTransformer &	BusH (const char *value)

string	BusNH ()
	Name of Neutral bus for H, or first, winding. More...

GICTransformer &	BusNH (const string &value)

GICTransformer &	BusNH (const char *value)

string	BusX ()
	Name of Low-side(X) bus, if type=Auto or YY. More...

GICTransformer &	BusX (const string &value)

GICTransformer &	BusX (const char *value)

string	BusNX ()
	Name of Neutral bus for X, or Second, winding. More...

GICTransformer &	BusNX (const string &value)

GICTransformer &	BusNX (const char *value)

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

GICTransformer &	phases (int32_t value)

GICTransformerType	Type ()
	Type of transformer: {GSU* \| Auto \| YY}. More...

GICTransformer &	Type (int32_t value)

GICTransformer &	Type (GICTransformerType value)

GICTransformer &	Type (const string &value)

GICTransformer &	Type (const char *value)

string	Type_str ()
	Type of transformer: {GSU* \| Auto \| YY}. More...

GICTransformer &	Type_str (const string &value)
	Type of transformer: {GSU* \| Auto \| YY}. More...

double	R1 ()
	Resistance, each phase, ohms for H winding, (Series winding, if Auto). More...

GICTransformer &	R1 (double value)

double	R2 ()
	Resistance, each phase, ohms for X winding, (Common winding, if Auto). More...

GICTransformer &	R2 (double value)

double	KVLL1 ()
	Optional. More...

GICTransformer &	KVLL1 (double value)

double	KVLL2 ()
	Optional. More...

GICTransformer &	KVLL2 (double value)

double	MVA ()
	Optional. More...

GICTransformer &	MVA (double value)

string	VarCurve ()
	Optional. More...

GICTransformer &	VarCurve (const string &value)

GICTransformer &	VarCurve (dss::obj::XYcurve &value)

dss::obj::XYcurve	VarCurve_obj ()
	Optional. More...

GICTransformer &	VarCurve_obj (dss::obj::XYcurve &value)

double	pctR1 ()
	Optional. More...

GICTransformer &	pctR1 (double value)

double	pctR2 ()
	Optional. More...

GICTransformer &	pctR2 (double value)

double	K ()
	Mvar K factor. More...

GICTransformer &	K (double value)

double	normamps ()
	Normal rated current. More...

GICTransformer &	normamps (double value)

double	emergamps ()
	Maximum or emerg current. More...

GICTransformer &	emergamps (double value)

double	faultrate ()
	Failure rate per year. More...

GICTransformer &	faultrate (double value)

double	pctperm ()
	Percent of failures that become permanent. More...

GICTransformer &	pctperm (double value)

double	repair ()
	Hours to repair. More...

GICTransformer &	repair (double value)

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

GICTransformer &	basefreq (double value)

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

GICTransformer &	enabled (bool value)

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

GICTransformer &	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 [] = "GICTransformer"

static const int32_t	dss_cls_idx = 44

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 Enumeration Documentation

◆ GICTransformerType

enum class dss::obj::GICTransformer::GICTransformerType : int32_t

strong

GICTransformer: Type (DSS enumeration for GICTransformer)

Enumerator
GSU	GSU.
Auto	Auto.
YY	YY.

Member Function Documentation

◆ basefreq()

double dss::obj::GICTransformer::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 21

◆ begin_edit()

GICTransformer & dss::obj::GICTransformer::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

◆ BusH()

string dss::obj::GICTransformer::BusH ( )

inline

Name of High-side(H) bus.

Examples: BusH=busname BusH=busname.1.2.3

DSS property name: BusH, DSS property index: 1

◆ BusNH()

string dss::obj::GICTransformer::BusNH ( )

inline

Name of Neutral bus for H, or first, winding.

Defaults to all phases connected to H-side bus, node 0, if not specified and transformer type is either GSU or YY. (Shunt Wye Connection to ground reference)For Auto, this is automatically set to the X bus.

DSS property name: BusNH, DSS property index: 2

◆ BusNX()

string dss::obj::GICTransformer::BusNX ( )

inline

Name of Neutral bus for X, or Second, winding.

Defaults to all phases connected to X-side bus, node 0, if not specified. (Shunt Wye Connection to ground reference)

DSS property name: BusNX, DSS property index: 4

◆ BusX()

string dss::obj::GICTransformer::BusX ( )

inline

Name of Low-side(X) bus, if type=Auto or YY.

DSS property name: BusX, DSS property index: 3

◆ emergamps()

double dss::obj::GICTransformer::emergamps ( )

inline

Maximum or emerg current.

DSS property name: emergamps, DSS property index: 17

◆ enabled()

bool dss::obj::GICTransformer::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 22

◆ end_edit()

GICTransformer & dss::obj::GICTransformer::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.

◆ faultrate()

double dss::obj::GICTransformer::faultrate ( )

inline

Failure rate per year.

DSS property name: faultrate, DSS property index: 18

◆ K()

double dss::obj::GICTransformer::K ( )

inline

Mvar K factor.

Default way to convert GIC Amps in H winding (winding 1) to Mvar. Default is 2.2. Commonly-used simple multiplier for estimating Mvar losses for power flow analysis.

Mvar = K * kvLL * GIC per phase / 1000

Mutually exclusive with using the VarCurve property and pu curves.If you specify this (default), VarCurve is ignored.

DSS property name: K, DSS property index: 15

◆ KVLL1()

double dss::obj::GICTransformer::KVLL1 ( )

inline

Optional.

kV LL rating for H winding (winding 1). Default is 500. Required if you are going to export vars for power flow analysis or enter winding resistances in percent.

DSS property name: KVLL1, DSS property index: 9

◆ KVLL2()

double dss::obj::GICTransformer::KVLL2 ( )

inline

Optional.

kV LL rating for X winding (winding 2). Default is 138. Required if you are going to export vars for power flow analysis or enter winding resistances in percent..

DSS property name: KVLL2, DSS property index: 10

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 23

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 23

◆ MVA()

double dss::obj::GICTransformer::MVA ( )

inline

Optional.

MVA Rating assumed Transformer. Default is 100. Used for computing vars due to GIC and winding resistances if kV and MVA ratings are specified.

DSS property name: MVA, DSS property index: 11

◆ normamps()

double dss::obj::GICTransformer::normamps ( )

inline

Normal rated current.

DSS property name: normamps, DSS property index: 16

◆ pctperm()

double dss::obj::GICTransformer::pctperm ( )

inline

Percent of failures that become permanent.

DSS property name: pctperm, DSS property index: 19

◆ pctR1()

double dss::obj::GICTransformer::pctR1 ( )

inline

Optional.

Percent Resistance, each phase, for H winding (1), (Series winding, if Auto). Default is 0.2.

Alternative way to enter R1 value. It is the actual resistances in ohmns that matter. MVA and kV should be specified.

DSS property name: R1, DSS property index: 13

◆ pctR2()

double dss::obj::GICTransformer::pctR2 ( )

inline

Optional.

Percent Resistance, each phase, for X winding (2), (Common winding, if Auto). Default is 0.2.

Alternative way to enter R2 value. It is the actual resistances in ohms that matter. MVA and kV should be specified.

DSS property name: R2, DSS property index: 14

◆ phases()

int32_t dss::obj::GICTransformer::phases ( )

inline

Number of Phases.

Default is 3.

DSS property name: phases, DSS property index: 5

◆ R1()

double dss::obj::GICTransformer::R1 ( )

inline

Resistance, each phase, ohms for H winding, (Series winding, if Auto).

Default is 0.0001. If

DSS property name: R1, DSS property index: 7

◆ R2()

double dss::obj::GICTransformer::R2 ( )

inline

Resistance, each phase, ohms for X winding, (Common winding, if Auto).

Default is 0.0001.

DSS property name: R2, DSS property index: 8

◆ repair()

double dss::obj::GICTransformer::repair ( )

inline

Hours to repair.

DSS property name: repair, DSS property index: 20

◆ Type()

GICTransformerType dss::obj::GICTransformer::Type ( )

inline

Type of transformer: {GSU* | Auto | YY}.

Default is GSU.

DSS property name: Type, DSS property index: 6

◆ Type_str() [1/2]

string dss::obj::GICTransformer::Type_str ( )

inline

Type of transformer: {GSU* | Auto | YY}.

Default is GSU.

DSS property name: Type, DSS property index: 6

◆ Type_str() [2/2]

GICTransformer & dss::obj::GICTransformer::Type_str ( const string & value )

inline

Type of transformer: {GSU* | Auto | YY}.

Default is GSU.

DSS property name: Type, DSS property index: 6

◆ VarCurve()

string dss::obj::GICTransformer::VarCurve ( )

inline

Optional.

XYCurve object name. Curve is expected as TOTAL pu vars vs pu GIC amps/phase. Vars are in pu of the MVA property. No Default value. Required only if you are going to export vars for power flow analysis. See K property.

DSS property name: VarCurve, DSS property index: 12

◆ VarCurve_obj()

dss::obj::XYcurve dss::obj::GICTransformer::VarCurve_obj ( )

inline

Optional.

XYCurve object name. Curve is expected as TOTAL pu vars vs pu GIC amps/phase. Vars are in pu of the MVA property. No Default value. Required only if you are going to export vars for power flow analysis. See K property.

DSS property name: VarCurve, DSS property index: 12

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

include/dss_obj.hpp

Classes

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ GICTransformerType

Member Function Documentation

◆ basefreq()

◆ begin_edit()

◆ BusH()

◆ BusNH()

◆ BusNX()

◆ BusX()

◆ emergamps()

◆ enabled()

◆ end_edit()

◆ faultrate()

◆ K()

◆ KVLL1()

◆ KVLL2()

◆ like() [1/2]

◆ like() [2/2]

◆ MVA()

◆ normamps()

◆ pctperm()

◆ pctR1()

◆ pctR2()

◆ phases()

◆ R1()

◆ R2()

◆ repair()

◆ Type()

◆ Type_str() [1/2]

◆ Type_str() [2/2]

◆ VarCurve()

◆ VarCurve_obj()