Inheritance diagram for dss::classic::IReactors:

Collaboration diagram for dss::classic::IReactors:

Public Member Functions
	IReactors (dss::APIUtil *util)

strings	AllNames ()
	Array of strings with all Reactor names in the circuit.

int32_t	Count ()
	Number of Reactor objects in active circuit.

int32_t	First ()
	Sets the first Reactor active. More...

string	Name ()
	Get the name of the current active Reactor.

IReactors &	Name (const char *value)
	Sets the active Reactor by Name.

IReactors &	Name (const string &value)

int32_t	Next ()
	Sets the next Reactor active. More...

int32_t	idx ()
	Get active Reactor by index; index is 1-based: 1..count.

void	idx (int32_t value)
	Get active Reactor by index; index is 1-based: 1..count.

int32_t	SpecType ()
	How the reactor data was provided: 1=kvar, 2=R+jX, 3=R and X matrices, 4=sym components. More...

bool	IsDelta ()
	Delta connection or wye?

IReactors &	IsDelta (bool value)

bool	Parallel ()
	Indicates whether Rmatrix and Xmatrix are to be considered in parallel.

IReactors &	Parallel (bool value)

double	LmH ()
	Inductance, mH. More...

IReactors &	LmH (double value)

double	kV ()
	For 2, 3-phase, kV phase-phase. More...

IReactors &	kV (double value)

double	kvar ()
	Total kvar, all phases. More...

IReactors &	kvar (double value)

int32_t	Phases ()
	Number of phases.

IReactors &	Phases (int32_t value)

string	Bus1 ()
	Name of first bus. More...

IReactors &	Bus1 (const char *value)

IReactors &	Bus1 (const string &value)

string	Bus2 ()
	Name of 2nd bus. More...

IReactors &	Bus2 (const char *value)

IReactors &	Bus2 (const string &value)

string	LCurve ()
	Name of XYCurve object, previously defined, describing per-unit variation of phase inductance, L=X/w, vs. More...

IReactors &	LCurve (const char *value)

IReactors &	LCurve (const string &value)

string	RCurve ()
	Name of XYCurve object, previously defined, describing per-unit variation of phase resistance, R, vs. More...

IReactors &	RCurve (const char *value)

IReactors &	RCurve (const string &value)

double	R ()
	Resistance (in series with reactance), each phase, ohms. More...

IReactors &	R (double value)

double	X ()
	Reactance, each phase, ohms at base frequency. More...

IReactors &	X (double value)

double	Rp ()
	Resistance in parallel with R and X (the entire branch). More...

IReactors &	Rp (double value)

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	Rmatrix ()
	Resistance matrix, ohms at base frequency. More...

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
IReactors &	Rmatrix (const VectorT &value)

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	Xmatrix ()
	Reactance matrix, ohms at base frequency. More...

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
IReactors &	Xmatrix (const VectorT &value)

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	Z ()
	Alternative way of defining R and X properties. More...

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
IReactors &	Z (const VectorT &value)

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	Z1 ()
	Positive-sequence impedance, ohms, as a 2-element array representing a complex number. More...

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
IReactors &	Z1 (const VectorT &value)

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	Z2 ()
	Negative-sequence impedance, ohms, as a 2-element array representing a complex number. More...

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
IReactors &	Z2 (const VectorT &value)

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	Z0 ()
	Zero-sequence impedance, ohms, as a 2-element array representing a complex number. More...

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
IReactors &	Z0 (const VectorT &value)

Public Member Functions inherited from dss::ContextState
	ContextState (APIUtil *util)

Additional Inherited Members
Public Attributes inherited from dss::ContextState
void *	ctx
	Pointer to the DSSContext for easy access.

APIUtil *	api_util
	API utility functions.

Member Function Documentation

◆ Bus1()

string dss::classic::IReactors::Bus1 ( )

inline

Name of first bus.

Bus2 property will default to this bus, node 0, unless previously specified. Only Bus1 need be specified for a Yg shunt reactor.

◆ Bus2()

string dss::classic::IReactors::Bus2 ( )

inline

Name of 2nd bus.

Defaults to all phases connected to first bus, node 0, (Shunt Wye Connection) except when Bus2 is specifically defined. Not necessary to specify for delta (LL) connection

◆ First()

