IscDCMachine

The IscDCMachine class provides access to an IPSA DC machine, to set and get data values and to retrieve load flow results.

Field Values

IscDCMachine Field Values

Type

Field Name

Description

Integer

FromUID

Gets the unique ID for busbar.

String

BusName

Gets the busbar name.

String

Name

Gets the DC machine name.

Integer

Status

Status:

  • 0 = Switched in

  • -1 = Switched out

Float

BusVoltagePU

Sets and gets the busbar voltage in per unit.

Float

MechPowerMW

Sets and gets the mechanical output power in MW.

Float

Efficiency

Sets and gets the machine efficiency in percent.

Float

Speed

Sets and gets the machine speed in per unit.

Float

ArmResistPU

Sets and gets the armature resistance in per unit.

Float

ShuntResisPU

Sets and gets the shunt resistance in per unit.

Float

ControlResisPU

Sets and gets the control field resistance in per unit.

Float

ShuntTRatio

Sets and gets the shunt field turns ratio.

Float

SeriesTRatio

Sets and gets the series field turns ratio.

Float

Compounding

Sets and gets the flag to indicate if the machine has a compound winding.

Float

SatFac75

Sets and gets the saturation factor for the MMF at 75% of flux.

Float

SatFac120

Sets and gets the saturation factor for the MMF at 120% of flux.

Float

ArmSelfIndPU

Sets and gets the armature field self-inductance in per unit.

Float

SeriesSelfIndPU

Sets and gets the series field self-inductance in per unit.

Float

ShuntSelfIndPU

Sets and gets the shunt field self-inductance in per unit.

Float

CtrlSelfIndPU

Sets and gets the control field self-inductance in per unit.

Float

LeakageIndPU

Sets and gets the shunt field leakage inductance in per unit.

Float

MechLossConst

Sets and gets the mechanical loss coefficient.

Float

InertiaSec

Sets and gets the machine inertia.

Float

TSlipB

Sets and gets the load torque slip coefficient B.

Float

TSlipC

Sets and gets the load torque slip coefficient C.

IscDCMachine Class

class ipsa.IscDCMachine

Provides access to an IPSA DC machine.

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

GetRealMechanicalPowerMW() → float

Returns the mechanical output power of the DC machine in MW.

Returns:

The mechanical output power of the DC machine in MW.

Return type:

float

GetRealMechanicalPowerkW() → float

Returns the mechanical output power of the DC machine in kW.

Returns:

The mechanical output power of the DC machine in kW.

Return type:

float

GetRealElectricalPowerMW() → float

Returns the electrical output power of the DC machine in MW.

Returns:

The electrical output power of the DC machine in MW.

Return type:

float

GetRealElectricalPowerkW() → float

Returns the electrical output power of the DC machine in kW.

Returns:

The electrical output power of the DC machine in kW.

Return type:

float

GetTotalPowerMVA() → float

Returns the total output power of the DC machine in MVA.

Returns:

The total output power of the DC machine in MVA.

Return type:

float

GetTotalPowerkVA() → float

Returns the total output power of the DC machine in kVA.

Returns:

The total output power of the DC machine in kVA.

Return type:

float

GetPowerLossMW() → float

Returns the power loss of the DC machine in MW.

Returns:

The power loss of the DC machine in MW.

Return type:

float

GetPowerLosskW() → float

Returns the power loss of the DC machine in kW.

Returns:

The power loss of the DC machine in kW.

Return type:

float

GetCurrentkA() → float

Returns the DC machine injected current in kA.

Returns:

The DC machine injected current in kA.

Return type:

float