cimpy.cgmes_v2_4_15.ExcREXS module

class cimpy.cgmes_v2_4_15.ExcREXS.ExcREXS(e1=0.0, e2=0.0, fbf=None, flimf=0.0, kc=0.0, kd=0.0, ke=0.0, kefd=0.0, kf=0.0, kh=0.0, kii=0.0, kip=0.0, ks=0.0, kvi=0.0, kvp=0.0, kvphz=0.0, nvphz=0.0, se1=0.0, se2=0.0, ta=0.0, tb1=0.0, tb2=0.0, tc1=0.0, tc2=0.0, te=0.0, tf=0.0, tf1=0.0, tf2=0.0, tp=0.0, vcmax=0.0, vfmax=0.0, vfmin=0.0, vimax=0.0, vrmax=0.0, vrmin=0.0, xc=0.0, *args, **kw_args)

General Purpose Rotating Excitation System Model. This model can be used to represent a wide range of excitation systems whose DC power source is an AC or DC generator. It encompasses IEEE type AC1, AC2, DC1, and DC2 excitation system models.

e1:

Field voltage value 1 (E1). Typical Value = 3. Default: 0.0

e2:

Field voltage value 2 (E2). Typical Value = 4. Default: 0.0

fbf:

Rate feedback signal flag (Fbf). Typical Value = fieldCurrent. Default: None

flimf:

Limit type flag (Flimf). Typical Value = 0. Default: 0.0

kc:

Rectifier regulation factor (Kc). Typical Value = 0.05. Default: 0.0

kd:

Exciter regulation factor (Kd). Typical Value = 2. Default: 0.0

ke:

Exciter field proportional constant (Ke). Typical Value = 1. Default: 0.0

kefd:

Field voltage feedback gain (Kefd). Typical Value = 0. Default: 0.0

kf:

Rate feedback gain (Kf). Typical Value = 0.05. Default: 0.0

kh:

Field voltage controller feedback gain (Kh). Typical Value = 0. Default: 0.0

kii:

Field Current Regulator Integral Gain (Kii). Typical Value = 0. Default: 0.0

kip:

Field Current Regulator Proportional Gain (Kip). Typical Value = 1. Default: 0.0

ks:

Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0

kvi:

Voltage Regulator Integral Gain (Kvi). Typical Value = 0. Default: 0.0

kvp:

Voltage Regulator Proportional Gain (Kvp). Typical Value = 2800. Default: 0.0

kvphz:

V/Hz limiter gain (Kvphz). Typical Value = 0. Default: 0.0

nvphz:

Pickup speed of V/Hz limiter (Nvphz). Typical Value = 0. Default: 0.0

se1:

Saturation factor at E1 (Se1). Typical Value = 0.0001. Default: 0.0

se2:

Saturation factor at E2 (Se2). Typical Value = 0.001. Default: 0.0

ta:

Voltage Regulator time constant (Ta). Typical Value = 0.01. Default: 0.0

tb1:

Lag time constant (Tb1). Typical Value = 0. Default: 0.0

tb2:

Lag time constant (Tb2). Typical Value = 0. Default: 0.0

tc1:

Lead time constant (Tc1). Typical Value = 0. Default: 0.0

tc2:

Lead time constant (Tc2). Typical Value = 0. Default: 0.0

te:

Exciter field time constant (Te). Typical Value = 1.2. Default: 0.0

tf:

Rate feedback time constant (Tf). Typical Value = 1. Default: 0.0

tf1:

Feedback lead time constant (Tf1). Typical Value = 0. Default: 0.0

tf2:

Feedback lag time constant (Tf2). Typical Value = 0. Default: 0.0

tp:

Field current Bridge time constant (Tp). Typical Value = 0. Default: 0.0

vcmax:

Maximum compounding voltage (Vcmax). Typical Value = 0. Default: 0.0

vfmax:

Maximum Exciter Field Current (Vfmax). Typical Value = 47. Default: 0.0

vfmin:

Minimum Exciter Field Current (Vfmin). Typical Value = -20. Default: 0.0

vimax:

Voltage Regulator Input Limit (Vimax). Typical Value = 0.1. Default: 0.0

vrmax:

Maximum controller output (Vrmax). Typical Value = 47. Default: 0.0

vrmin:

Minimum controller output (Vrmin). Typical Value = -20. Default: 0.0

xc:

Exciter compounding reactance (Xc). Typical Value = 0. 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: