bilayers.Bilayer2D Class Reference

Public Member Functions
	__post_init__ (self)
str	atom_style (self)
	box (self, ell1, ell2)

Data Fields
	interlayer_spacing

Static Public Attributes
str	name
Layer2D	top_layer
Layer2D	bottom_layer
float	interlayer_spacing
gb	bicrystal = field(init=False, repr=False)

Detailed Description

Bilayer consisting of two 2D multilattices.

Parameters
----------
name : str
    Name of the bilayer.
top_layer : Layer2D
    Top layer.
bottom_layer : Layer2D
    Bottom layer.
interlayer_spacing : float
    Distance between the Bravais lattice planes of the two layers.

Definition at line 13 of file bilayers.py.

Member Function Documentation

__post_init__()

bilayers.Bilayer2D.__post_init__

(

self

)

Definition at line 36 of file bilayers.py.

atom_style()

str bilayers.Bilayer2D.atom_style

(

self

)

Definition at line 48 of file bilayers.py.

box()

bilayers.Bilayer2D.box	(		self,
			ell1,
			ell2
	)

Build Cartesian atomic positions using CSL lattice vectors.

Parameters
----------
ell1, ell2 : gb.LatticeVector2D
    CSL lattice vectors belonging to self.bicrystal.csl.
    These may be primitive vectors or any integer combination of them.

Returns
-------
positions : list[(x, y, z)]
atom_types : list[int]
charges : list[float]
labels : list[str]
molecule_ids : list[int]

Definition at line 53 of file bilayers.py.

Field Documentation

bicrystal

gb bilayers.Bilayer2D.bicrystal = field(init=False, repr=False)

static

Definition at line 34 of file bilayers.py.

bottom_layer

Layer2D bilayers.Bilayer2D.bottom_layer

static

Definition at line 30 of file bilayers.py.

interlayer_spacing [1/2]

float bilayers.Bilayer2D.interlayer_spacing

static

Definition at line 31 of file bilayers.py.

interlayer_spacing [2/2]

bilayers.Bilayer2D.interlayer_spacing

Definition at line 87 of file bilayers.py.

name

str bilayers.Bilayer2D.name

static

Definition at line 28 of file bilayers.py.

top_layer

Layer2D bilayers.Bilayer2D.top_layer

static

Definition at line 29 of file bilayers.py.

---

The documentation for this class was generated from the following file:

• examples/python/heterodeformation/bilayers.py