StructureMixin

class sknano.core.structures.StructureMixin[source] [edit on github][source]

Bases: object

Mixin class for crystal structures.

Attributes

atoms Structure Atoms.
basis Structure BasisAtoms.
crystal_cell Structure CrystalCell.
lattice Structure Crystal3DLattice.
lattice_shift Lattice displacement vector.
scaling_matrix CrystalCell.scaling_matrix.
structure An alias to self.
unit_cell Structure UnitCell.

Methods

clear() Clear list of StructureMixin.atoms.
make_supercell(scaling_matrix[, wrap_coords]) Make supercell.
rotate(**kwargs) Rotate crystal cell lattice, basis, and unit cell.
transform_lattice(scaling_matrix[, ...]) Transform structure lattice.
translate(t[, fix_anchor_points]) Translate crystal cell lattice, basis, and unit cell.

Attributes Summary

atoms Structure Atoms.
basis Structure BasisAtoms.
crystal_cell Structure CrystalCell.
lattice Structure Crystal3DLattice.
lattice_shift Lattice displacement vector.
scaling_matrix CrystalCell.scaling_matrix.
structure An alias to self.
unit_cell Structure UnitCell.

Methods Summary

clear() Clear list of StructureMixin.atoms.
make_supercell(scaling_matrix[, wrap_coords]) Make supercell.
rotate(**kwargs) Rotate crystal cell lattice, basis, and unit cell.
transform_lattice(scaling_matrix[, ...]) Transform structure lattice.
translate(t[, fix_anchor_points]) Translate crystal cell lattice, basis, and unit cell.

Attributes Documentation

atoms

Structure Atoms.

basis

Structure BasisAtoms.

crystal_cell

Structure CrystalCell.

lattice

Structure Crystal3DLattice.

lattice_shift

Lattice displacement vector.

scaling_matrix

CrystalCell.scaling_matrix.

structure

An alias to self.

unit_cell

Structure UnitCell.

Methods Documentation

clear()[source] [edit on github][source]

Clear list of StructureMixin.atoms.

make_supercell(scaling_matrix, wrap_coords=False)[source] [edit on github][source]

Make supercell.

rotate(**kwargs)[source] [edit on github][source]

Rotate crystal cell lattice, basis, and unit cell.

transform_lattice(scaling_matrix, wrap_coords=False, pbc=None)[source] [edit on github][source]

Transform structure lattice.

translate(t, fix_anchor_points=True)[source] [edit on github][source]

Translate crystal cell lattice, basis, and unit cell.