roseau.load_flow.typing

Type Aliases used by Roseau Load Flow.

Warning

Types defined in this module are not part of the public API. You can use these types in your code, but they are not guaranteed to be stable.

Roseau Load Flow Helpers

class Id

The type of the identifier of an element. An element’s ID can be an integer or a string.

class JsonDict

A dictionary that can be serialized to JSON.

class StrPath

The accepted type for file paths in roseau.load_flow. This is a string or a path-like object.

class MapOrSeq

A mapping from element IDs to elements or a sequence of elements of unique IDs.

Roseau Load Flow Literals

class ControlType

Available control types for flexible loads.

class ProjectionType

Available projections types for flexible loads control.

class Solver

Available solvers for the load flow computation.

class Side

The side of a transformer ("HV" or "LV") or a line/switch (1 or 2). None is used for terminal elements that do not have a side.

Union Input Types (Wide)

class Int

An Python int or a numpy integer.

class Float

A Python real number (float or int) or a numpy real number (floating or integer).

class Complex

A Python complex number (complex, float or int) or a numpy complex number (complexfloating, floating or integer).

class ComplexArrayLike1D

A 1D array-like of complex numbers or a quantity of complex numbers. An array-like is a sequence or a numpy array.

class ComplexArrayLike2D

A 2D array-like of complex numbers or a quantity of complex numbers. An array-like is a sequence or a numpy array.

class FloatArrayLike1D

A 1D array-like of floating numbers or a quantity of floating numbers. An array-like is a sequence or a numpy array.

class ComplexScalarOrArrayLike1D

A scalar or a 1D array-like of complex numbers or a quantity thereof.

class FloatScalarOrArrayLike1D

A scalar or a 1D array-like of floating numbers or a quantity thereof.

class CRSLike

Any type accepted by pyproj.CRS. This can be a string (PROJ, JSON, WKT, authority), an integer (EPSG code), a dictionary (PROJ parameters), a tuple (authority name and code), an object with a to_wkt method, or a CRS class.

Numpy Output Types (Narrow)

class ComplexMatrix

A 2-D numpy array of complex numbers.

class FloatMatrix

A 2-D numpy array of real numbers.

class ComplexArray

A 1-D numpy array of complex numbers.

class FloatArray

A 1-D numpy array of real numbers.

class BoolArray

A 1-D numpy array of booleans.