Skip to content

Bravais

BoundedBravais 

BoundedBravais(*shape, lattice_spacing=1.0)

Bases: AtomArrangement

Source code in src/bloqade/ir/location/bravais.py 
45
46
47
48
49
50
51
@beartype
def __init__(self, *shape: int, lattice_spacing: ScalarType = 1.0):
    self.shape = shape
    self.lattice_spacing = cast(lattice_spacing)
    self.__n_atoms = None
    self.__n_dims = None
    super().__init__()

__match_args__ class-attribute instance-attribute 

__match_args__ = ('shape', 'lattice_spacing')

Base classe for Bravais lattices AtomArrangement.

n_dims property 

n_dims

dimension of the lattice

Returns:

Name Type Description
int

dimension of the lattice

coordinates 

coordinates(index)

calculate the coordinates of a cell in the lattice given the cell index.

Source code in src/bloqade/ir/location/bravais.py 
124
125
126
127
128
129
130
131
132
133
@beartype
def coordinates(self, index: List[int]) -> NDArray:
    """calculate the coordinates of a cell in the lattice
    given the cell index.
    """
    # damn! this is like stone age broadcasting
    vectors = np.array(self.cell_vectors())
    index = np.array(index)
    pos = np.sum(vectors.T * index, axis=1)
    return pos + np.array(self.cell_atoms())

scale 

scale(factor)

Scale the current location with a factor.

(x,y) -> factor*(x,y)

Parameters:

Name Type Description Default
factor str | Real | Decimal | Scalar

scale factor

 required

Returns:

Name Type Description
BoundedBravais BoundedBravais

The lattice with the scaled locations
Source code in src/bloqade/ir/location/bravais.py 
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
@beartype
def scale(self, factor: ScalarType) -> "BoundedBravais":
    """Scale the current location with a factor.

    (x,y) -> factor*(x,y)

    Args:
        factor (str | Real | Decimal | Scalar): scale factor

    Returns:
        BoundedBravais: The lattice with the scaled locations
    """
    factor = cast(factor)
    obj = self.__new__(type(self))
    for f in fields(self):
        if f.name == "lattice_spacing":
            obj.lattice_spacing = factor * self.lattice_spacing
        else:
            setattr(obj, f.name, getattr(self, f.name))
    return obj

Chain 

Chain(L, lattice_spacing=1.0, vertical_chain=False)

Bases: BoundedBravais

Chain lattice.

  • 1D lattice
  • primitive (cell) vector(s)
    • a1 = (1,0).
  • unit cell (1 atom(s))
    • loc (0,0)

Parameters:

Name Type Description Default
L int

number of sites in the chain

 required
lattice_spacing (Scalar, Real)

lattice spacing. Defaults to 1.0.

 1.0
  • Possible Next: continue with . to see possible next step in auto-prompt supported setting (IPython, IDE ...)
Source code in src/bloqade/ir/location/bravais.py 
193
194
195
196
197
198
@beartype
def __init__(
    self, L: int, lattice_spacing: ScalarType = 1.0, vertical_chain: bool = False
):
    self.vertical = vertical_chain
    super().__init__(L, lattice_spacing=lattice_spacing)

Honeycomb 

Honeycomb(L, lattice_spacing=1.0)

Bases: BoundedBravais

