qiskit_metal.qlibrary.QNLMetal.bridgefreejunction

  1# This code was written by Deval Deliwala.
  2# 
  3# This code is to be used by QNL. 
  4# 
  5# Any modifications or derivative works of this code must retain this 
  6# notice, and modified files need to carry a notice indicating 
  7# that they have been altered from the originals.
  8
  9""" BridgeFreeJunction. 
 10
 11.. code-block:: 
 12
 13                      `+y` 
 14               ________|_____
 15             /        | |     ∖ 
 16            |      ___|_|_*    | 
 17            |    |        |____|              
 18            |      `+x_+y`|____|- `+x`              
 19            |    |        |    |              
 20            |    |        |    | 
 21            |     ‾‾‾‾‾‾‾‾     | 
 22             ∖                / 
 23               ‾‾‾‾‾‾‾‾‾‾‾‾‾‾
 24
 25"""
 26
 27import numpy as np 
 28from qiskit_metal import draw, Dict 
 29from qiskit_metal.qlibrary.core import QComponent 
 30from qiskit_metal.toolbox_python.utility_functions import rotate_point
 31
 32             
 33class BridgeFreeJunction(QComponent): 
 34    """ 
 35    Inherits `QComponent` Class. 
 36
 37    Description: 
 38        A bridge-free junction design similar to the manhattan style junctions. 
 39
 40    Options: 
 41        * width       : The width of the junction overlap rectangle 
 42        * height      : The height of the junction overlap rectangle 
 43        * wire_width  : The width of the junction wires 
 44        * wire_x_offset: The offset in x direction w.r.t origin -- sign doesn't matter
 45        * wire_y_offset: The offset in y direction w.r.t origin -- sign doesn't matter 
 46        * pos_x/_y    : position of junction on chip 
 47        * fillet      : The fillet radius of the corners of the junction overlap rectangle 
 48        * undercut    : The size of the undercut region around the junction overlap rectangle 
 49        * orientation : 0-> is parallel to x-axis, with orientation (in degrees) counterclockwise 
 50        * origin: A string representing the corner of the rectangle the wires will be placed next to
 51                  Valid Options: 
 52                      * 'upper right' DEFAULT 
 53                      * 'upper left' 
 54                      * 'lower right' 
 55                      * 'lower left' 
 56        * layer: the layer number for the junction 
 57        * undercut_layer: the layer number for the undercut 
 58
 59
 60    """ 
 61
 62    # Default drawing options 
 63    default_options = Dict(
 64        width='100um',
 65        height='100um', 
 66        wire_width='5um', 
 67        wire_x_offset='5um', 
 68        wire_y_offset='5um', 
 69        pos_x='0um', 
 70        pos_y='0um', 
 71        fillet='0um', 
 72        undercut='25um', 
 73        orientation='0', 
 74        origin='upper right',
 75        layer='1',
 76        undercut_layer='2', 
 77    ) 
 78
 79    # Component metadata
 80    # Name prefix for component, if user doesn't provide name 
 81    component_metadata = Dict( 
 82        short_name='bridgefreejunction', 
 83        _qgeometry_table_poly='True', 
 84    )
 85
 86    def make(self): 
 87        """ Convert self.options into QGeometry. """ 
 88        p = self.parse_options() # string options -> numbers 
 89        nodes = Dict() 
 90
 91        # junction overlap rectangle 
 92        junc_rect = draw.rectangle(p.width, p.height) 
 93
 94        # surrounding undercut 
 95        undercut = draw.rectangle(p.width+2*p.undercut, p.height+2*p.undercut) 
 96        undercut = undercut.buffer(p.fillet) 
 97
 98        if p.origin == 'upper right': 
 99            nodes.origin = np.array((+p.width/2, +p.height/2)) 
