energia.components.operations.operation

energia.components.operations.operation#

A General Operation

Functions

abstractmethod(funcobj)

A decorator indicating abstract methods.

timer(logger[, kind, level])

Logs execution time and optionally shows a full computation using function arguments and result.

Classes

Construction([operation, aspect, resource, ...])

Operation Construction Conversion

Conversion([aspect, add, sub, operation, ...])

Processes convert one Commodity to another Commodity Conversion provides the conversion of resources

Operation(*args[, label, citations])

A General Operation

cached_property(func)

class Operation(*args, label: str = '', citations: str = '', **kwargs)[source]#

Bases: _Component

A General Operation

Parameters:

  • label (str, optional) – An optional label for the component. Defaults to None.

  • citations (str | list[str] | dict[str, str | list[str]], optional) – An optional citation or description for the component. Defaults to None.

Variables:

  • model (Model) – The model to which the component belongs.

  • name (str) – Set when the component is assigned as a Model attribute.

  • constraints (list[str]) – List of constraints associated with the component.

  • domains (list[Domain]) – List of domains associated with the component.

  • aspects (dict[Aspect, list[Domain]]) – Aspects associated with the component with domains.

  • conversion – Operational conversion associated with the operation. Defaults to None.

:vartype conversion : Conversion, optional :ivar fab: Material conversion associated with the operation. Defaults to None. :vartype fab: Conversion, optional :ivar _fab_balanced: True if the material conversion has been balanced. Defaults to False. :vartype _fab_balanced: bool

abstract property spaces: list[Location | Linkage]#

Locations at which the process is balanced

property capacity_aspect: Aspect[source]#

Capacity Aspect

property operate_aspect: Aspect[source]#

Operate Aspect

property operate_sample: Sample#

Operate Sample

property capacity_sample: Sample#

Capacity Sample

property basis: Resource#

Base resource

property balance: dict[Resource, int | float]#

Conversion of commodities

property lag: Lag#

Lag of the process

write_primary_conversion(space_times: list[tuple[Location | Linkage, Periods]])[source]#

write conversion constraints for the operation

write_construction(space_times: list[tuple[Location | Linkage, Periods]])[source]#

write fabrication constraints for the operation

locate(*spaces: Location | Linkage)[source]#

Locate the process

property I#

gana index set (I)

property cons: list[C]#

Constraints

property horizon: Periods#

Circumscribing Periods (Temporal Scale)

property network: Location#

Circumscribing Loc (Spatial Scale)

property problem: Problem#

Feasible Region

property program: Prg#

Mathematical program

show(descriptive=False, category: str = '')#

Pretty print the component

property space: Space#

Space

property time: Time#

Time

Contents