pyxtal.crystal module¶
Module for generating atomic crystals
-
class
pyxtal.crystal.
random_crystal
(dim=3, group=227, species=['C'], numIons=8, factor=1.1, thickness=None, area=None, lattice=None, sites=None, conventional=True, tm=<pyxtal.tolerance.Tol_matrix object>, use_hall=False)[source]¶ Bases:
object
Class for storing and generating atomic crystals based on symmetry constraints. Given a spacegroup, list of atomic symbols, the stoichiometry, and a volume factor, generates a random crystal consistent with the spacegroup’s symmetry.
Parameters: - dim – dimenion (0, 1, 2, 3)
- group – the group number (1-56, 1-75, 1-80, 1-230)
- species – a list of atomic symbols for each ion type, e.g., [“Ti”, “O”]
- numIons – a list of the number of each type of atom within the primitive cell (NOT the conventional cell), e.g., [4, 2]
- factor (optional) – volume factor used to generate the crystal
- sites (optional) – pre-assigned wyckoff sites (e.g., [[“4a”], [“2b”]])
- lattice (optional) – Lattice object to define the unit cell
- tm (optional) – Tol_matrix object to define the distances