TDSSCktElement

Type-access

Command

Description – (Specific class) otherwise generic

Method- private

Set_Freq

Set frequency and recompute YPrim.

Method- private

Set_Nconds

Sets the number of conductors and creates the conductor array within the class for the caller.

Method- private

Set_NPhases

Sets the number of phases for the device.

Method- private

Set_ActiveTerminal

Activates the given terminal for future queries/operations.

Property- private

Get_ConductorClosed

Evaluates if the conductor given by index is closed.

Method- private

Set_YprimInvalid

Sets the YPrim invalid flag (Boolean) in the value given in the argument.

Property- private

Get_YprimInvalid

Returns the value of the YPrim invalid Boolean flag.

Property- private

Get_FirstBus

Returns the name of bus 1 for the element.

Property- private

Get_NextBus

Returns the name of next bus of the element.

Property- private

Get_Losses

Returns the total losses for the caller.

Property- private

Get_Power

Gets total complex power in active terminal.

Property- private

Get_MaxPower

Gets equivalent total complex power in active terminal based on phase with max current.

Property- private

Get_MaxCurrent

Gets equivalent total complex current on phase with max current. Uses the terminal number given in the argument.

Property- private

Get_MaxCurrentAng

Gets equivalent angle of the total complex current on phase with max current. Uses the terminal number given in the argument.

Property- private

Get_MaxVoltage

Gets equivalent total complex voltage on phase using the terminal index given in the argument.

Property- private

Get_MaxVoltageAng

Gets equivalent total complex voltage phase angle on phase using the terminal index given in the argument.

Property- private

Get_PCE_Value

Gets a value for the active PCE such as P, Q, Vmag, IMag, etc. The value type is given in the argument as an integer number.

Method- private

DoYprimCalcs

Calculates the YPrim matrix for the caller.

Method- protected

Set_Enabled

Sets the enabled flag using the Boolean value given in the argument.

Method- protected

Set_ConductorClosed

Sets the conductor closed flag using the index and Boolean values given in the argument.

Method- protected

Set_NTerms

Sets the number of terminals for the calling object.

Method- protected

Set_Handle

Sets a handle in the form of an integer number for the calling object.

Property- public

GetYPrim

Returns a handler to the object’s YPrim depending on the type of matrix specified in the argument (series, shunt, full).

Property- public

GetYPrimValues

Returns the values of the object’s YPrim specified in the argument (series, shunt, full).

Property- public

MaxTerminalOneIMag

Get max of phase currents on the first terminal; Requires computing Iterminal.

Method- public

ComputeIterminal

Computes Iterminal for this device and put them into a local array.

Method - public

ComputeVterminal

Extracts the voltages in the active terminal of the calling object and put terminal voltages in an array.

Method - public

ZeroITerminal

Sets the local current array to 0.

Method - public

GetCurrents

Get present value of terminal Currents for reports.

Method- public

GetInjCurrents

Returns last Injection currents calculated for this object (caller).

Property- public

InjCurrents

Applies to PC Elements. Puts the injection currents locally calculated straight into the Solution Array.

Property- public

GetBus

Returns the name of the bus addressed using the index in the argument.

Method- public

SetBus

Sets the name of the bus addressed using the index in the argument.

Method- public

SetNodeRef

Set NodeRef Array for fast solution with intrinsics.

Method- public

RecalcElementData

Default for recalculating the foundation of the calling element. It is expected to be override by a more specific class. If not overridden, when called it will trigger an error message. 

Method- public

CalcYPrim

Calculates the YPrim type given in the argument (series, shunt, full).

Method- public

MakePosSequence

Make a positive Sequence Model for the calling object.

Method- public

GetTermVoltages

Fills Vbuffer array which must be adequately allocated by calling routine. Vbuffer is the local array for storing the element voltages.

Method- public

GetPhasePower

Gets the power in each phase (complex losses) of active terminal neutral conductors are ignored by this routine.

Method- public

GetPhaseLosses

Gets the losses in each phase (complex losses); Power difference coming out each phase. Note: This can be misleading if the nodev voltage is greatly unbalanced. Neutral conductors are ignored by this routine.

Method- public

GetLosses

Returns total losses and set LoadLosses=total losses and noload losses =0.

Method- public

GetSeqLosses

For the base class, just return Complex ZERO.

Property- public

GetPropertyValue

Returns the value (string) for the property indicated by index in the argument.

Method- public

InitPropertyValues

Initializes the property values for the class with the default values.

Method- public

DumpProperties

Implements the routine for writing the local properties down into a plain text file at the end.

Property- public

Handle

PA FHandle (local handle) and Set_Handle.

Property- public

Enabled

PA FEnabled (variable) and Set_Enabled.

Property- public

YPrimInvalid

PA get_YprimInvalid and set_YprimInvalid.

Property- public

YPrimFreq

PA FYprimFreq (variable)  and Set_Freq.

Property- public

NTerms

PA Fnterms (variable) and Set_NTerms.

Property- public

NConds

PA Fnconds (variable) and Set_Nconds.

Property- public

NPhases

PA Fnphases (variable) and Set_NPhases.

Property- public

FirstBus

PA Get_FirstBus.

Property- public

NextBus

PA Get_NextBus.

Property- public

Losses

PA Get_Losses.

Property- public

Power

PA Get_Power.

Property- public

MaxPower

PA Get_MaxPower.

Property- public

MaxCurrent

PA Get_MaxCurrent.

Property- public

MaxVoltage

PA Get_MaxVoltage.

Property- public

MaxCurrentAng

PA Get_MaxCurrentAng.

Property- public

MaxVoltageAng

PA Get_MaxVoltageAng.

Property- public

ActiveTerminalIdx

PA FActiveTerminal (variable) and Set_ActiveTerminal.

Property- public

Closed

PA Get_ConductorClosed and Set_ConductorClosed.

Property- public

PCEValue

PA Get_PCE_Value.

Method- public

SumCurrents

Sums the terminal Currents into System Currents Array primarily for Newton Iteration.

Method- public

Get_Current_Mags

Returns the Currents vector in magnitude.