Class: NonlinearShuntCompensatorPhase

A per phase non linear shunt compensator has bank or section admittance values that differ. The attributes g and b of the associated NonlinearShuntCompensatorPhasePoint describe the total conductance and admittance of a NonlinearShuntCompensatorPhasePoint at a section number specified by NonlinearShuntCompensatorPhasePoint.sectionNumber.

URI: cim:NonlinearShuntCompensatorPhase

 classDiagram
    class NonlinearShuntCompensatorPhase
      ShuntCompensatorPhase <|-- NonlinearShuntCompensatorPhase

      NonlinearShuntCompensatorPhase : alias_name

      NonlinearShuntCompensatorPhase : asset_datasheet

          NonlinearShuntCompensatorPhase --> AssetInfo : asset_datasheet

      NonlinearShuntCompensatorPhase : assets

          NonlinearShuntCompensatorPhase --> Asset : assets

      NonlinearShuntCompensatorPhase : clearances

          NonlinearShuntCompensatorPhase --> ClearanceDocument : clearances

      NonlinearShuntCompensatorPhase : configuration_event

          NonlinearShuntCompensatorPhase --> ConfigurationEvent : configuration_event

      NonlinearShuntCompensatorPhase : controls

          NonlinearShuntCompensatorPhase --> Control : controls

      NonlinearShuntCompensatorPhase : description

      NonlinearShuntCompensatorPhase : diagram_objects

          NonlinearShuntCompensatorPhase --> DiagramObject : diagram_objects

      NonlinearShuntCompensatorPhase : generic_action

          NonlinearShuntCompensatorPhase --> GenericAction : generic_action

      NonlinearShuntCompensatorPhase : instance_set

          NonlinearShuntCompensatorPhase --> InstanceSet : instance_set

      NonlinearShuntCompensatorPhase : location

          NonlinearShuntCompensatorPhase --> Location : location

      NonlinearShuntCompensatorPhase : m_rid

      NonlinearShuntCompensatorPhase : maximum_sections

      NonlinearShuntCompensatorPhase : measurements

          NonlinearShuntCompensatorPhase --> Measurement : measurements

      NonlinearShuntCompensatorPhase : names

          NonlinearShuntCompensatorPhase --> Name : names

      NonlinearShuntCompensatorPhase : nonlinear_shunt_compensator_phase_points

          NonlinearShuntCompensatorPhase --> NonlinearShuntCompensatorPhasePoint : nonlinear_shunt_compensator_phase_points

      NonlinearShuntCompensatorPhase : normal_sections

      NonlinearShuntCompensatorPhase : operating_share

          NonlinearShuntCompensatorPhase --> OperatingShare : operating_share

      NonlinearShuntCompensatorPhase : operational_tags

          NonlinearShuntCompensatorPhase --> OperationalTag : operational_tags

      NonlinearShuntCompensatorPhase : phase

          NonlinearShuntCompensatorPhase --> SinglePhaseKind : phase

      NonlinearShuntCompensatorPhase : properties_cimdata_object

          NonlinearShuntCompensatorPhase --> ChangeSetMember : properties_cimdata_object

      NonlinearShuntCompensatorPhase : psrevents

          NonlinearShuntCompensatorPhase --> PSREvent : psrevents

      NonlinearShuntCompensatorPhase : psrtype

          NonlinearShuntCompensatorPhase --> PSRType : psrtype

      NonlinearShuntCompensatorPhase : reporting_group

          NonlinearShuntCompensatorPhase --> ReportingGroup : reporting_group

      NonlinearShuntCompensatorPhase : sections

      NonlinearShuntCompensatorPhase : shunt_compensator

          NonlinearShuntCompensatorPhase --> ShuntCompensator : shunt_compensator

      NonlinearShuntCompensatorPhase : targeting_cimdata_object

          NonlinearShuntCompensatorPhase --> ChangeSetMember : targeting_cimdata_object

      NonlinearShuntCompensatorPhase : verification_action

          NonlinearShuntCompensatorPhase --> VerificationAction : verification_action

Inheritance

IdentifiedObject
- PowerSystemResource
  - ShuntCompensatorPhase
    - NonlinearShuntCompensatorPhase

Slots

Name	Cardinality and Range	Description	Inheritance
nonlinear_shunt_compensator_phase_points	1..* NonlinearShuntCompensatorPhasePoint	All points of the non-linear shunt compensator phase	direct
maximum_sections	0..1 Integer	The maximum number of sections that may be switched in for this phase	ShuntCompensatorPhase
normal_sections	0..1 Integer	For the capacitor phase, the normal number of sections switched in	ShuntCompensatorPhase
phase	0..1 SinglePhaseKind	Phase of this shunt compensator component	ShuntCompensatorPhase
sections	0..1 Float	Shunt compensator sections in use	ShuntCompensatorPhase
shunt_compensator	1..1 ShuntCompensator	Shunt compensator of this shunt compensator phase	ShuntCompensatorPhase
controls	0..* Control	The controller outputs used to actually govern a regulating device, e	PowerSystemResource
measurements	0..* Measurement	The measurements associated with this power system resource	PowerSystemResource
psrtype	0..1 PSRType	Custom classification for this power system resource	PowerSystemResource
configuration_event	0..* ConfigurationEvent	All configuration events created for this Power System resource	PowerSystemResource
reporting_group	0..* ReportingGroup	Reporting groups to which this power system resource belongs	PowerSystemResource
operating_share	0..* OperatingShare	The operating shares of this power system resource	PowerSystemResource
asset_datasheet	0..1 AssetInfo	Datasheet information for this power system resource	PowerSystemResource
verification_action	0..* VerificationAction	The verification action that is performed on the power system resource	PowerSystemResource
clearances	0..* ClearanceDocument	All clearances applicable to this power system resource	PowerSystemResource
generic_action	0..* GenericAction	The generic action that is performed on the power system resource	PowerSystemResource
psrevents	0..* PSREvent	All events associated with this power system resource	PowerSystemResource
assets	0..* Asset	All assets represented by this power system resource	PowerSystemResource
location	0..1 Location	Location of this power system resource	PowerSystemResource
operational_tags	0..* OperationalTag	All operational tags placed on this power system resource	PowerSystemResource
alias_name	0..1 String	The aliasName is free text human readable name of the object alternative to I...	IdentifiedObject
description	0..1 String	The description is a free human readable text describing or naming the object	IdentifiedObject
m_rid	0..1 String	Master resource identifier issued by a model authority	IdentifiedObject
diagram_objects	0..* DiagramObject	The diagram objects that are associated with the domain object	IdentifiedObject
instance_set	1..1 InstanceSet	Dataset containing the data objects	IdentifiedObject
names	0..* Name	All names of this identified object	IdentifiedObject
properties_cimdata_object	0..1 ChangeSetMember	The single CIM data object in the appropriate dataset context	IdentifiedObject
targeting_cimdata_object	0..* ChangeSetMember	Data objects registered	IdentifiedObject

Usages

used by	used in	type	used
NonlinearShuntCompensatorPhasePoint	nonlinear_shunt_compensator_phase	range	NonlinearShuntCompensatorPhase

Identifier and Mapping Information

Schema Source

from schema: https://cim.ucaiug.io/ns#TC57CIM

Mappings

Mapping Type	Mapped Value
self	cim:NonlinearShuntCompensatorPhase
native	cim:NonlinearShuntCompensatorPhase

LinkML Source

Direct

name: NonlinearShuntCompensatorPhase
description: A per phase non linear shunt compensator has bank or section admittance
  values that differ. The attributes g and b of the associated NonlinearShuntCompensatorPhasePoint
  describe the total conductance and admittance of a NonlinearShuntCompensatorPhasePoint
  at a section number specified by NonlinearShuntCompensatorPhasePoint.sectionNumber.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: ShuntCompensatorPhase
attributes:
  nonlinear_shunt_compensator_phase_points:
    name: nonlinear_shunt_compensator_phase_points
    description: All points of the non-linear shunt compensator phase.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:NonlinearShuntCompensatorPhase.NonlinearShuntCompensatorPhasePoints
    multivalued: true
    domain_of:
    - NonlinearShuntCompensatorPhase
    range: NonlinearShuntCompensatorPhasePoint
    required: true
class_uri: cim:NonlinearShuntCompensatorPhase

Induced

name: NonlinearShuntCompensatorPhase
description: A per phase non linear shunt compensator has bank or section admittance
  values that differ. The attributes g and b of the associated NonlinearShuntCompensatorPhasePoint
  describe the total conductance and admittance of a NonlinearShuntCompensatorPhasePoint
  at a section number specified by NonlinearShuntCompensatorPhasePoint.sectionNumber.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: ShuntCompensatorPhase
attributes:
  nonlinear_shunt_compensator_phase_points:
    name: nonlinear_shunt_compensator_phase_points
    description: All points of the non-linear shunt compensator phase.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:NonlinearShuntCompensatorPhase.NonlinearShuntCompensatorPhasePoints
    multivalued: true
    alias: nonlinear_shunt_compensator_phase_points
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - NonlinearShuntCompensatorPhase
    range: NonlinearShuntCompensatorPhasePoint
    required: true
  maximum_sections:
    name: maximum_sections
    description: "The maximum number of sections that may be switched in for this\
      \ phase. \r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ShuntCompensatorPhase.maximumSections
    multivalued: false
    alias: maximum_sections
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - ShuntCompensatorPhase
    - ShuntCompensator
    range: integer
    required: false
  normal_sections:
    name: normal_sections
    description: "For the capacitor phase, the normal number of sections switched\
      \ in. The value shall be between zero and ShuntCompensatorPhase.maximumSections.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ShuntCompensatorPhase.normalSections
    multivalued: false
    alias: normal_sections
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - ShuntCompensatorPhase
    - ShuntCompensator
    range: integer
    required: false
  phase:
    name: phase
    description: "Phase of this shunt compensator component.   If the shunt compensator\
      \ is wye connected, the connection is from the indicated phase to the central\
      \ ground or neutral point.  If the shunt compensator is delta connected, the\
      \ phase indicates a shunt compensator connected from the indicated phase to\
      \ the next logical non-neutral phase.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ShuntCompensatorPhase.phase
    multivalued: false
    alias: phase
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - SvInjection
    - SvVoltage
    - SvStatus
    - ACLineSegmentPhase
    - SvSwitch
    - SvPowerFlow
    - PowerElectronicsConnectionPhase
    - ShuntCompensatorPhase
    - SvShuntCompensatorSections
    - EnergyConsumerPhase
    - EnergySourcePhase
    - WireSegmentPhase
    range: SinglePhaseKind
    required: false
  sections:
    name: sections
    description: "Shunt compensator sections in use. Starting value for steady state\
      \ solution. The attribute shall be a positive value or zero. Non integer values\
      \ are allowed to support continuous variables. The reasons for continuous value\
      \ are to support study cases where no discrete shunt compensators has yet been\
      \ designed, a solutions where a narrow voltage band force the sections to oscillate\
      \ or accommodate for a continuous solution as input.\r\nFor LinearShuntConpensator\
      \ the value shall be between zero and ShuntCompensatorPhase.maximumSections.\
      \ At value zero the shunt compensator conductance and admittance is zero. Linear\
      \ interpolation of conductance and admittance between the previous and next\
      \ integer section is applied in case of non-integer values.\r\nFor NonlinearShuntCompensator-s\
      \ shall only be set to one of the NonlinearShuntCompenstorPhasePoint.sectionNumber.\
      \ There is no interpolation between NonlinearShuntCompenstorPhasePoint-s."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ShuntCompensatorPhase.sections
    multivalued: false
    alias: sections
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - ShuntCompensatorPhase
    - ShuntCompensator
    - SvShuntCompensatorSections
    range: float
    required: false
  shunt_compensator:
    name: shunt_compensator
    description: Shunt compensator of this shunt compensator phase.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ShuntCompensatorPhase.ShuntCompensator
    multivalued: false
    alias: shunt_compensator
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - ShuntCompensatorPhase
    - SvShuntCompensatorSections
    - ShuntCompensatorAction
    range: ShuntCompensator
    required: true
  controls:
    name: controls
    description: The controller outputs used to actually govern a regulating device,
      e.g. the magnetization of a synchronous machine or capacitor bank breaker actuator.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.Controls
    multivalued: true
    alias: controls
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - PowerSystemResource
    - HostControlArea
    range: Control
    required: false
  measurements:
    name: measurements
    description: The measurements associated with this power system resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.Measurements
    multivalued: true
    alias: measurements
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - PowerSystemResource
    - ACDCTerminal
    - Asset
    - Location
    - Procedure
    - AnalogLimitSet
    - AccumulatorLimitSet
    range: Measurement
    required: false
  psrtype:
    name: psrtype
    description: Custom classification for this power system resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.PSRType
    multivalued: false
    alias: psrtype
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - PowerSystemResource
    range: PSRType
    required: false
  configuration_event:
    name: configuration_event
    description: All configuration events created for this Power System resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.ConfigurationEvent
    multivalued: true
    alias: configuration_event
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - PowerSystemResource
    - FaultCauseType
    range: ConfigurationEvent
    required: false
  reporting_group:
    name: reporting_group
    description: Reporting groups to which this power system resource belongs.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.ReportingGroup
    multivalued: true
    alias: reporting_group
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - PowerSystemResource
    - BusNameMarker
    - TopologicalNode
    - ReportingSuperGroup
    range: ReportingGroup
    required: false
  operating_share:
    name: operating_share
    description: The operating shares of this power system resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.OperatingShare
    multivalued: true
    alias: operating_share
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - PowerSystemResource
    - OperatingParticipant
    range: OperatingShare
    required: false
  asset_datasheet:
    name: asset_datasheet
    description: Datasheet information for this power system resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.AssetDatasheet
    multivalued: false
    alias: asset_datasheet
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - PowerSystemResource
    range: AssetInfo
    required: false
  verification_action:
    name: verification_action
    description: The verification action that is performed on the power system resource
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.VerificationAction
    multivalued: true
    alias: verification_action
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - PowerSystemResource
    range: VerificationAction
    required: false
  clearances:
    name: clearances
    description: All clearances applicable to this power system resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.Clearances
    multivalued: true
    alias: clearances
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - PowerSystemResource
    range: ClearanceDocument
    required: false
  generic_action:
    name: generic_action
    description: The generic action that is performed on the power system resource
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.GenericAction
    multivalued: true
    alias: generic_action
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - PowerSystemResource
    range: GenericAction
    required: false
  psrevents:
    name: psrevents
    description: All events associated with this power system resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.PSREvents
    multivalued: true
    alias: psrevents
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - PowerSystemResource
    range: PSREvent
    required: false
  assets:
    name: assets
    description: All assets represented by this power system resource. For example,
      multiple conductor assets are electrically modelled as a single AC line segment.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.Assets
    multivalued: true
    alias: assets
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - PowerSystemResource
    - AssetInfo
    - Location
    - WorkTask
    - ErpRecDelvLineItem
    - AssetContainer
    - ActivityRecord
    - Procedure
    - ReliabilityInfo
    - AssetPropertyCurve
    - AssetOrganisationRole
    - ScheduledEvent
    range: Asset
    required: false
  location:
    name: location
    description: Location of this power system resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.Location
    multivalued: false
    alias: location
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - PowerSystemResource
    - Asset
    - Incident
    - SwitchingOrder
    - TroubleOrder
    - Crew
    - Fault
    - PointOfSale
    - TroubleTicket
    - OutageOrder
    - EnvironmentalMonitoringStation
    - EnvironmentalLocationType
    - PositionPoint
    - FailureEvent
    range: Location
    required: false
  operational_tags:
    name: operational_tags
    description: All operational tags placed on this power system resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.OperationalTags
    multivalued: true
    alias: operational_tags
    owner: NonlinearShuntCompensatorPhase
    domain_of:
    - PowerSystemResource
    - Asset
    range: OperationalTag
    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: NonlinearShuntCompensatorPhase
    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: NonlinearShuntCompensatorPhase
    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: NonlinearShuntCompensatorPhase
    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: NonlinearShuntCompensatorPhase
    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: NonlinearShuntCompensatorPhase
    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: NonlinearShuntCompensatorPhase
    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: NonlinearShuntCompensatorPhase
    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: NonlinearShuntCompensatorPhase
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:NonlinearShuntCompensatorPhase