finesse.components.node.NodeDirection

Overview

class finesse.components.node.NodeDirection(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum describing the direction that information at a Node flows.

This is largely a description to help understand how external information flows in and out of a component. Inside a component all nodes will couple to one another in more complex ways.

Input nodes are those going into a component, whereas output describe those leaving. For example incident and reflected light fields.

Bidrectional takes information either direction. For example a mechanical degree of freedom, external forces can be applied to it, or its motion can be coupled to some external system.