cimpy.cgmes_v2_4_15.ExcIEEEST4B module

class cimpy.cgmes_v2_4_15.ExcIEEEST4B.ExcIEEEST4B(kc=0.0, kg=0.0, ki=0.0, kim=0.0, kir=0.0, kp=0.0, kpm=0.0, kpr=0.0, ta=0.0, thetap=0.0, vbmax=0.0, vmmax=0.0, vmmin=0.0, vrmax=0.0, vrmin=0.0, xl=0.0, *args, **kw_args)

The class represents IEEE Std 421.5-2005 type ST4B model. This model is a variation of the Type ST3A model, with a proportional plus integral (PI) regulator block replacing the lag-lead regulator characteristic that is in the ST3A model. Both potential and compound source rectifier excitation systems are modeled. The PI regulator blocks have non-windup limits that are represented. The voltage regulator of this model is typically implemented digitally. Reference: IEEE Standard 421.5-2005 Section 7.4.

kc:

Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.113. Default: 0.0

kg:

Feedback gain constant of the inner loop field regulator (K). Typical Value = 0. Default: 0.0

ki:

Potential circuit gain coefficient (K). Typical Value = 0. Default: 0.0

kim:

Voltage regulator integral gain output (K). Typical Value = 0. Default: 0.0

kir:

Voltage regulator integral gain (K). Typical Value = 10.75. Default: 0.0

kp:

Potential circuit gain coefficient (K). Typical Value = 9.3. Default: 0.0

kpm:

Voltage regulator proportional gain output (K). Typical Value = 1. Default: 0.0

kpr:

Voltage regulator proportional gain (K). Typical Value = 10.75. Default: 0.0

ta:

Voltage regulator time constant (T). Typical Value = 0.02. Default: 0.0

thetap:

Potential circuit phase angle (thetap). Typical Value = 0. Default: 0.0

vbmax:

Maximum excitation voltage (V). Typical Value = 11.63. Default: 0.0

vmmax:

Maximum inner loop output (V). Typical Value = 99. Default: 0.0

vmmin:

Minimum inner loop output (V). Typical Value = -99. Default: 0.0

vrmax:

Maximum voltage regulator output (V). Typical Value = 1. Default: 0.0

vrmin:

Minimum voltage regulator output (V). Typical Value = -0.87. Default: 0.0

xl:

Reactance associated with potential source (X). Typical Value = 0.124. Default: 0.0

Documentation of parent class ExcitationSystemDynamics:

Excitation system function block whose behavior is described by reference to a standard model

DiscontinuousExcitationControlDynamics:

Discontinuous excitation control model associated with this excitation system model. Default: None

OverexcitationLimiterDynamics:

Overexcitation limiter model associated with this excitation system model. Default: None

PFVArControllerType1Dynamics:

Power Factor or VAr controller Type I model associated with this excitation system model. Default: None

PFVArControllerType2Dynamics:

Power Factor or VAr controller Type II model associated with this excitation system model. Default: None

PowerSystemStabilizerDynamics:

Power system stabilizer model associated with this excitation system model. Default: None

SynchronousMachineDynamics:

Synchronous machine model with which this excitation system model is associated. Default: None

UnderexcitationLimiterDynamics:

Undrexcitation limiter model associated with this excitation system model. Default: None

VoltageCompensatorDynamics:

Voltage compensator model associated with this excitation system model. Default: None

Documentation of parent class DynamicsFunctionBlock:

Abstract parent class for all Dynamics function blocks.

enabled:

Function block used indicator. true = use of function block is enabled false = use of function block is disabled. Default: False

Documentation of parent class IdentifiedObject:

This is a root class to provide common identification for all classes needing identification and naming attributes.

DiagramObjects:

The domain object to which this diagram object is associated. Default: “list”

description:

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy. Default: ‘’

energyIdentCodeEic:

The attribute is used for an exchange of the EIC code (Energy identification Code). The length of the string is 16 characters as defined by the EIC code. References: Default: ‘’

mRID:

Master resource identifier issued by a model authority. The mRID is globally unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended. For CIMXML data files in RDF syntax conforming to IEC 61970-552 Edition 1, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements. Default: ‘’

name:

The name is any free human readable and possibly non unique text naming the object. Default: ‘’

shortName:

The attribute is used for an exchange of a human readable short name with length of the string 12 characters maximum. Default: ‘’

Inheritance Diagram: