Class: SynchronousMachineDetailed

name: SynchronousMachineDetailed
description: "All synchronous machine detailed types use a subset of the same data\
  \ parameters and input/output variables.  \r\nThe several variations differ in the\
  \ following ways:\r\n- the number of  equivalent windings that are included;\r\n\
  - the way in which saturation is incorporated into the model;\r\n- whether or not\
  \ “subtransient saliency” (<i>X''q</i> not = <i>X''d</i>) is represented.\r\nIt\
  \ is not necessary for each simulation tool to have separate models for each of\
  \ the model types.  The same model can often be used for several types by alternative\
  \ logic within the model.  Also, differences in saturation representation might\
  \ not result in significant model performance differences so model substitutions\
  \ are often acceptable. "
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: SynchronousMachineDynamics
attributes:
  efd_base_ratio:
    name: efd_base_ratio
    description: Ratio (exciter voltage/generator voltage) of <i>Efd</i> bases of
      exciter and generator models (&gt; 0). Typical value = 1.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SynchronousMachineDetailed.efdBaseRatio
    multivalued: false
    domain_of:
    - SynchronousMachineDetailed
    range: float
    required: false
  ifd_base_type:
    name: ifd_base_type
    description: 'Excitation base system mode. It should be equal to the value of
      <i>WLMDV</i> given by the user. <i>WLMDV</i> is the PU ratio between the field
      voltage and the excitation current: <i>Efd</i> = <i>WLMDV</i> x <i>Ifd</i>.
      Typical value = ifag.'
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SynchronousMachineDetailed.ifdBaseType
    multivalued: false
    domain_of:
    - SynchronousMachineDetailed
    range: IfdBaseKind
    required: false
  saturation_factor___qaxis:
    name: saturation_factor___qaxis
    description: Quadrature-axis saturation factor at 120% of rated terminal voltage
      (<i>S12q</i>) (&gt;= SynchonousMachineDetailed.saturationFactorQAxis).  Typical
      value = 0,12.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SynchronousMachineDetailed.saturationFactor120QAxis
    multivalued: false
    domain_of:
    - SynchronousMachineDetailed
    range: float
    required: false
  saturation_factor_qaxis:
    name: saturation_factor_qaxis
    description: Quadrature-axis saturation factor at rated terminal voltage (<i>S1q</i>)
      (&gt;= 0). Typical value = 0,02.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SynchronousMachineDetailed.saturationFactorQAxis
    multivalued: false
    domain_of:
    - SynchronousMachineDetailed
    range: float
    required: false
class_uri: cim:SynchronousMachineDetailed

