Merge pull request logsdail#134 from AkashHiregange/akash-new_bulk_fr…

…om_slab

New functionality for generating slab consistent bulk model

.github/workflows/main.yml

@@ -46,6 +46,7 @@ jobs:
         python -m pip install --upgrade pytest-cov
         python -m pip install torch torchvision torchaudio
         python -m pip install --upgrade mace-torch
+        python -m pip install pymatgen
         
     
     # Setup Python environment

carmm/build/slab_consistent_bulk_generator.py

@@ -0,0 +1,117 @@
+
+# This functionality will help to generate a bulk model from a slab.
+
+def bulk_identifier(slab, cutoff_distance=10.0):
+    """
+    Slab models can be generated using various libraries like ASE, pymatgen, atomman, etc. However, it becomes important
+    to check how these slab models are generated within various code bases.
+
+    Pymatgen for example generates desired surface facets by transforming the basis vectors of the conventional bulk
+    unit cell such that the c-vector of new bulk is normal to the desired surface plane. The basis transformation however
+    changes the convergence behavior of the slab models with respect to the thickness of the slab. Hence, a new bulk
+    unit cell is necessary, generated for each individual slab model, to make sure that the surface energies are
+    calculated using a correct bulk reference.
+
+    This function helps to identify the repeating unit in the z-direction which ultimately represents the
+    bulk atoms in a slab structure. This new bulk structure will be consistent with the slab model and the
+    computed bulk energy for this structure will help us to obtain surface energies that are convergent with
+    increasing slab thickness.
+
+    NOTE: Please use this functionality only if you observe divergent surface energy behaviour using the already
+    available total energy of the conventional bulk unit cell.
+
+    Detailed information is available in the following literature article.
+    Schultz, Peter A.
+    "First-principles calculations of metal surfaces. I. Slab-consistent bulk reference for convergent surface
+    properties." Physical Review B 103.19 (2021): 195426.
+
+    How this functionality works:
+    1. the difference between the x,y and z coordinates of an atom and its corresponding periodic image will be a linear
+    combination of the cell vectors a,b and c.
+    2. This idea is extended here in case of a slab model where the linear combination check
+    is considered only w.r.t to the a and b vectors
+
+    Args:
+    - slab: ASE Atoms object representing the slab structure
+    - cutoff_distance: Cutoff distance for identifying neighboring atoms (default is 10.0). This will be used to
+     perform further checks on atoms which satisfy the condition of linear combination.
+
+    Returns:
+    - ASE Atoms object representing the new bulk structure
+    """
+    from ase.build.tools import sort
+    import numpy as np
+    from ase import Atoms
+
+    if type(slab) is not Atoms:
+        raise Exception('Invalid input. Please provide an Atoms object for your desired slab model')
+    # Sort the slab based on z-coordinate
+    slab = sort(slab.copy(), np.array(slab.get_positions()[:, 2]).tolist())
+    a, b, c = slab.cell  # Extract cell vectors
+
+    # Calculate all pairwise distances between atoms
+    distances = slab.get_all_distances()
+    z_coord_values = []
+    cutoff_distance = cutoff_distance
+
+    for atom_i in slab:
+        for atom_j in slab:
+            if atom_i.symbol == atom_j.symbol and atom_i.index != atom_j.index:
+                diff_xy = np.array(atom_j.position[:2] - atom_i.position[:2])
+                cell_vec_xy = np.array(slab.cell[:2, :2])
+                int_vec = np.linalg.solve(cell_vec_xy.transpose(), diff_xy)
+
+                if is_close_to_integer(int_vec).all():
+                    # further check is done to see if the coordination environment of the atom j is similar ot atom i
+                    # based on cutoff distance.
+                    cutoff_obeyed_i = [dist for ind, dist in enumerate(distances[atom_i.index].tolist())
+                                       if
+                                       dist <= cutoff_distance and slab[ind].position[2] / atom_i.position[2] >= 0.9999]
+                    cutoff_obeyed_j = [dist for ind, dist in enumerate(distances[atom_j.index].tolist())
+                                       if
+                                       dist <= cutoff_distance and slab[ind].position[2] / atom_j.position[2] >= 0.9999]
+
+                    if len(cutoff_obeyed_j) == len(cutoff_obeyed_i):
+                        dist_diff = np.linalg.norm(np.array(cutoff_obeyed_j)) / np.linalg.norm(
+                            np.array(cutoff_obeyed_i))
+                        if 0.99 <= dist_diff <= 1.01:
+                            z_dist = atom_j.position[2] - atom_i.position[2]
+                            z_coord_values.append(z_dist)
+
+    z_coord_values = np.array(z_coord_values)
+    slab.center()
+    # set the cell parameters to the original 'a' and 'b' whereas the 'c' vector is changed to a new value which
+    # represents the minimum repeating unit in the z-direction
+    slab.set_cell(np.array([a, b, [0, 0, min(np.abs(z_coord_values))]]))
+
+    # Modify positions to lie within the cell
+    x_coord = slab.get_positions()[:, 0]
+    y_coord = slab.get_positions()[:, 1]
+    new_z_coord = slab.get_positions()[:, 2] - min(slab.get_positions()[:, 2])
+    slab.set_positions(np.array([x_coord, y_coord, new_z_coord]).transpose())
+
+    # Remove atoms beyond cell boundaries
+    atoms_to_del = [atom_i.index for atom_i in slab if atom_i.position[2] > slab.cell[2, 2]]
+    new_bulk = slab[[i for i in range(len(slab)) if i not in atoms_to_del]]
+
+    return new_bulk # return the new bulk model
+
+
+def is_close_to_integer(arr, tolerance=1e-5):
+    """
+    Check if elements in the array are close to integers within a given tolerance. This will be used to check if the x-
+    and y-coordinate of an atom is a linear combination the 'a' and 'b' cell vector of the slab model
+
+    Args:
+    - arr: Numpy array
+    - tolerance: Tolerance for closeness to integers (default is 1e-5)
+
+    Returns:
+    - Boolean array indicating if elements are close to integers
+    """
+    import numpy as np
+
+    diff = np.abs(arr - np.round(arr))
+    close_to_integer = diff < tolerance
+    return close_to_integer
+

