pyxmolpp2.UnitCell class

Unit cell

Classes

class ClosestImage
Result of closest periodic image search

Static methods

def from_rst7_line(arg0: str, /) -> UnitCell

Methods

def closest_image_to(self, ref: XYZ, var: XYZ) -> ClosestImage
Closest periodic image to ref
def scale_by(self, factor: float) -> None
Scale cell by linear factor
def scale_to_volume(self, volume: float) -> None
Scale cell to match volume
def translation_vector(self, i: int, j: int, k: int) -> XYZ
Returns i \vec v_1 + j \vec v_2 + k \vec v_3

Special methods

def __getitem__(self, i: int) -> XYZ
Get i-th cell lattice vector
def __init__(self, arg0: UnitCell, /) -> None
def __init__(self, v1: XYZ, v2: XYZ, v3: XYZ) -> None
Construct cell from primitive vectors
def __init__(self, a: float, b: float, c: float, alpha: AngleValue, beta: AngleValue, gamma: AngleValue) -> None
Construct cell from lengths and angles
def __len__(self, /) -> int

Properties

a: float get
Length of v_1
alpha: AngleValue get
Angle between v_2 and v_3
b: float get
Length of v_2
beta: AngleValue get
Angle between v_1 and v_3
c: float get
Length of v_3
gamma: AngleValue get
Angle between v_1 and v_2
volume: float get
Volume

Method documentation

def pyxmolpp2.UnitCell.closest_image_to(self, ref: XYZ, var: XYZ) -> ClosestImage

Closest periodic image to ref

Parameters
ref reference point
var variable point