int32_t dss::classic::IReactors::First ( )

inline

Sets the first Reactor active.

Returns 0 if no more.

◆ kV()

double dss::classic::IReactors::kV ( )

inline

For 2, 3-phase, kV phase-phase.

Otherwise specify actual coil rating.

◆ kvar()

double dss::classic::IReactors::kvar ( )

inline

Total kvar, all phases.

Evenly divided among phases. Only determines X. Specify R separately

◆ LCurve()

string dss::classic::IReactors::LCurve ( )

inline

Name of XYCurve object, previously defined, describing per-unit variation of phase inductance, L=X/w, vs.

frequency. Applies to reactance specified by X, LmH, Z, or kvar property. L generally decreases somewhat with frequency above the base frequency, approaching a limit at a few kHz.

◆ LmH()

double dss::classic::IReactors::LmH ( )

inline

Inductance, mH.

Alternate way to define the reactance, X, property.

◆ Next()

int32_t dss::classic::IReactors::Next ( )

inline

Sets the next Reactor active.

Returns 0 if no more.

◆ R()

double dss::classic::IReactors::R ( )

inline

Resistance (in series with reactance), each phase, ohms.

This property applies to REACTOR specified by either kvar or X. See also help on Z.

◆ RCurve()

string dss::classic::IReactors::RCurve ( )

inline

Name of XYCurve object, previously defined, describing per-unit variation of phase resistance, R, vs.

frequency. Applies to resistance specified by R or Z property. If actual values are not known, R often increases by approximately the square root of frequency.

◆ Rmatrix()

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>

VectorT dss::classic::IReactors::Rmatrix ( )

inline

Resistance matrix, ohms at base frequency.

Order of the matrix is the number of phases. Mutually exclusive to specifying parameters by kvar or X.

◆ Rp()

double dss::classic::IReactors::Rp ( )

inline

Resistance in parallel with R and X (the entire branch).

Assumed infinite if not specified.

◆ SpecType()

int32_t dss::classic::IReactors::SpecType ( )

inline

How the reactor data was provided: 1=kvar, 2=R+jX, 3=R and X matrices, 4=sym components.

Depending on this value, only some properties are filled or make sense in the context.

◆ X()

double dss::classic::IReactors::X ( )

inline

Reactance, each phase, ohms at base frequency.

◆ Xmatrix()

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>

VectorT dss::classic::IReactors::Xmatrix ( )

inline

Reactance matrix, ohms at base frequency.

Order of the matrix is the number of phases. Mutually exclusive to specifying parameters by kvar or X.

◆ Z()

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>

VectorT dss::classic::IReactors::Z ( )

inline

Alternative way of defining R and X properties.

Enter a 2-element array representing R +jX in ohms.

◆ Z0()

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>

VectorT dss::classic::IReactors::Z0 ( )

inline

Zero-sequence impedance, ohms, as a 2-element array representing a complex number.

Used to define the impedance matrix of the REACTOR if Z1 is also specified.

Note: Z0 defaults to Z1 if it is not specifically defined.

◆ Z1()

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>

VectorT dss::classic::IReactors::Z1 ( )

inline

Positive-sequence impedance, ohms, as a 2-element array representing a complex number.

If defined, Z1, Z2, and Z0 are used to define the impedance matrix of the REACTOR.

Z1 MUST BE DEFINED TO USE THIS OPTION FOR DEFINING THE MATRIX.

Side Effect: Sets Z2 and Z0 to same values unless they were previously defined.

◆ Z2()

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>

VectorT dss::classic::IReactors::Z2 ( )

inline

Negative-sequence impedance, ohms, as a 2-element array representing a complex number.

Used to define the impedance matrix of the REACTOR if Z1 is also specified.

Note: Z2 defaults to Z1 if it is not specifically defined. If Z2 is not equal to Z1, the impedance matrix is asymmetrical.

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

include/dss_classic.hpp

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ Bus1()

◆ Bus2()

◆ First()

◆ kV()

◆ kvar()

◆ LCurve()

◆ LmH()

◆ Next()

◆ R()

◆ RCurve()

◆ Rmatrix()

◆ Rp()

◆ SpecType()

◆ X()

◆ Xmatrix()

◆ Z()

◆ Z0()

◆ Z1()

◆ Z2()