bloqade.analog.ir.location.bravais.BoundedBravais

← Module overview

classBoundedBravais¶source

bloqade.analog.ir.location.bravais.BoundedBravais

Bases: AtomArrangement

class BoundedBravais

Public import paths

• from bloqade.analog.ir import BoundedBravais
• from bloqade.analog.ir.location import BoundedBravais

methodcell_vectors¶source

bloqade.analog.ir.location.bravais.BoundedBravais.cell_vectors

def cell_vectors() -> Tuple[Tuple[Scalar, ...], ...]

Returns

Tuple[Tuple[Scalar, ...], ...]

source

methodcell_atoms¶source

bloqade.analog.ir.location.bravais.BoundedBravais.cell_atoms

def cell_atoms() -> Tuple[Tuple[Scalar, ...], ...]

Returns

Tuple[Tuple[Scalar, ...], ...]

source

propertyshape¶source

bloqade.analog.ir.location.bravais.BoundedBravais.shape

shape: Tuple[int, ...]

source

propertyn_atoms¶source

bloqade.analog.ir.location.bravais.BoundedBravais.n_atoms

n_atoms: int

source

propertyn_sites¶source

bloqade.analog.ir.location.bravais.BoundedBravais.n_sites

n_sites: int

source

propertyn_vacant¶source

bloqade.analog.ir.location.bravais.BoundedBravais.n_vacant

n_vacant: int

source

propertyn_dims¶source

bloqade.analog.ir.location.bravais.BoundedBravais.n_dims

n_dims

dimension of the lattice

Returns

int: dimension of the lattice

source

methodcoordinates¶source

bloqade.analog.ir.location.bravais.BoundedBravais.coordinates

def coordinates(index: List[int]) -> NDArray

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

Parameters

Name	Type	Description
index	List[int]

Returns

NDArray

source

methodenumerate¶source

bloqade.analog.ir.location.bravais.BoundedBravais.enumerate

def enumerate() -> Generator[LocationInfo, None, None]

Returns

Generator[LocationInfo, None, None]

source

methodscale¶source

bloqade.analog.ir.location.bravais.BoundedBravais.scale

def scale(factor: ScalarType) -> BoundedBravais

Scale the current location with a factor.

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

Parameters

Name	Type	Description
factor	ScalarType	scale factor

Returns

BoundedBravaisBoundedBravais: The lattice with the scaled locations

source