Setting underlying structure to implement Facade

[Bachibouzouk]

Follow up from the discussion which happened at 2025-02 oemof-meeting

The goal is to dicsuss the required changes in order to be able to add Facades so that user can build complex component from "basic" oemof components and add them to the network

Option A ("AtomicNode")

inputs and outputs attributes are stripped from the class Node, Node as known in v0.5 is renamed after AtomicNode and SubNetwork is added

This would require 2 (easy) releases in oemof.network and 1 in oemof.solph

Pros

Cons

• might be confusing that what used to be Node is now AtomicNode and Node is still there but just higher in the hierarchy
• 2 releases in oemof.network which might
• might break older version of oemof as network version is not upperbound

Option B ("AbstractNode")

Pros

• less releases to make to perform the change

Cons

• Using "Abstract" in the naming

I will use the naming from variante A to draft pseudo code classes below

oemof.network

class Node(Entity):
     pass

class AtomicNode(Node):
    #attributes
    self.inputs
    self.outputs


class SubNetwork(Node):

      self. node_list  #AtomicNodes list

      def add_subnode(self, node: AtomicNode):
          """add an AtomicNode into the subnetwork"""

oemof.solph

class Facade(SubNetwork):
    
    #attributes
    self.label
    self.facade_type
    def build_subnetwork(self):
         """Instanciate and add AtomicNode instance to the sub network"""


class DSO(Facade):

    def __init__(self,name, el_bus):
        super().__init__(*args,name=name)
        self.facade_type = "dso"

        self.el_bus = el_bus
    def build_subnetwork(self):
        bus_f = Bus()
        feedin = Converter(
            inputs={self.el_bus: Flow()},
            outputs={bus_f: Flow()},
        )
        sink = Sink(inputs={bus_f: Flow()})
        self.add_subnode(sink, bus_f, feedin)

        bus_c = Bus()
        consumption = Converter(
            inputs={bus_c: Flow()}, outputs={self.el_bus: Flow()}
        )
        source = Source(outputs={bus_c: Flow()})
        self.add_subnode(source, bus_c, consumption)

[p-snft]

I also see "Option C", to have AbstractNode and AtomicNode with explicit name prefixes.

[Bachibouzouk]

We are tending towards option B because it breaks less things from the existing structure