name: SynchronousMachineDetailed
description: "All synchronous machine detailed types use a subset of the same data\
  \ parameters and input/output variables.  \r\nThe several variations differ in the\
  \ following ways:\r\n- the number of  equivalent windings that are included;\r\n\
  - the way in which saturation is incorporated into the model;\r\n- whether or not\
  \ “subtransient saliency” (<i>X''q</i> not = <i>X''d</i>) is represented.\r\nIt\
  \ is not necessary for each simulation tool to have separate models for each of\
  \ the model types.  The same model can often be used for several types by alternative\
  \ logic within the model.  Also, differences in saturation representation might\
  \ not result in significant model performance differences so model substitutions\
  \ are often acceptable. "
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: SynchronousMachineDynamics
attributes:
  efd_base_ratio:
    name: efd_base_ratio
    description: Ratio (exciter voltage/generator voltage) of <i>Efd</i> bases of
      exciter and generator models (&gt; 0). Typical value = 1.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SynchronousMachineDetailed.efdBaseRatio
    multivalued: false
    alias: efd_base_ratio
    owner: SynchronousMachineDetailed
    domain_of:
    - SynchronousMachineDetailed
    range: float
    required: false
  ifd_base_type:
    name: ifd_base_type
    description: 'Excitation base system mode. It should be equal to the value of
      <i>WLMDV</i> given by the user. <i>WLMDV</i> is the PU ratio between the field
      voltage and the excitation current: <i>Efd</i> = <i>WLMDV</i> x <i>Ifd</i>.
      Typical value = ifag.'
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SynchronousMachineDetailed.ifdBaseType
    multivalued: false
    alias: ifd_base_type
    owner: SynchronousMachineDetailed
    domain_of:
    - SynchronousMachineDetailed
    range: IfdBaseKind
    required: false
  saturation_factor___qaxis:
    name: saturation_factor___qaxis
    description: Quadrature-axis saturation factor at 120% of rated terminal voltage
      (<i>S12q</i>) (&gt;= SynchonousMachineDetailed.saturationFactorQAxis).  Typical
      value = 0,12.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SynchronousMachineDetailed.saturationFactor120QAxis
    multivalued: false
    alias: saturation_factor___qaxis
    owner: SynchronousMachineDetailed
    domain_of:
    - SynchronousMachineDetailed
    range: float
    required: false
  saturation_factor_qaxis:
    name: saturation_factor_qaxis
    description: Quadrature-axis saturation factor at rated terminal voltage (<i>S1q</i>)
      (&gt;= 0). Typical value = 0,02.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SynchronousMachineDetailed.saturationFactorQAxis
    multivalued: false
    alias: saturation_factor_qaxis
    owner: SynchronousMachineDetailed
    domain_of:
    - SynchronousMachineDetailed
    range: float
    required: false
  synchronous_machine:
    name: synchronous_machine
    description: Synchronous machine to which synchronous machine dynamics model applies.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SynchronousMachineDynamics.SynchronousMachine
    multivalued: false
    alias: synchronous_machine
    owner: SynchronousMachineDetailed
    domain_of:
    - SynchronousMachineDynamics
    range: SynchronousMachine
    required: true
  turbine_governor_dynamics:
    name: turbine_governor_dynamics
    description: Turbine-governor model associated with this synchronous machine model.
      Multiplicity of greater than one is intended to support hydro units that have
      multiple turbines on one generator.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SynchronousMachineDynamics.TurbineGovernorDynamics
    multivalued: true
    alias: turbine_governor_dynamics
    owner: SynchronousMachineDetailed
    domain_of:
    - SynchronousMachineDynamics
    - AsynchronousMachineDynamics
    - TurbineLoadControllerDynamics
    range: TurbineGovernorDynamics
    required: false
  gen_icompensation_for_gen_j:
    name: gen_icompensation_for_gen_j
    description: Compensation of voltage compensator's generator for current flow
      out of this  generator.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SynchronousMachineDynamics.GenICompensationForGenJ
    multivalued: true
    alias: gen_icompensation_for_gen_j
    owner: SynchronousMachineDetailed
    domain_of:
    - SynchronousMachineDynamics
    - VCompIEEEType2
    range: GenICompensationForGenJ
    required: false
  excitation_system_dynamics:
    name: excitation_system_dynamics
    description: Excitation system model associated with this synchronous machine
      model.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SynchronousMachineDynamics.ExcitationSystemDynamics
    multivalued: false
    alias: excitation_system_dynamics
    owner: SynchronousMachineDetailed
    domain_of:
    - SynchronousMachineDynamics
    - VoltageCompensatorDynamics
    - PowerSystemStabilizerDynamics
    - UnderexcitationLimiterDynamics
    - DiscontinuousExcitationControlDynamics
    - PFVArControllerType1Dynamics
    - OverexcitationLimiterDynamics
    - PFVArControllerType2Dynamics
    range: ExcitationSystemDynamics
    required: false
  cross_compound_turbine_governor_dynamics:
    name: cross_compound_turbine_governor_dynamics
    description: The cross-compound turbine governor with which this low-pressure
      synchronous machine is associated.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SynchronousMachineDynamics.CrossCompoundTurbineGovernorDynamics
    multivalued: false
    alias: cross_compound_turbine_governor_dynamics
    owner: SynchronousMachineDetailed
    domain_of:
    - SynchronousMachineDynamics
    range: CrossCompoundTurbineGovernorDynamics
    required: false
  cross_compound_turbine_governor_dyanmics:
    name: cross_compound_turbine_governor_dyanmics
    description: The cross-compound turbine governor with which this high-pressure
      synchronous machine is associated.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SynchronousMachineDynamics.CrossCompoundTurbineGovernorDyanmics
    multivalued: false
    alias: cross_compound_turbine_governor_dyanmics
    owner: SynchronousMachineDetailed
    domain_of:
    - SynchronousMachineDynamics
    range: CrossCompoundTurbineGovernorDynamics
    required: false
  mechanical_load_dynamics:
    name: mechanical_load_dynamics
    description: Mechanical load model associated with this synchronous machine model.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SynchronousMachineDynamics.MechanicalLoadDynamics
    multivalued: false
    alias: mechanical_load_dynamics
    owner: SynchronousMachineDetailed
    domain_of:
    - SynchronousMachineDynamics
    - AsynchronousMachineDynamics
    range: MechanicalLoadDynamics
    required: false
  damping:
    name: damping
    description: Damping torque coefficient (<i>D</i>) (&gt;= 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.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RotatingMachineDynamics.damping
    multivalued: false
    alias: damping
    owner: SynchronousMachineDetailed
    domain_of:
    - RotatingMachineDynamics
    range: float
    required: false
  inertia:
    name: inertia
    description: Inertia constant of generator or motor and mechanical load (<i>H</i>)
      (&gt; 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.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RotatingMachineDynamics.inertia
    multivalued: false
    alias: inertia
    owner: SynchronousMachineDetailed
    domain_of:
    - RotatingMachineDynamics
    range: Seconds
    required: false
  saturation_factor:
    name: saturation_factor
    description: Saturation factor at 120% of rated terminal voltage (<i>S12</i>)
      (&gt;= RotatingMachineDynamics.saturationFactor). Not used by the simplified
      model, defined by <i>S</i>(<i>E2</i>) in the SynchronousMachineSaturationParameters
      diagram.  Typical value = 0,12.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RotatingMachineDynamics.saturationFactor120
    multivalued: false
    alias: saturation_factor
    owner: SynchronousMachineDetailed
    domain_of:
    - RotatingMachineDynamics
    range: float
    required: false
  stator_leakage_reactance:
    name: stator_leakage_reactance
    description: Stator leakage reactance (<i>Xl</i>) (&gt;= 0). Typical value = 0,15.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RotatingMachineDynamics.statorLeakageReactance
    multivalued: false
    alias: stator_leakage_reactance
    owner: SynchronousMachineDetailed
    domain_of:
    - RotatingMachineDynamics
    range: PU
    required: false
  stator_resistance:
    name: stator_resistance
    description: Stator (armature) resistance (<i>Rs</i>) (&gt;= 0). Typical value
      = 0,005.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RotatingMachineDynamics.statorResistance
    multivalued: false
    alias: stator_resistance
    owner: SynchronousMachineDetailed
    domain_of:
    - RotatingMachineDynamics
    range: PU
    required: false
  enabled:
    name: enabled
    description: "Function block used indicator.\r\ntrue = use of function block is\
      \ enabled\r\nfalse = use of function block is disabled."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DynamicsFunctionBlock.enabled
    multivalued: false
    alias: enabled
    owner: SynchronousMachineDetailed
    domain_of:
    - ProtectiveAction
    - EndDeviceFunction
    - RegulatingControl
    - DynamicsFunctionBlock
    range: boolean
    required: false
  alias_name:
    name: alias_name
    description: "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.\r\nThe 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.\r\
      \n\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.aliasName
    multivalued: false
    alias: alias_name
    owner: SynchronousMachineDetailed
    domain_of:
    - IdentifiedObject
    range: string
    required: false
  description:
    name: description
    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.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.description
    multivalued: false
    alias: description
    owner: SynchronousMachineDetailed
    domain_of:
    - IdentifiedObject
    - NameType
    - NameTypeAuthority
    - DataSet
    - SwitchingStepGroup
    - AreaReserveSpec
    range: string
    required: false
  m_rid:
    name: m_rid
    description: "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.\r\nFor 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."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.mRID
    multivalued: false
    alias: m_rid
    owner: SynchronousMachineDetailed
    domain_of:
    - IdentifiedObject
    - DataSet
    range: string
    required: false
  diagram_objects:
    name: diagram_objects
    description: The diagram objects that are associated with the domain object.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.DiagramObjects
    multivalued: true
    alias: diagram_objects
    owner: SynchronousMachineDetailed
    domain_of:
    - IdentifiedObject
    range: DiagramObject
    required: false
  instance_set:
    name: instance_set
    description: Dataset containing the data objects.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.InstanceSet
    multivalued: false
    alias: instance_set
    owner: SynchronousMachineDetailed
    domain_of:
    - IdentifiedObject
    range: InstanceSet
    required: true
  names:
    name: names
    description: All names of this identified object.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.Names
    multivalued: true
    alias: names
    owner: SynchronousMachineDetailed
    domain_of:
    - IdentifiedObject
    - NameType
    range: Name
    required: false
  properties_cimdata_object:
    name: properties_cimdata_object
    description: The single CIM data object in the appropriate dataset context.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.PropertiesCIMDataObject
    multivalued: false
    alias: properties_cimdata_object
    owner: SynchronousMachineDetailed
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
  targeting_cimdata_object:
    name: targeting_cimdata_object
    description: Data objects registered.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.TargetingCIMDataObject
    multivalued: true
    alias: targeting_cimdata_object
    owner: SynchronousMachineDetailed
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:SynchronousMachineDetailed