GeneratorBase

class sknano.generators.GeneratorBase(*args, autogen=True, finalize=True, **kwargs)

Bases: sknano.io.StructureWriterMixin, sknano.core.structures.StructureBase

Base structure generator class.

Parameters:

• autogen (bool) –
• finalize (bool) –

Attributes

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

Methods

clear()	Clear list of StructureMixin.atoms.
finalize()	Finalize structure data by assigning unique ids and types to structure atoms.
generate([finalize])	Generate structure data.
make_supercell(scaling_matrix[, wrap_coords])	Make supercell.
rotate(**kwargs)	Rotate crystal cell lattice, basis, and unit cell.
save(*args, **kwargs)	An alias for write.
transform_lattice(scaling_matrix[, ...])	Transform structure lattice.
translate(t[, fix_anchor_points])	Translate crystal cell lattice, basis, and unit cell.
write(*args, **kwargs)	Write structure data to file.
write_data(**kwargs)	Write LAMMPS data file.
write_dump(**kwargs)	Write LAMMPS dump file.
write_pdb(**kwargs)	Write pdb file.
write_xyz(**kwargs)	Write xyz file.

Attributes Summary

Natoms	N atoms.
mass	Total mass of atoms.

Methods Summary

finalize()	Finalize structure data by assigning unique ids and types to structure atoms.
generate([finalize])	Generate structure data.
save(*args, **kwargs)	An alias for write.

Attributes Documentation

Natoms

N atoms.

mass

Total mass of atoms.

Methods Documentation

finalize()

Finalize structure data by assigning unique ids and types to structure atoms.

generate(finalize=True)

Generate structure data.

save(*args, **kwargs)

An alias for write.