cimpy.cgmes_v2_4_15.ExcPIC module
- class cimpy.cgmes_v2_4_15.ExcPIC.ExcPIC(ka=0.0, ta1=0, vr1=0.0, vr2=0.0, ta2=0, ta3=0, ta4=0, vrmax=0.0, vrmin=0.0, kf=0.0, tf1=0, tf2=0, efdmax=0.0, efdmin=0.0, ke=0.0, te=0, e1=0.0, se1=0.0, e2=0.0, se2=0.0, kp=0.0, ki=0.0, kc=0.0, *args, **kw_args)[source]
Proportional/Integral Regulator Excitation System Model. This model can be used to represent excitation systems with a proportional-integral (PI) voltage regulator controller.
- ka
PI controller gain (Ka). Typical Value = 3.15. Default: 0.0
- ta1
PI controller time constant (Ta1). Typical Value = 1. Default: 0
- vr1
PI maximum limit (Vr1). Typical Value = 1. Default: 0.0
- vr2
PI minimum limit (Vr2). Typical Value = -0.87. Default: 0.0
- ta2
Voltage regulator time constant (Ta2). Typical Value = 0.01. Default: 0
- ta3
Lead time constant (Ta3). Typical Value = 0. Default: 0
- ta4
Lag time constant (Ta4). Typical Value = 0. Default: 0
- vrmax
Voltage regulator maximum limit (Vrmax). Typical Value = 1. Default: 0.0
- vrmin
Voltage regulator minimum limit (Vrmin). Typical Value = -0.87. Default: 0.0
- kf
Rate feedback gain (Kf). Typical Value = 0. Default: 0.0
- tf1
Rate feedback time constant (Tf1). Typical Value = 0. Default: 0
- tf2
Rate feedback lag time constant (Tf2). Typical Value = 0. Default: 0
- efdmax
Exciter maximum limit (Efdmax). Typical Value = 8. Default: 0.0
- efdmin
Exciter minimum limit (Efdmin). Typical Value = -0.87. Default: 0.0
- ke
Exciter constant (Ke). Typical Value = 0. Default: 0.0
- te
Exciter time constant (Te). Typical Value = 0. Default: 0
- e1
Field voltage value 1 (E1). Typical Value = 0. Default: 0.0
- se1
Saturation factor at E1 (Se1). Typical Value = 0. Default: 0.0
- e2
Field voltage value 2 (E2). Typical Value = 0. Default: 0.0
- se2
Saturation factor at E2 (Se2). Typical Value = 0. Default: 0.0
- kp
Potential source gain (Kp). Typical Value = 6.5. Default: 0.0
- ki
Current source gain (Ki). Typical Value = 0. Default: 0.0
- kc
Exciter regulation factor (Kc). Typical Value = 0.08. Default: 0.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: ‘’