Loads

Definition

The load element can be used to model consumption loads (with positive active power) as well as generation loads (with negative active power).

Connections

A load can be either star-connected or delta-connected depending on whether its phases include a neutral or not.

Star (wye) connection

Here is the diagram of a star-connected three-phase load:

European standards

American standards

In Roseau Load Flow, the phases argument of the constructor must contain "n" for star loads.

Note

You can create star connected constant-power or constant-impedance loads even on buses that don’t have a neutral. In this case, the load’s neutral will be floating and its potential can be accessed similar to normal star loads.

Delta connection

Here is the diagram of a delta-connected three-phase load:

European standards

American standards

In Roseau Load Flow, the phases argument of the constructor must not contain "n" for delta loads.

Available models

The ZIP model is commonly used to represent electric loads in static grid analysis. This model considers the voltage dependency of loads. ZIP stands for the three load types:

• Z = constant impedance load

• I = constant current load

• P = constant power load

The following load models are available in Roseau Load Flow:

Loads

• Impedance loads (Z)
  • Equations
  • Example
• Current loads (I)
  • Equations
  • Example
• Power loads (P)
  • Equations
  • Example
• Flexible loads
  • Equations
  • Detailed pages
    • Controls
    • Projections
    • Flexible parameters
    • Feasible domains
  • API Reference

API Reference

class AbstractLoad(id: Id, bus: roseau.load_flow.models.buses.Bus, *, phases: str | None = None, connect_neutral: bool | None = None)

Bases: roseau.load_flow.models.core.Element, abc.ABC

An abstract class of an electric load.

The subclasses of this class can be used to depict:

• star-connected loads using a phases constructor argument containing “n”

• delta-connected loads using a phases constructor argument not containing “n”

AbstractLoad constructor.

Parameters:

• id – A unique ID of the load in the network loads.

• bus – The bus to connect the load to.

• phases – The phases of the load. A string like "abc" or "an" etc. The bus phases are used by default. The order of the phases is important. For a full list of supported phases, see the class attribute allowed_phases. All phases of the load must be present in the phases of the connected bus. Multiphase loads are allowed to be connected to buses that don’t have a neutral if connect_neutral is not set to True.

• connect_neutral – Specifies whether the load’s neutral should be connected to the bus’s neutral or left floating. By default, the load’s neutral is connected when the bus has a neutral. If the bus does not have a neutral, the load’s neutral is left floating by default. To override the default behavior, pass an explicit True or False.

type

allowed_phases

The allowed phases for a load are the same as for a bus.

property phases

The phases of the load.

property bus

The bus of the load.

property is_flexible

Whether the load is flexible or not. Only PowerLoad can be flexible.

property has_floating_neutral

Does this load have a floating neutral?

property voltage_phases

The phases of the load voltages.

property res_currents

The load flow result of the load currents (A).

property res_potentials

The load flow result of the load potentials (V).

property res_voltages

The load flow result of the load voltages (V).

property res_powers

The load flow result of the “line powers” flowing into the load (VA).

disconnect()

Disconnect this load from the network. It cannot be used afterwards.

classmethod from_dict(data: JsonDict, *, include_results: bool = True)

Create an element from a dictionary created with to_dict().

Note

This method does not work on all classes that define it as some of them require additional information to be constructed. It can only be safely used on the ElectricNetwork, LineParameters and TransformerParameters classes.

Parameters:

• data – The dictionary containing the element’s data.

• include_results – If True (default) and the results of the load flow are included in the dictionary, the results are also loaded into the element.

Returns:

The constructed element.

class ImpedanceLoad(id: Id, bus: roseau.load_flow.models.buses.Bus, *, impedances: roseau.load_flow.typing.ComplexScalarOrArrayLike1D, phases: str | None = None, connect_neutral: bool | None = None)

Bases: AbstractLoad

A constant impedance load.

ImpedanceLoad constructor.

Parameters:

• id – A unique ID of the load in the network loads.

• bus – The bus to connect the load to.

• impedances –

  A single impedance value or an array-like of impedance values for each phase component. Either complex values (Ohms) or a Quantity of complex values.

  When a scalar value is provided, it creates a balanced load with the same impedance for each phase. To create an unbalanced load, provide a vector of impedance values with the same length as the number of components of the load.

