DynamicsFunctionBlock


Abstract parent class for all Dynamics function blocks.

Type: object

Abstract parent class for all synchronous and asynchronous machine standard models.

Type: boolean

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

Type: number

Damping torque coefficient (D) (>= 0). A proportionality constant that, when multiplied by the angular velocity of the rotor poles with respect to the magnetic field (frequency), results in the damping torque. This value is often zero when the sources of damping torques (generator damper windings, load damping effects, etc.) are modelled in detail. Typical value = 0.

Type: object or number

Inertia constant of generator or motor and mechanical load (H) (> 0). This is the specification for the stored energy in the rotating mass when operating at rated speed. For a generator, this includes the generator plus all other elements (turbine, exciter) on the same shaft and has units of MW x s. For a motor, it includes the motor plus its mechanical load. Conventional units are PU on the generator MVA base, usually expressed as MW x s / MVA or just s. This value is used in the accelerating power reference frame for operator training simulator solutions. Typical value = 3.

Type: enum (of string) Default: "none"

nan

Must be one of:

  • "p"
  • "n"
  • "micro"
  • "m"
  • "c"
  • "d"
  • "k"
  • "M"
  • "G"
  • "T"
  • "none"
  • "y"
  • "z"
  • "a"
  • "f"
  • "da"
  • "h"
  • "P"
  • "E"
  • "Z"
  • "Y"

Type: enum (of string) Default: "s"

nan

Must be one of:

  • "none"
  • "m"
  • "kg"
  • "s"
  • "A"
  • "K"
  • "mol"
  • "cd"
  • "deg"
  • "rad"
  • "sr"
  • "Gy"
  • "Bq"
  • "degC"
  • "Sv"
  • "F"
  • "C"
  • "S"
  • "H"
  • "V"
  • "ohm"
  • "J"
  • "N"
  • "Hz"
  • "lx"
  • "lm"
  • "Wb"
  • "T"
  • "W"
  • "Pa"
  • "m2"
  • "m3"
  • "mPers"
  • "mPers2"
  • "m3Pers"
  • "mPerm3"
  • "kgm"
  • "kgPerm3"
  • "WPermK"
  • "JPerK"
  • "ppm"
  • "rotPers"
  • "radPers"
  • "VA"
  • "VAr"
  • "cosPhi"
  • "Vs"
  • "V2"
  • "As"
  • "A2"
  • "A2s"
  • "VAh"
  • "Wh"
  • "VArh"
  • "VPerHz"
  • "HzPers"
  • "character"
  • "charPers"
  • "kgm2"
  • "dB"
  • "WPers"
  • "lPers"
  • "dBm"
  • "h"
  • "min"
  • "Q"
  • "Qh"
  • "ohmm"
  • "APerm"
  • "V2h"
  • "A2h"
  • "Ah"
  • "count"
  • "ft3"
  • "m3Perh"
  • "gal"
  • "Btu"
  • "l"
  • "lPerh"
  • "lPerl"
  • "gPerg"
  • "molPerm3"
  • "molPermol"
  • "molPerkg"
  • "sPers"
  • "HzPerHz"
  • "VPerV"
  • "APerA"
  • "VPerVA"
  • "rev"
  • "kat"
  • "JPerkg"
  • "m3Uncompensated"
  • "m3Compensated"
  • "WPerW"
  • "therm"
  • "onePerm"
  • "m3Perkg"
  • "Pas"
  • "Nm"
  • "NPerm"
  • "radPers2"
  • "WPerm2"
  • "JPerkgK"
  • "JPerm3"
  • "VPerm"
  • "CPerm3"
  • "CPerm2"
  • "FPerm"
  • "HPerm"
  • "JPermol"
  • "JPermolK"
  • "CPerkg"
  • "GyPers"
  • "WPersr"
  • "WPerm2sr"
  • "katPerm3"
  • "d"
  • "anglemin"
  • "anglesec"
  • "ha"
  • "tonne"
  • "bar"
  • "mmHg"
  • "M"
  • "kn"
  • "Vh"
  • "Mx"
  • "G"
  • "Oe"
  • "WPerA"
  • "SPerm"
  • "onePerHz"
  • "VPerVAr"
  • "ohmPerm"
  • "kgPerJ"
  • "JPers"
  • "m2Pers"
  • "JPerm2"
  • "KPers"
  • "PaPers"

