cimpy.cgmes_v2_4_15.ExcIEEEDC4B module

class cimpy.cgmes_v2_4_15.ExcIEEEDC4B.ExcIEEEDC4B(ka=0.0, ta=0, kp=0.0, ki=0.0, kd=0.0, td=0, vrmax=0.0, vrmin=0.0, ke=0.0, te=0, kf=0.0, tf=0, efd1=0.0, seefd1=0.0, efd2=0.0, seefd2=0.0, vemin=0.0, oelin=False, uelin=False, *args, **kw_args)

The class represents IEEE Std 421.5-2005 type DC4B model. These excitation systems utilize a field-controlled dc commutator exciter with a continuously acting voltage regulator having supplies obtained from the generator or auxiliary bus. Reference: IEEE Standard 421.5-2005 Section 5.4.

ka

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

ta

Voltage regulator time constant (T). Typical Value = 0.2. Default: 0

kp

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

ki

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

kd

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

td

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

vrmax

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

vrmin

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

ke

Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0

te

Exciter time constant, integration rate associated with exciter control (T). Typical Value = 0.8. Default: 0

kf

Excitation control system stabilizer gain (K). Typical Value = 0. Default: 0.0

tf

Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0

efd1

Exciter voltage at which exciter saturation is defined (E). Typical Value = 1.75. Default: 0.0

seefd1

Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.08. Default: 0.0

efd2

Exciter voltage at which exciter saturation is defined (E). Typical Value = 2.33. Default: 0.0

seefd2

Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.27. Default: 0.0

vemin

Minimum exciter voltage output(V). Typical Value = 0. Default: 0.0

oelin

OEL input (OELin). true = LV gate false = subtract from error signal. Typical Value = true. Default: False

uelin

UEL input (UELin). true = HV gate false = add to error signal. Typical Value = true. Default: False

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 cimpy.cgmes_v2_4_15.Base.Profile

Inheritance Diagram: