EnergyConsumer


Generic user of energy - a point of consumption on the power system model.
EnergyConsumer.pfixed, .qfixed, .pfixedPct and .qfixedPct have meaning only if there is no LoadResponseCharacteristic associated with EnergyConsumer or if LoadResponseCharacteristic.exponentModel is set to False.

Type: object

ConformLoad represent loads that follow a daily load change pattern where the pattern can be used to scale the load with a system load.

Type: array

An AC electrical connection point to a piece of conducting equipment. Terminals are connected at physical connection points called connectivity nodes.

No Additional Items

Each item of this array must be:

Type: object

An AC electrical connection point to a piece of conducting equipment. Terminals are connected at physical connection points called connectivity nodes.

Type: boolean

The connected status is related to a bus-branch model and the topological node to terminal relation. True implies the terminal is connected to the related topological node and false implies it is not.
In a bus-branch model, the connected status is used to tell if equipment is disconnected without having to change the connectivity described by the topological node to terminal relation. A valid case is that conducting equipment can be connected in one end and open in the other. In particular for an AC line segment, where the reactive line charging can be significant, this is a relevant case.

Type: enum (of string)

Represents the normal network phasing condition. If the attribute is missing, three phases (ABC) shall be assumed, except for terminals of grounding classes (specializations of EarthFaultCompensator, GroundDisconnector, and Ground) which will be assumed to be N. Therefore, phase code ABCN is explicitly declared when needed, e.g. for star point grounding equipment.
The phase code on terminals connecting same ConnectivityNode or same TopologicalNode as well as for equipment between two terminals shall be consistent.

Must be one of:

  • "ABCN"
  • "ABC"
  • "ABN"
  • "ACN"
  • "BCN"
  • "AB"
  • "AC"
  • "BC"
  • "AN"
  • "BN"
  • "CN"
  • "A"
  • "B"
  • "C"
  • "N"
  • "s1N"
  • "s2N"
  • "s12N"
  • "s1"
  • "s2"
  • "s12"
  • "none"
  • "X"
  • "XY"
  • "XN"
  • "XYN"

Type: integer

The orientation of the terminal connections for a multiple terminal conducting equipment. The sequence numbering starts with 1 and additional terminals should follow in increasing order. The first terminal is the "starting point" for a two terminal branch.

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

Models the characteristic response of the load demand due to changes in system conditions such as voltage and frequency. It is not related to demand response.
If LoadResponseCharacteristic.exponentModel is True, the exponential voltage or frequency dependent models are specified and used as to calculate active and reactive power components of the load model.
The equations to calculate active and reactive power components of the load model are internal to the power flow calculation, hence they use different quantities depending on the use case of the data exchange.
The equations for exponential voltage dependent load model injected power are:
pInjection= Pnominal* (Voltage/cim:BaseVoltage.nominalVoltage) * cim:LoadResponseCharacteristic.pVoltageExponent
qInjection= Qnominal
(Voltage/cim:BaseVoltage.nominalVoltage) * cim:LoadResponseCharacteristic.qVoltageExponent
Where:
1) * means "multiply" and *
is "raised to power of";
2) Pnominal and Qnominal represent the active power and reactive power at nominal voltage as any load described by the voltage exponential model shall be given at nominal voltage. This means that EnergyConsumer.p and EnergyConsumer.q are at nominal voltage.
3) After power flow is solved:
-pInjection and qInjection correspond to SvPowerflow.p and SvPowerflow.q respectively.
- Voltage corresponds to SvVoltage.v at the TopologicalNode where the load is connected.

Type: number

Portion of active power load modelled as constant current.

Type: number

Portion of active power load modelled as constant impedance.

Type: number

Portion of active power load modelled as constant power.

Type: number

Exponent of per unit frequency effecting active power.

Type: number

Exponent of per unit voltage effecting real power.

Type: number

Portion of reactive power load modelled as constant current.

Type: number

Portion of reactive power load modelled as constant impedance.

Type: number

Portion of reactive power load modelled as constant power.

Type: number

Exponent of per unit frequency effecting reactive power.

Type: number

Exponent of per unit voltage effecting reactive power.

Type: string

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

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: boolean

Indicates the exponential voltage dependency model is to be used. If false, the coefficient model is to be used.
The exponential voltage dependency model consist of the attributes:
- pVoltageExponent
- qVoltageExponent
- pFrequencyExponent
- qFrequencyExponent.
The coefficient model consist of the attributes:
- pConstantImpedance
- pConstantCurrent
- pConstantPower
- qConstantImpedance
- qConstantCurrent
- qConstantPower.
The sum of pConstantImpedance, pConstantCurrent and pConstantPower shall equal 1.
The sum of qConstantImpedance, qConstantCurrent and qConstantPower shall equal 1.

Type: array

A single phase of an energy consumer.

No Additional Items

Each item of this array must be:

Type: object

A single phase of an energy consumer.

Type: object or number

Active power of the load. Load sign convention is used, i.e. positive sign means flow out from a node.
For voltage dependent loads the value is at rated voltage.
Starting value for a steady state solution.

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: "W"

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: object or number

Active power of the load that is a fixed quantity. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as EnergyConsumerPhase.p

Type: object or number

Fixed active power as per cent of load group fixed active power. Load sign convention is used, i.e. positive sign means flow out from a node.

Type: number Default: null

Normally 0 to 100 on a defined base.

Type: enum (of string)

Phase of this energy consumer component. If the energy consumer is wye connected, the connection is from the indicated phase to the central ground or neutral point. If the energy consumer is delta connected, the phase indicates an energy consumer connected from the indicated phase to the next logical non-neutral phase.