Honeycomb lattice.

  • 2D lattice
  • primitive (cell) vector(s)
    • a1 = (1, 0)
    • a2 = (½, sqrt(3)/2)
  • unit cell (2 atom(s))
    • loc1 (0, 0)
    • loc2 (½, 1/(2*sqrt(3))

Parameters:

Name Type Description Default
L int

number of sites in linear direction. n_atoms = L * L * 2.

 required
lattice_spacing (Scalar, Real)

lattice spacing. Defaults to 1.0.

 1.0
  • Possible Next: continue with . to see possible next step in auto-prompt supported setting (IPython, IDE ...)
Source code in src/bloqade/ir/location/bravais.py 
381
382
383
@beartype
def __init__(self, L: int, lattice_spacing: ScalarType = 1.0):
    super().__init__(L, L, lattice_spacing=lattice_spacing)

Kagome 

Kagome(L, lattice_spacing=1.0)

Bases: BoundedBravais

Kagome lattice.

  • 2D lattice
  • primitive (cell) vector(s)
    • a1 = (1, 0)
    • a2 = (½, sqrt(3)/2)
  • unit cell (3 atom(s))
    • loc1 (0, 0)
    • loc2 (0.5, 0)
    • loc3 (0.25 ,0.25sqrt(3))

Parameters:

Name Type Description Default
L int

number of sites in linear direction. n_atoms = L * L.

 required
lattice_spacing (Scalar, Real)

lattice spacing. Defaults to 1.0.

 1.0
  • Possible Next: continue with . to see possible next step in auto-prompt supported setting (IPython, IDE ...)
Source code in src/bloqade/ir/location/bravais.py 
497
498
499
@beartype
def __init__(self, L: int, lattice_spacing: ScalarType = 1.0):
    super().__init__(L, L, lattice_spacing=lattice_spacing)

Lieb 

Lieb(L, lattice_spacing=1.0)

Bases: BoundedBravais

Lieb lattice.

  • 2D lattice
  • primitive (cell) vector(s)
    • a1 = (1, 0)
    • a2 = (0, 1)
  • unit cell (3 atom(s))
    • loc1 (0, 0)
    • loc2 (0.5, 0)
    • loc3 (0 ,0.5)

Parameters:

Name Type Description Default
L int

number of sites in linear direction. n_atoms = L * L.

 required
lattice_spacing (Scalar, Real)

lattice spacing. Defaults to 1.0.

 1.0
  • Possible Next: continue with . to see possible next step in auto-prompt supported setting (IPython, IDE ...)
Source code in src/bloqade/ir/location/bravais.py 
458
459
460
@beartype
def __init__(self, L: int, lattice_spacing: ScalarType = 1.0):
    super().__init__(L, L, lattice_spacing=lattice_spacing)

Rectangular 

Rectangular(
    width,
    height,
    lattice_spacing_x=1.0,
    lattice_spacing_y=None,
)

Bases: BoundedBravais

Rectangular lattice.

  • 2D lattice
  • primitive (cell) vector(s)
    • a1 = (1,0)
    • a2 = (0,1)
  • unit cell (1 atom(s))
    • loc (0,0)

Parameters:

Name Type Description Default
width int

number of sites in x direction.

 required
height int

number of sites in y direction.

 required
lattice_spacing_x (Scalar, Real)

lattice spacing. Defaults to 1.0.

 1.0
lattice_spacing_y (Scalar, Real)

lattice spacing in y direction. optional.

 None
  • Possible Next: continue with . to see possible next step in auto-prompt supported setting (IPython, IDE ...)
Source code in src/bloqade/ir/location/bravais.py 
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
@beartype
def __init__(
    self,
    width: int,
    height: int,
    lattice_spacing_x: ScalarType = 1.0,
    lattice_spacing_y: Optional[ScalarType] = None,
):
    super().__init__(width, height, lattice_spacing=lattice_spacing_x)

    if lattice_spacing_y is None:
        self.ratio = cast(1.0) / cast(lattice_spacing_x)
    else:
        self.ratio = cast(lattice_spacing_y) / cast(lattice_spacing_x)

    super().__init__(width, height, lattice_spacing=lattice_spacing_x)

Square 

Square(L, lattice_spacing=1.0)

Bases: BoundedBravais

Square lattice.

  • 2D lattice
  • primitive (cell) vector(s)
    • a1 = (1,0)
    • a2 = (0,1)
  • unit cell (1 atom(s))
    • loc (0,0)

Parameters:

Name Type Description Default
L int

number of sites in linear direction. n_atoms = L * L.

 required
lattice_spacing (Scalar, Real)

lattice spacing. Defaults to 1.0.

 1.0
  • Possible Next: continue with . to see possible next step in auto-prompt supported setting (IPython, IDE ...)
Source code in src/bloqade/ir/location/bravais.py 
235
236
237
@beartype
def __init__(self, L: int, lattice_spacing: ScalarType = 1.0):
    super().__init__(L, L, lattice_spacing=lattice_spacing)

Triangular 

Triangular(L, lattice_spacing=1.0)

Bases: BoundedBravais

Triangular lattice.

  • 2D lattice
  • primitive (cell) vector(s)
    • a1 = (1, 0)
    • a2 = (½, sqrt(3)/2)
  • unit cell (1 atom(s))
    • loc (0, 0)

Parameters:

Name Type Description Default
L int

number of sites in linear direction. n_atoms = L * L.

 required
lattice_spacing (Scalar, Real)

lattice spacing. Defaults to 1.0.

 1.0
  • Possible Next: continue with . to see possible next step in auto-prompt supported setting (IPython, IDE ...)
Source code in src/bloqade/ir/location/bravais.py 
419
420
421
@beartype
def __init__(self, L: int, lattice_spacing: ScalarType = 1.0):
    super().__init__(L, L, lattice_spacing=lattice_spacing)