Type: number Default: null

Time, in seconds

Type: number

Saturation factor at rated terminal voltage (S1) (>= 0). Not used by simplified model. Defined by defined by S(E1) in the SynchronousMachineSaturationParameters diagram. Typical value = 0,02.

Type: number

Saturation factor at 120% of rated terminal voltage (S12) (>= RotatingMachineDynamics.saturationFactor). Not used by the simplified model, defined by S(E2) in the SynchronousMachineSaturationParameters diagram. Typical value = 0,12.

Type: object or number

Stator leakage reactance (Xl) (>= 0). Typical value = 0,15.

Type: object or number

Stator (armature) resistance (Rs) (>= 0). Typical value = 0,005.

Same definition as RotatingMachineDynamics.statorLeakageReactance

Type: number

Ratio (exciter voltage/generator voltage) of Efd bases of exciter and generator models (> 0). Typical value = 1.

Type: enum (of string)

Excitation base system mode. It should be equal to the value of WLMDV given by the user. WLMDV is the PU ratio between the field voltage and the excitation current: Efd = WLMDV x Ifd. Typical value = ifag.

Must be one of:

  • "ifag"
  • "ifnl"
  • "iffl"

Type: number

Quadrature-axis saturation factor at 120% of rated terminal voltage (S12q) (>= SynchonousMachineDetailed.saturationFactorQAxis). Typical value = 0,12.

Type: number

Quadrature-axis saturation factor at rated terminal voltage (S1q) (>= 0). Typical value = 0,02.

Type: number

Saturation loading correction factor (Ks) (>= 0). Used only by type J model. Typical value = 0.

Type: enum (of string)

Type of synchronous machine model used in dynamic simulation applications.

Must be one of:

  • "subtransient"
  • "subtransientTypeF"
  • "subtransientTypeJ"
  • "subtransientSimplified"
  • "subtransientSimplifiedDirectAxis"

Type: enum (of string)

Type of rotor on physical machine.

Must be one of:

  • "roundRotor"
  • "salientPole"

Type: object or number

Damping time constant for “Canay” reactance (>= 0). Typical value = 0.

Same definition as RotatingMachineDynamics.inertia

Type: object or number

