Skip to content

load

This module contains classes for representing different type of power system loads.

Examples:

>>> from shift.load import ConstantPowerLoad
>>> load = ConstantPowerLoad()
>>> load.name = "Load1"
>>> load.latitude = 60.233
>>> load.longitude = 23.455
>>> load.phase = Phase.A
>>> load.num_phase = NumPhase.SINGLE
>>> load.conn_type = LoadConnection.STAR
>>> load.kv = 12.7
>>> load.kw = 4.8
>>> load.kvar = 3.4
>>> print(load)

ConstantPowerFactorLoad

Bases: Load

Implementation for constant power factor load.

Source code in shift\load.py 
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
class ConstantPowerFactorLoad(Load):
    """Implementation for constant power factor load."""

    @property
    def kw(self) -> float:
        """kw property of the load"""
        return self._kw

    @kw.setter
    def kw(self, kw: float) -> None:
        """kw setter method for the load"""
        self._kw = kw

    @property
    def pf(self) -> float:
        """power factor setter method for the load"""
        return self._pf

    @pf.setter
    def pf(self, pf: float) -> None:
        """power factor setter method for the load"""
        if pf < MIN_POWER_FACTOR or pf > MAX_POWER_FACTOR:
            raise PowerFactorNotInRangeError(pf)
        self._pf = pf

    def __repr__(self):
        return (
            f"ConstantPowerFactorLoad(Name = {self._name},"
            + f" Latitude = {self._latitude}, Longitude = "
            + f"{self._longitude}, Phase = {self._phase} "
            + f"NumPhase = {self._num_phase}, Connection Type ="
            + f" {self._conn_type}, kw = {self._kw},"
            + f" pf = {self._pf}, kv = {self._kv})"
        )

kw() writable property

kw property of the load

Source code in shift\load.py 
188
189
190
191
@property
def kw(self) -> float:
    """kw property of the load"""
    return self._kw

pf() writable property

power factor setter method for the load

Source code in shift\load.py 
198
199
200
201
@property
def pf(self) -> float:
    """power factor setter method for the load"""
    return self._pf

ConstantPowerLoad

Bases: Load

Implementation for constant power load.

Source code in shift\load.py 
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
class ConstantPowerLoad(Load):
    """Implementation for constant power load."""

    @property
    def kw(self) -> float:
        """kw property of the load"""
        return self._kw

    @kw.setter
    def kw(self, kw: float) -> None:
        """kw setter method for the load"""
        self._kw = kw

    @property
    def kvar(self) -> float:
        """kvar property of the load"""
        return self._kvar

    @kvar.setter
    def kvar(self, kvar: float) -> None:
        """kvar setter method for the load"""
        self._kvar = kvar

    def __repr__(self):
        return (
            f"ConstantPowerLoad(Name = {self._name}, Latitude ="
            + f" {self._latitude}, Longitude = {self._longitude},"
            + f" Phase = {self._phase} NumPhase = {self._num_phase},"
            + f" Connection Type = {self._conn_type}, kw = {self._kw},"
            + f" kvar = {self._kvar}, kv = {self._kv})"
        )

kvar() writable property

kvar property of the load

Source code in shift\load.py 
165
166
167
168
@property
def kvar(self) -> float:
    """kvar property of the load"""
    return self._kvar

kw() writable property

kw property of the load

Source code in shift\load.py 
155
156
157
158
@property
def kw(self) -> float:
    """kw property of the load"""
    return self._kw

Load

Bases: ABC

Interface for single load point.

Source code in shift\load.py 
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
class Load(ABC):
    """Interface for single load point."""

    @property
    def name(self) -> str:
        """Name property of load"""
        return self._name

    @name.setter
    def name(self, name: str) -> None:
        """Name setter method for a load"""
        self._name = name

    @property
    def latitude(self) -> float:
        """Latitude property where load is located"""
        return self._latitude

    @latitude.setter
    def latitude(self, latitude: float) -> None:
        """Latitude setter method for the load"""
        if latitude < MIN_LATITUDE or latitude > MAX_LATITUDE:
            raise LatitudeNotInRangeError(latitude)
        self._latitude = latitude

    @property
    def longitude(self) -> float:
        """Longitude property where load is located"""
        return self._longitude

    @longitude.setter
    def longitude(self, longitude: float) -> None:
        """Longitude setter method for the load"""
        if longitude < MIN_LONGITUDE or longitude > MAX_LONGITUDE:
            raise LongitudeNotInRangeError(longitude)
        self._longitude = longitude

    @property
    def phase(self) -> Phase:
        """Phase property where load is connected"""
        return self._phase

    @phase.setter
    def phase(self, phase: Phase) -> None:
        """Phase setter method for the load"""
        self._phase = phase

    @property
    def num_phase(self) -> NumPhase:
        """Number of phase property of the load"""
        return self._num_phase

    @num_phase.setter
    def num_phase(self, num_phase: NumPhase) -> None:
        """Number of phase setter method for the load"""
        self._num_phase = num_phase

    @property
    def conn_type(self) -> LoadConnection:
        """Connection type property of the load"""
        return self._conn_type

    @conn_type.setter
    def conn_type(self, connection: LoadConnection) -> None:
        """Abstract connection type setter method for the load"""
        self._conn_type = connection

    @property
    def kv(self) -> float:
        """kv property of the load"""
        return self._kv

    @kv.setter
    def kv(self, kv: float) -> None:
        """kv setter method for the load"""
        if kv < 0:
            raise NegativeKVError(kv)
        if kv == 0:
            raise ZeroKVError()
        self._kv = kv

conn_type() writable property

Connection type property of the load

Source code in shift\load.py 
127
128
129
130
@property
def conn_type(self) -> LoadConnection:
    """Connection type property of the load"""
    return self._conn_type

kv() writable property

kv property of the load

Source code in shift\load.py 
137
138
139
140
@property
def kv(self) -> float:
    """kv property of the load"""
    return self._kv

latitude() writable property

Latitude property where load is located

Source code in shift\load.py 
83
84
85
86
@property
def latitude(self) -> float:
    """Latitude property where load is located"""
    return self._latitude

longitude() writable property

Longitude property where load is located

Source code in shift\load.py 
95
96
97
98
@property
def longitude(self) -> float:
    """Longitude property where load is located"""
    return self._longitude

name() writable property

Name property of load

Source code in shift\load.py 
73
74
75
76
@property
def name(self) -> str:
    """Name property of load"""
    return self._name

num_phase() writable property

Number of phase property of the load

Source code in shift\load.py 
117
118
119
120
@property
def num_phase(self) -> NumPhase:
    """Number of phase property of the load"""
    return self._num_phase

phase() writable property

Phase property where load is connected

Source code in shift\load.py 
107
108
109
110
@property
def phase(self) -> Phase:
    """Phase property where load is connected"""
    return self._phase