• phases – The phases of the load. A string like "abc" or "an" etc. The bus phases are used by default. The order of the phases is important. For a full list of supported phases, see the class attribute allowed_phases. All phases of the load must be present in the phases of the connected bus. Multiphase loads are allowed to be connected to buses that don’t have a neutral if connect_neutral is not set to True.

• connect_neutral – Specifies whether the load’s neutral should be connected to the bus’s neutral or left floating. By default, the load’s neutral is connected when the bus has a neutral. If the bus does not have a neutral, the load’s neutral is left floating by default. To override the default behavior, pass an explicit True or False.

type = 'impedance'

property impedances

The impedances of the load (Ohms).

class CurrentLoad(id: Id, bus: roseau.load_flow.models.buses.Bus, *, currents: roseau.load_flow.typing.ComplexScalarOrArrayLike1D, phases: str | None = None)

Bases: AbstractLoad

A constant current load.

CurrentLoad constructor.

Parameters:

• id – A unique ID of the load in the network loads.

• bus – The bus to connect the load to.

• currents –

  A single current value or an array-like of current values for each phase component. Either complex values (A) or a Quantity of complex values.

  When a scalar value is provided, it is interpreted as the first value of the load currents vector to create a balanced load. The other values are calculated based on the number of phases of the load. For a single-phase load, the passed scalar value is used. For a two-phase load, the second current value is the negative of the first value (180° phase shift). For a three-phase load, the second and third current values are obtained by rotating the first value by -120° and 120°, respectively (120° phase shift clockwise).

• phases – The phases of the load. A string like "abc" or "an" etc. The bus phases are used by default. The order of the phases is important. For a full list of supported phases, see the class attribute allowed_phases. All phases of the load must be present in the phases of the connected bus.

type = 'current'

property currents

The currents of the load (Amps).

Setting the currents will update the load’s currents and invalidate the network results.

class PowerLoad(id: Id, bus: roseau.load_flow.models.buses.Bus, *, powers: roseau.load_flow.typing.ComplexScalarOrArrayLike1D, phases: str | None = None, flexible_params: list[roseau.load_flow.models.loads.flexible_parameters.FlexibleParameter] | None = None, connect_neutral: bool | None = None)

Bases: AbstractLoad

A constant power load.

PowerLoad constructor.

Parameters:

• id – A unique ID of the load in the network loads.

• bus – The bus to connect the load to.

• powers –

  A single power value or an array-like of power values for each phase component. Either complex values (VA) or a Quantity of complex values.

  When a scalar value is provided, it creates a balanced load with the same power for each phase. The scalar value passed is assumed to be the power of each component of the load, not the total multi-phase power. To create an unbalanced load, provide a vector of power values with the same length as the number of components of the load.

• phases – The phases of the load. A string like "abc" or "an" etc. The bus phases are used by default. The order of the phases is important. For a full list of supported phases, see the class attribute allowed_phases. All phases of the load must be present in the phases of the connected bus. Multiphase loads are allowed to be connected to buses that don’t have a neutral if connect_neutral is not set to True.

• flexible_params – A list of FlexibleParameters object, one for each phase. When provided, the load is considered as flexible (or controllable) and the parameters are used to compute the flexible power of the load.

• connect_neutral – Specifies whether the load’s neutral should be connected to the bus’s neutral or left floating. By default, the load’s neutral is connected when the bus has a neutral. If the bus does not have a neutral, the load’s neutral is left floating by default. To override the default behavior, pass an explicit True or False.

type = 'power'

property powers

The powers of the load (VA).

Setting the powers will update the load’s power values and invalidate the network results.

property flexible_params

property is_flexible

Whether the load is flexible or not. Only PowerLoad can be flexible.

property res_flexible_powers

The load flow result of the load flexible powers (VA).

This property is only available for flexible loads.

It returns the powers actually consumed or produced by each component of the load instead of the “line powers” flowing into the load connection points (as the res_powers() property does). The two properties are the same for Wye-connected loads but are different for Delta-connected loads.