IscChopper

The IscChopper class provides access to a DC/DC Converter, to set and get data values and to retrieve load flow results. Note that in IPSA, like the transformer, the chopper is modelled as a combination of a branch and a tap changer. Therefore some of the chopper data is stored in a branch instance and functions such as GetLineDValue() are used to access branch type data.

Field Values

IscChopper Field Values

Type	Field Name	Description
Integer	FromUID	Gets the unique ID of the sending busbar.
Integer	ToUID	Gets the unique ID of the receiving busbar.
String	FromBusName	Gets the sending busbar name.
String	ToBusName	Gets the receiving busbar name.
String	Name	Gets the chopper name.
Integer	ChopperModel	The chopper gain calculation model: 0 = Voltage gain amplification parameter. 1 = Duty cycle parametrisation (buck-boost).
String	DispChopperModel	Gets the name of the chopper calculation model.
Float	VoltGainRatio	Gets and sets the voltage gain ratio for the ratio model.
Float	VoltGainDutyCycle	Gets and sets the duty cycle value for the duty model.
Float	ConductancePU	Gets and sets the per unit parallel conductive losses for the capacitor component of the chopper.
Float	ConverterEfficiencyPC	Gets and sets the efficiency of the chopper in percent.

IscChopper Class

class ipsa.IscChopper

Provides access to a DC/DC Converter.

SetName(strName: str) → bool

Sets the name as a string.

Parameters:

strName (str) – The selected string name.

Returns:

True if successful.

Return type:

bool

GetIValue(nFieldIndex: int) → int

Returns an integer value for the enumerated field.

Parameters:

nFieldIndex (int) – The field index.

Returns:

The integer value.

Return type:

int

GetDValue(nFieldIndex: int) → float

Returns a double value for the enumerated field.

Parameters:

nFieldIndex (int) – The field index.

Returns:

The double value.

Return type:

float

GetSValue(nFieldIndex: int) → str

Returns a string value for the enumerated field.

Parameters:

nFieldIndex (int) – The field index.

Returns:

The string value.

Return type:

str

GetBValue(nFieldIndex: int) → bool

Returns a boolean value for the enumerated field.

Parameters:

nFieldIndex (int) – The field index.

Returns:

The boolean value.

Return type:

bool

SetIValue(nFieldIndex: int, nValue: int) → bool

Sets the value for the enumerated field from an integer.

Parameters:

• nFieldIndex (int) – The field index.

• nValue (int) – The given integer value.

Returns:

True if successful.

Return type:

bool

SetDValue(nFieldIndex: int, dValue: float) → bool

Sets the value for the enumerated field from a double.

Parameters:

• nFieldIndex (int) – The field index.

• dValue (float) – The given double value.

Returns:

True if successful.

Return type:

bool

SetSValue(nFieldIndex: int, strValue: int) → bool

Sets the value for the enumerated field from a string.

Parameters:

• nFieldIndex (int) – The field index.

• strValue (str) – The given string value.

Returns:

True if successful.

Return type:

bool

SetBValue(nFieldIndex: int, bValue: bool) → bool

Sets the value for the enumerated field from boolean.

Parameters:

• nFieldIndex (int) – The field index.

• bValue (bool) – The given boolean value.

Returns:

True if successful.

Return type:

bool

GetLineIValue(nFieldIndex: int) → int

Returns an integer value for the line associated with this chopper.

Parameters:

nFieldIndex (int) – The field index.

Returns:

The line associated with this chopper.

Return type:

int

GetLineDValue(nFieldIndex: int) → float

Returns a float value for the line associated with this chopper.

Parameters:

nFieldIndex (int) – The field index.

Returns:

The line associated with this chopper.

Return type:

float

GetLineSValue(nFieldIndex: int) → str

Returns a string value for the line associated with this chopper.

Parameters:

nFieldIndex (int) – The field index.

Returns:

The line associated with this chopper.

Return type:

str

SetLineIValue(nFieldIndex: int, nValue: int) → bool

Sets an integer value for the line associated with this chopper.