examples/build_slab_consistent_bulk.py

@@ -0,0 +1,35 @@
+
+'''
+Testing the build_slab_consistent_bulk functionality
+'''
+
+def test_build_slab_consistent_bulk():
+    from carmm.build.slab_consistent_bulk_generator import bulk_identifier
+    from ase.formula import Formula
+    from ase.build import bulk
+    from pymatgen.io.ase import AseAtomsAdaptor
+    from pymatgen.core.surface import SlabGenerator
+    crys = bulk('MgO', crystalstructure='rocksalt', cubic=True, a=4.21)
+    structure = AseAtomsAdaptor.get_structure(crys)
+    slabgen = SlabGenerator(structure, miller_index=(1, 1, 1),
+                            min_slab_size=10,
+                            min_vacuum_size=20,
+                            center_slab=True, in_unit_planes=True, lll_reduce=True)
+    slabs = slabgen.get_slabs(ftol=0.001, symmetrize=False)
+    slab = AseAtomsAdaptor.get_atoms(slabs[0].get_orthogonal_c_slab())
+    new_bulk = bulk_identifier(slab)
+    emp_formula = new_bulk.get_chemical_formula(mode='hill', empirical=True)
+    total_atoms = 0
+
+    for sym, stoi in Formula(emp_formula).count().items():
+        total_atoms += stoi
+    formula_units = len(new_bulk)/total_atoms
+
+    assert emp_formula=='MgO'
+    assert total_atoms==2
+    assert formula_units==3.0
+
+
+test_build_slab_consistent_bulk()
+
+