Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
jic198 committed Jul 23, 2023
2 parents 374faa2 + d6365c3 commit 78bf5f3
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions aimsgb/grain.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ def fix_sites_in_layers(self, layer_indices, tol=0.25, direction=2):
layer_indices (list): A list of layer indices.
tol (float): Tolerance factor in Angstrom to determnine if sites are
in the same layer. Default to 0.25.
direction (int): Direction to sort the sites by layers. 0: x, 1: y, 2: z
direction (int): Direction to sort the sites by layers. 0: a, 1: b, 2: c
"""
layers = self.sort_sites_in_layers(tol=tol, direction=direction)
sd_sites = []
Expand Down Expand Up @@ -113,7 +113,7 @@ def delete_bt_layer(self, bt, tol=0.25, direction=2):
means bottom layer and "t" means top layer.
tol (float): Tolerance factor in Angstrom to determnine if sites are
in the same layer. Default to 0.25.
direction (int): Direction to sort the sites by layers. 0: x, 1: y, 2: z
direction (int): Direction to sort the sites by layers. 0: a, 1: b, 2: c
"""
if bt == "t":
l1, l2 = (-1, -2)
Expand Down Expand Up @@ -146,7 +146,7 @@ def sort_sites_in_layers(self, tol=0.25, direction=2):
Args:
tol (float): Tolerance factor in Angstrom to determnine if sites are
in the same layer. Default to 0.25.
direction (int): Direction to sort the sites by layers. 0: x, 1: y, 2: z
direction (int): Direction to sort the sites by layers. 0: a, 1: b, 2: c
Returns:
Lists with a list of (site, index) in the same plane as one list.
Expand Down Expand Up @@ -210,7 +210,7 @@ def build_grains(self, csl, direction, uc_a=1, uc_b=1):
Args:
csl (3x3 matrix): CSL matrix (scaling matrix)
direction (int): Stacking direction of GB. 0: x, 1: y, 2: z
direction (int): Stacking direction of GB. 0: a, 1: b, 2: c
uc_a (int): Number of unit cell of grain A. Default to 1.
uc_b (int): Number of unit cell of grain B. Default to 1.
Expand Down Expand Up @@ -280,7 +280,7 @@ def stack_grains(cls, grain_a, grain_b, vacuum=0.0, gap=0.0, direction=2,
grain_b (Grain): Film for the interface structure
vacuum (float): Vacuum space above the film in Angstroms. Default to 0.0
gap (float): Gap between substrate and film in Angstroms. Default to 0.0
direction (int): Stacking direction of the interface structure. 0: x, 1: y, 2: z.
direction (int): Stacking direction of the interface structure. 0: a, 1: b, 2: c.
delete_layer (str): Delete top and bottom layers of the substrate and film.
8 characters in total. The first 4 characters is for the substrate and
the other 4 is for the film. "b" means bottom layer and "t" means
Expand Down

0 comments on commit 78bf5f3

Please sign in to comment.