Direct-axis transient rotor time constant (T'do) (> SynchronousMachineTimeConstantReactance.tppdo). Typical value = 5.

Same definition as RotatingMachineDynamics.inertia

Type: object or number

Direct-axis subtransient rotor time constant (T''do) (> 0). Typical value = 0,03.

Same definition as RotatingMachineDynamics.inertia

Type: object or number

Quadrature-axis subtransient rotor time constant (T''qo) (> 0). Typical value = 0,03.

Same definition as RotatingMachineDynamics.inertia

Type: object or number

Quadrature-axis transient rotor time constant (T'qo) (> SynchronousMachineTimeConstantReactance.tppqo). Typical value = 0,5.

Same definition as RotatingMachineDynamics.inertia

Type: object or number

Direct-axis subtransient reactance (unsaturated) (X''d) (> RotatingMachineDynamics.statorLeakageReactance). Typical value = 0,2.

Same definition as RotatingMachineDynamics.statorLeakageReactance

Type: object or number

Direct-axis synchronous reactance (Xd) (>= SynchronousMachineTimeConstantReactance.xDirectTrans). The quotient of a sustained value of that AC component of armature voltage that is produced by the total direct-axis flux due to direct-axis armature current and the value of the AC component of this current, the machine running at rated speed. Typical value = 1,8.

Same definition as RotatingMachineDynamics.statorLeakageReactance

Type: object or number

Direct-axis transient reactance (unsaturated) (X'd) (>= SynchronousMachineTimeConstantReactance.xDirectSubtrans). Typical value = 0,5.

Same definition as RotatingMachineDynamics.statorLeakageReactance

Type: object or number

Quadrature-axis subtransient reactance (X''q) (> RotatingMachineDynamics.statorLeakageReactance). Typical value = 0,2.

Same definition as RotatingMachineDynamics.statorLeakageReactance

Type: object or number

Quadrature-axis synchronous reactance (Xq) (>= SynchronousMachineTimeConstantReactance.xQuadTrans).
The ratio of the component of reactive armature voltage, due to the quadrature-axis component of armature current, to this component of current, under steady state conditions and at rated frequency. Typical value = 1,6.

Same definition as RotatingMachineDynamics.statorLeakageReactance

Type: object or number

Quadrature-axis transient reactance (X'q) (>= SynchronousMachineTimeConstantReactance.xQuadSubtrans). Typical value = 0,3.

Same definition as RotatingMachineDynamics.statorLeakageReactance

Type: string

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.

Type: object or number

Transient rotor time constant (T'o) (> AsynchronousMachineTimeConstantReactance.tppo). Typical value = 5.

Same definition as RotatingMachineDynamics.inertia

Type: object or number

Subtransient rotor time constant (T''o) (> 0). Typical value = 0,03.

Same definition as RotatingMachineDynamics.inertia

Type: object or number

Transient reactance (unsaturated) (X') (>= AsynchronousMachineTimeConstantReactance.xpp). Typical value = 0,5.

Same definition as RotatingMachineDynamics.statorLeakageReactance

Type: object or number

Subtransient reactance (unsaturated) (X'') (> RotatingMachineDynamics.statorLeakageReactance). Typical value = 0,2.

Same definition as RotatingMachineDynamics.statorLeakageReactance

Type: object or number

Synchronous reactance (Xs) (>= AsynchronousMachineTimeConstantReactance.xp). Typical value = 1,8.

Same definition as RotatingMachineDynamics.statorLeakageReactance

Type: boolean

Behaviour is based on a proprietary model as opposed to a detailed model.
true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes
false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.

Type: boolean

Behaviour is based on a proprietary model as opposed to a detailed model.
true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes
false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is 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, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

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

Type: object

Static var compensator whose behaviour is described by reference to a standard model or by definition of a user-defined model.

Type: boolean

Behaviour is based on a proprietary model as opposed to a detailed model.
true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes
false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.

Type: boolean

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

Type: string

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.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is 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, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

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

Type: object

HVDC whose behaviour is described by reference to a standard model or by definition of a user-defined model.

Type: boolean

Behaviour is based on a proprietary model as opposed to a detailed model.
true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes
false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.

Type: boolean

Behaviour is based on a proprietary model as opposed to a detailed model.
true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes
false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.

Type: boolean

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

Type: string

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.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is 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, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

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

Type: object

Voltage compensator function block whose behaviour is described by reference to a standard model or by definition of a user-defined model.

Type: string

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.

Type: boolean

Behaviour is based on a proprietary model as opposed to a detailed model.
true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes
false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is 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, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

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

Type: boolean

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

Type: object or number

Resistive component of compensation of a generator (Rc) (>= 0).

Same definition as RotatingMachineDynamics.statorLeakageReactance

Type: object or number

Time constant which is used for the combined voltage sensing and compensation signal (Tr) (>= 0).

Same definition as RotatingMachineDynamics.inertia

Type: object or number

Reactive component of compensation of a generator (Xc) (>= 0).

Same definition as RotatingMachineDynamics.statorLeakageReactance

Type: object or number

Time constant which is used for the combined voltage sensing and compensation signal (Tr) (>= 0).

Same definition as RotatingMachineDynamics.inertia