cimpy.cgmes_v2_4_15.ExcIEEEST5B module

class cimpy.cgmes_v2_4_15.ExcIEEEST5B.ExcIEEEST5B(kr=0.0, t1=0, kc=0.0, vrmax=0.0, vrmin=0.0, tc1=0, tb1=0, tc2=0, tb2=0, toc1=0, tob1=0, toc2=0, tob2=0, tuc1=0, tub1=0, tuc2=0, tub2=0, *args, **kw_args)[source]

The class represents IEEE Std 421.5-2005 type ST5B model. The Type ST5B excitation system is a variation of the Type ST1A model, with alternative overexcitation and underexcitation inputs and additional limits. Reference: IEEE Standard 421.5-2005 Section 7.5. Note: the block diagram in the IEEE 421.5 standard has input signal Vc and does not indicate the summation point with Vref. The implementation of the ExcIEEEST5B shall consider summation point with Vref.

kr

Regulator gain (K). Typical Value = 200. Default: 0.0

t1

Firing circuit time constant (T1). Typical Value = 0.004. Default: 0

kc

Rectifier regulation factor (K). Typical Value = 0.004. Default: 0.0

vrmax

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

vrmin

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

tc1

Regulator lead time constant (T). Typical Value = 0.8. Default: 0

tb1

Regulator lag time constant (T). Typical Value = 6. Default: 0

tc2

Regulator lead time constant (T). Typical Value = 0.08. Default: 0

tb2

Regulator lag time constant (T). Typical Value = 0.01. Default: 0

toc1

OEL lead time constant (T). Typical Value = 0.1. Default: 0

tob1

OEL lag time constant (T). Typical Value = 2. Default: 0

toc2

OEL lead time constant (T). Typical Value = 0.08. Default: 0

tob2

OEL lag time constant (T). Typical Value = 0.08. Default: 0

tuc1

UEL lead time constant (T). Typical Value = 2. Default: 0

tub1

UEL lag time constant (T). Typical Value = 10. Default: 0

tuc2

UEL lead time constant (T). Typical Value = 0.1. Default: 0

tub2

UEL lag time constant (T). Typical Value = 0.05. Default: 0

Documentation of parent class ExcitationSystemDynamics:

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

SynchronousMachineDynamics

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

PowerSystemStabilizerDynamics

Power system stabilizer 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

VoltageCompensatorDynamics

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

DiscontinuousExcitationControlDynamics

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

UnderexcitationLimiterDynamics

Undrexcitation limiter 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

OverexcitationLimiterDynamics

Overexcitation limiter 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”

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: ‘’

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: ‘’

shortName

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

cgmesProfile

alias of Profile

Inheritance Diagram:

Inheritance diagram of cimpy.cgmes_v2_4_15.ExcIEEEST5B