Skip to content

bloqade.analog.ir.location.bravais.Rectangular

← Module overview

classRectangularsource

bloqade.analog.ir.location.bravais.Rectangular

Bases: BoundedBravais

Rectangular lattice.

Signature
class Rectangular(width: int, height: int, *, lattice_spacing_x: ScalarType = 1.0, lattice_spacing_y: ScalarType = 1.0)
  • 2D lattice

  • primitive (cell) vector(s)

    • a1 = (1,0)
    • a2 = (0,1)
  • unit cell (1 atom(s))

    • loc (0,0)
  • Possible Next: continue with . to see possible next step in auto-prompt supported setting (IPython, IDE …)

Parameters

NameTypeDefaultDescription
widthintrequirednumber of sites in x direction.
heightintrequirednumber of sites in y direction.
lattice_spacing_xScalarType1.0lattice spacing. Defaults to 1.0.
lattice_spacing_yScalarType1.0lattice spacing in y direction. optional.

Attributes

NameTypeDefaultDescription
widthintwidth
heightintheight
lattice_spacing_xScalarcast(lattice_spacing_x)
lattice_spacing_yScalarcast(lattice_spacing_y) if lattice_spacing_y is not None else self.lattice_spacing_x

propertylattice_spacingsource

bloqade.analog.ir.location.bravais.Rectangular.lattice_spacing

lattice_spacing: Scalar
source

propertyshapesource

bloqade.analog.ir.location.bravais.Rectangular.shape

shape: Tuple[int, ...]
source

methodcell_vectorssource

bloqade.analog.ir.location.bravais.Rectangular.cell_vectors

def cell_vectors() -> List[List[float]]

Returns

List[List[float]]

source

methodcell_atomssource

bloqade.analog.ir.location.bravais.Rectangular.cell_atoms

def cell_atoms() -> List[List[float]]

Returns

List[List[float]]

source