Must be one of:

  • "A"
  • "B"
  • "C"
  • "N"
  • "s1"
  • "s2"

Type: object or number

Reactive power of the load that is a fixed quantity. Load sign convention is used, i.e. positive sign means flow out from a node.

Type: object or number

Fixed reactive power as per cent of load group fixed reactive power. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as EnergyConsumerPhase.pfixedPct

Type: object or number

Reactive power of the load. Load sign convention is used, i.e. positive sign means flow out from a node.
For voltage dependent loads the value is at rated voltage.
Starting value for a steady state solution.

Same definition as EnergyConsumerPhase.qfixed

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: array

State variable for status.

No Additional Items

Each item of this array must be:

Type: object

State variable for status.

Type: boolean

The in service status as a result of topology processing. It indicates if the equipment is considered as energized by the power flow. It reflects if the equipment is connected within a solvable island. It does not necessarily reflect whether or not the island was solved by the power flow.

Type: enum (of string)

The individual phase status. If the attribute is unspecified, then three phase model is assumed.

Same definition as EnergyConsumerPhase.phase

Type: object or number

Active power of the load. Load sign convention is used, i.e. positive sign means flow out from a node.
For voltage dependent loads the value is at rated voltage.
Starting value for a steady state solution.

Same definition as EnergyConsumerPhase.p

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: object or number

Reactive power of the load. Load sign convention is used, i.e. positive sign means flow out from a node.
For voltage dependent loads the value is at rated voltage.
Starting value for a steady state solution.

Same definition as EnergyConsumerPhase.qfixed

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: integer

Number of individual customers represented by this demand.

Type: boolean

Used for Yn and Zn connections. True if the neutral is solidly grounded.

Type: object or number

Active power of the load that is a fixed quantity and does not vary as load group value varies. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as EnergyConsumerPhase.p

Type: object or number

Fixed active power as a percentage of load group fixed active power. Used to represent the time-varying components. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as EnergyConsumerPhase.pfixedPct

Type: enum (of string)

The type of phase connection, such as wye or delta.

Must be one of:

  • "D"
  • "Y"
  • "Yn"
  • "I"
  • "G"

Type: object or number

Reactive power of the load that is a fixed quantity and does not vary as load group value varies. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as EnergyConsumerPhase.qfixed

Type: object or number

Fixed reactive power as a percentage of load group fixed reactive power. Used to represent the time-varying components. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as EnergyConsumerPhase.pfixedPct

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the 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: 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

NonConformLoad represents loads that do not follow a daily load change pattern and whose changes are not correlated with the daily load change pattern.

Type: array

An AC electrical connection point to a piece of conducting equipment. Terminals are connected at physical connection points called connectivity nodes.

No Additional Items

Each item of this array must be:

Type: object

An AC electrical connection point to a piece of conducting equipment. Terminals are connected at physical connection points called connectivity nodes.

Same definition as Terminal

Type: object

Models the characteristic response of the load demand due to changes in system conditions such as voltage and frequency. It is not related to demand response.
If LoadResponseCharacteristic.exponentModel is True, the exponential voltage or frequency dependent models are specified and used as to calculate active and reactive power components of the load model.
The equations to calculate active and reactive power components of the load model are internal to the power flow calculation, hence they use different quantities depending on the use case of the data exchange.
The equations for exponential voltage dependent load model injected power are:
pInjection= Pnominal* (Voltage/cim:BaseVoltage.nominalVoltage) * cim:LoadResponseCharacteristic.pVoltageExponent
qInjection= Qnominal
(Voltage/cim:BaseVoltage.nominalVoltage) * cim:LoadResponseCharacteristic.qVoltageExponent
Where:
1) * means "multiply" and *
is "raised to power of";
2) Pnominal and Qnominal represent the active power and reactive power at nominal voltage as any load described by the voltage exponential model shall be given at nominal voltage. This means that EnergyConsumer.p and EnergyConsumer.q are at nominal voltage.
3) After power flow is solved:
-pInjection and qInjection correspond to SvPowerflow.p and SvPowerflow.q respectively.
- Voltage corresponds to SvVoltage.v at the TopologicalNode where the load is connected.

Same definition as EnergyConsumer.LoadResponseCharacteristic

Type: array

A single phase of an energy consumer.

No Additional Items

Each item of this array must be:

Type: array

State variable for status.

No Additional Items

Each item of this array must be:

Type: object or number

Active power of the load. Load sign convention is used, i.e. positive sign means flow out from a node.
For voltage dependent loads the value is at rated voltage.
Starting value for a steady state solution.

Same definition as EnergyConsumerPhase.p

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: object or number

Reactive power of the load. Load sign convention is used, i.e. positive sign means flow out from a node.
For voltage dependent loads the value is at rated voltage.
Starting value for a steady state solution.

Same definition as EnergyConsumerPhase.qfixed

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: integer

Number of individual customers represented by this demand.

Type: boolean

Used for Yn and Zn connections. True if the neutral is solidly grounded.

Type: object or number

Active power of the load that is a fixed quantity and does not vary as load group value varies. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as EnergyConsumerPhase.p

Type: object or number

Fixed active power as a percentage of load group fixed active power. Used to represent the time-varying components. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as EnergyConsumerPhase.pfixedPct

Type: enum (of string)

The type of phase connection, such as wye or delta.

Same definition as EnergyConsumer.phaseConnection

Type: object or number

Reactive power of the load that is a fixed quantity and does not vary as load group value varies. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as EnergyConsumerPhase.qfixed

Type: object or number

Fixed reactive power as a percentage of load group fixed reactive power. Used to represent the time-varying components. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as EnergyConsumerPhase.pfixedPct

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the 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: 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.