Parameters:

• nFieldIndex (int) – The field index.

• nValue (int) – The integer value for the line.

Returns:

True if successful.

Return type:

bool

SetLineDValue(nFieldIndex: int, dValue: float) → bool

Sets a float value for the line associated with this chopper.

Parameters:

• nFieldIndex (int) – The field index.

• dValue (float) – The float value for the line.

Returns:

True if successful.

Return type:

bool

SetLineSValue(nFieldIndex: int, strValue: str) → bool

Sets a string value for the line associated with this chopper.

Parameters:

• nFieldIndex (int) – The field index.

• strValue (str) – The string value for the line.

Returns:

True if successful.

Return type:

bool

SetRatingskA(nRatingIndex: int, dSendRatingkA: float, dRecieveRatingkA: float) → None

Sets the sending and receiving end current ratings in kA for the chopper.

Parameters:

• nRatingIndex (int) – Specifies which rating set the data is applied to.

• dSendRatingkA (float) – The sending end current ratings in kA.

• dRecieveRatingkA (float) – The receiving end current ratings in kA.

SetRatingMVA(nRatingIndex: int, dRatingMVA: float) → None

Sets the MVA rating for the chopper.

Parameters:

• nRatingIndex (int) – Specifies which rating set the data is applied to.

• dRatingMVA (float) – The MVA rating.

GetRatingSendkA(nRatingIndex: int) → float

Returns the sending end current ratings in kA for the chopper.

Parameters:

nRatingIndex (int) – Specifies which rating set the data is applied to.

Returns:

The sending end current ratings in kA.

Return type:

float

GetRatingReceivekA(nRatingIndex: int) → float

Returns the receiving end current ratings in kA for the chopper.

Parameters:

nRatingIndex (int) – Specifies which rating set the data is applied to.

Returns:

The receiving end current ratings in kA.

Return type:

float

GetRatingMVA(nRatingIndex: int) → float

Returns the MVA rating for the chopper.

Parameters:

nRatingIndex (int) – Specifies which rating set the data is applied to.

Returns:

The MVA rating.

Return type:

float

GetSendRealPowerMW() → float

Returns the chopper sending end power in MW.

Returns:

The chopper sending end power in MW.

Return type:

float

GetSendRealPowerkW() → float

Returns the chopper sending end power in kW.

Returns:

The chopper sending end power in kW.

Return type:

float

GetSendRealCurrentkA() → float

Returns the chopper sending end current in kA.

Returns:

The chopper sending end current in kA.

Return type:

float

GetReceiveRealPowerMW() → float

Returns the chopper receiving end power in MW.

Returns:

The chopper receiving end power in MW.

Return type:

float

GetReceiveRealPowerkW() → float

Returns the chopper receiving end power in kW.

Returns:

The chopper receiving end power in kW.

Return type:

float

GetReceiveRealCurrentkA() → float

Returns the chopper receiving end current in kA.

Returns:

The chopper receiving end current in kA.

Return type:

float

GetLargestRealPowerMW() → float

Returns the highest chopper end power in MW.

Returns:

The highest chopper end power in MW.

Return type:

float

GetLargestRealPowerkW() → float

Returns the highest chopper end power in kW.

Returns:

The highest chopper end power in kW.

Return type:

float

GetLargestRealCurrentkA() → float

Returns the highest chopper end current in kA.

Returns:

The highest chopper end current in kA.

Return type:

float

GetLossesMW() → float

Returns the chopper losses in MW.

Returns:

The chopper losses in MW.

Return type:

float

GetLosseskW() → float

Returns the chopper losses in kW.

Returns:

The chopper losses in kW.

Return type:

float

GetChopperEfficiency() → float

Returns the efficiency of the chopper in percent.

Returns:

The efficiency of the chopper in percent.

Return type:

float

GetLoadRatio() → float

Returns the ratio of the internal resistance to the load of the chopper for clearer visualization of buck-boost losses (fractional value).

Returns:

The ratio of the internal resistance to the load of the chopper.

Return type:

float