100            p.wire_x_offset = -abs(p.wire_x_offset) 
101            p.wire_y_offset = -abs(p.wire_y_offset)
102            x_translation = nodes.origin + [p.wire_x_offset, p.undercut/2+p.fillet/2] 
103            y_translation = nodes.origin + [p.undercut/2+p.fillet/2, p.wire_y_offset] 
104        elif p.origin == 'upper left': 
105            nodes.origin = np.array((-p.width/2, +p.height/2)) 
106            p.wire_x_offset = +abs(p.wire_x_offset) 
107            p.wire_y_offset = -abs(p.wire_y_offset) 
108            x_translation = nodes.origin + [p.wire_x_offset, p.undercut/2+p.fillet/2] 
109            y_translation = nodes.origin + [-p.undercut/2-p.fillet/2, p.wire_y_offset] 
110        elif p.origin == 'lower right': 
111            nodes.origin = np.array((+p.width/2, -p.height/2)) 
112            p.wire_x_offset = -abs(p.wire_x_offset) 
113            p.wire_y_offset = +abs(p.wire_y_offset) 
114            x_translation = nodes.origin + [p.wire_x_offset, -p.undercut/2-p.fillet/2] 
115            y_translation = nodes.origin + [p.undercut/2+p.fillet/2, p.wire_y_offset] 
116        elif p.origin == 'lower left': 
117            nodes.origin = np.array((-p.width/2, -p.height/2)) 
118            p.wire_x_offset = +abs(p.wire_x_offset) 
119            p.wire_y_offset = +abs(p.wire_y_offset) 
120            x_translation = nodes.origin + [p.wire_x_offset, -p.undercut/2-p.fillet/2] 
121            y_translation = nodes.origin + [-p.undercut/2-p.fillet/2, p.wire_y_offset]
122        else: 
123            raise Exception('`origin` option not defined correctly') 
124
125        # Wires  
126        # `wire_x` is the wire that gets offset translated along x-direction 
127        # `wire_y` is the wire that gets offset translated along y-direction
128        wire_x = draw.rectangle(p.wire_width, p.undercut+p.fillet) 
129        wire_y = draw.rectangle(p.undercut+p.fillet, p.wire_width) 
130        
131        wire_x = draw.translate(wire_x, *x_translation)
132        wire_y = draw.translate(wire_y, *y_translation)  
133
134        junction = draw.union([junc_rect, wire_x, wire_y]) 
135        undercut = draw.subtract(undercut, junction) 
136
137        # Translations & Rotations 
138        geom_list = [junction, undercut] 
139        geom_list = draw.rotate(geom_list, p.orientation, origin=(0, 0)) 
140        geom_list = draw.translate(geom_list, p.pos_x, p.pos_y) 
141        [junction, undercut] = geom_list
142        
143        # Converting drawing to qgeometry  
144        self.add_qgeometry('poly', {'junction': junction}, layer=p.layer) 
145        self.add_qgeometry('poly', {'undercut': undercut}, layer=p.undercut_layer) 
146
147        # Positioning nodes
148        nodes['+x_+y'] = nodes.origin + [p.wire_x_offset, p.wire_y_offset] 
149        if p.origin == 'upper right':
150            nodes['+x'] = nodes.origin + [p.undercut, p.wire_y_offset] 
151            nodes['+y'] = nodes.origin + [p.wire_x_offset, p.undercut]
152        if p.origin == 'upper left':
153            nodes['+x'] = nodes.origin + [-p.undercut, p.wire_y_offset] 
154            nodes['+y'] = nodes.origin + [p.wire_x_offset, p.undercut]
155        if p.origin == 'lower right':
156            nodes['+x'] = nodes.origin + [p.undercut, p.wire_y_offset] 
157            nodes['+y'] = nodes.origin + [p.wire_x_offset, -p.undercut]
158        if p.origin == 'lower left':
159            nodes['+x'] = nodes.origin + [-p.undercut, p.wire_y_offset] 
160            nodes['+y'] = nodes.origin + [p.wire_x_offset, -p.undercut]
161
162        # Moving nodes along with component 
163        translation_vec = np.array((p.pos_x, p.pos_y)) 
164        theta = np.deg2rad(p.orientation) 
165        for key, point in nodes.items(): 
166            rotated = rotate_point(point, theta) 
167            nodes[key] = rotated + translation_vec
168
169        self.nodes = nodes 
170        return 
171
172    def node(self, key): 
173        return self.nodes.get(key, None)