tepkit.core.symmetry.BravaisLattice2D#

class tepkit.core.symmetry.BravaisLattice2D#

Bases: enum.StrEnum

The string enum class for 2D Bravais lattices.

Reference:

International Tables for Crystallography, Vol. E Subperiodic groups

—— Kopský, V. (Editor)

Kluwer Academic, Dordrecht, 2002.

| > Page 6, Table 1.2.1.1

>>> BravaisLattice2D.mp
'mp'

Initialize self. See help(type(self)) for accurate signature.

Attributes#

Attribute	Default Value	Description
`mp`	`'mp'`	Oblique
`op`	`'op'`	Rectangular
`oc`	`'oc'`	Centered-Rectangular
`tp`	`'tp'`	Square
`hp`	`'hp'`	Hexagonal

Properties#

long_name

Return the long name of current BravaisLattice2D.

Methods#

`from_string`(→ tepkit.utils.typing_tools.Self)	Get a `BravaisLattice2D` instance from a string.
`keys`(→ list[str])
`to_string`(→ str)	Return the string representation of the current BravaisLattice2D.
`differentiate_rectangular_lattice`(...)	Differentiate a rectangular lattice to `oc` or `op` based on the number of the space group.
`from_bravais_system_2d`(→ tepkit.utils.typing_tools.Self)
`from_file`(→ tepkit.utils.typing_tools.Self)
`from_poscar`(→ tepkit.utils.typing_tools.Self)

All Members#

mp = 'mp': Oblique

op = 'op': Rectangular

oc = 'oc': Centered-Rectangular

tp = 'tp': Square

hp = 'hp': Hexagonal

classmethod from_string(key: str) → Self

Get a BravaisLattice2D instance from a string.

The string is case insensitive and can be any one of the following formats:

Short name (mp, …)
Long name (oblique, …)
The first three letters of the long name (obl, …)

Parameters:: key – The vaild name of the 2D Bravais Lattice.
Returns:: The BravaisLattice2D instance.

classmethod keys() → list[str]

property long_name: str: Return the long name of current BravaisLattice2D.

to_string(style: str) → str

Return the string representation of the current BravaisLattice2D.

Parameters:

style –

The style of string representation.

short: Short name style.
long: Long name style.
full: Combined <long_name> (<short_name>) style,
this style should only be used for display.

classmethod differentiate_rectangular_lattice(space_group_number: int) → Self

Differentiate a rectangular lattice to oc or op based on the number of the space group.

Parameters:: space_group_number – The number of the space group.
Returns:: The BravaisLattice2D instance.
Raises:: Exception – If the space group number is not valid for a 2D rectangular lattice.

Method:

op:
- mP (unique axis c): 3, 4, 6, 7, 10, 11, 13, 14,
- oP: 16, 17, 18, 19,
  25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62,
oc:
- oS (oC setting): 20, 21, 35, 36, 37, 38, 39, 40, 41, 63, 64, 65, 66, 67