zerothi / sisl

Electronic structure Python package for post analysis and large scale tight-binding DFT/NEGF calculations
https://zerothi.github.io/sisl
Mozilla Public License 2.0
199 stars 60 forks source link

Passivate edges in carbon nanostructures #600

Open decerio opened 1 year ago

decerio commented 1 year ago

Hi,

I work with graphene nanostructures like graphene nanoribbons and nanoporous graphene, and I think there may be many other SISL users that very find useful the agnr, zgnr, graphene_nanoribbons. However if one wants to generate carbon geometries that can be used as input geometries for DFT codes, it is desirable to have the edges correctly passivated with hydrogen (H) atoms.

Even more, edge functionalization with chemical species different from H has been experimentally achieved:

As far as I know, edge passivation is not implemented in SISL, is it? At least, I didn't find it. So it might be interested to add a passivate parameter to agnr, zgnr, graphene_nanoribbons that gives the passivated geometries by setting passivate = True. It could also be added as a method to passivate/functionalize geometries that have already been created (e.g. a porous ribbon) by doing something like geometry.passivate_edges().

My suggestion is something like this:

def passivate_edges(g,bond=1.1,atoms=None,species='H'):
    """
    Passivates atoms with dangling bonds.

    Parameters
    ----------
    g: sisl.Geometry
        Geometry
    bond: int, float
        Distance between the passivated edge atom and the new added atom.
        In the case of H passivation this is the C-H bond-length.
    atoms: array, list
        Atomic indices to be considered in the passivation. Only the atoms
        with a dangling bonds (less than 3 nearest neighbours) will be
        passivated. If None is passed, all atoms will be considered
    species: string, int
        Chemical label or atomic number of the atoms that will passivate the
        edge.
    """

    gtmp = g.copy()
    if atoms is None:
        atoms = np.arange(gtmp.na)
    for ia in atoms:
        nn = gtmp.close(ia,R=[0.1,1.5])[1]
        if len(nn) < 3:
            vec1 = gtmp.axyz(nn[0]) - gtmp.xyz[ia]
            vec2 = gtmp.axyz(nn[1]) - gtmp.xyz[ia]
            vec3 = -bond*(vec1+vec2)/np.linalg.norm(vec1+vec2)
            edge_atom = sisl.Geometry(xyz=[gtmp.xyz[ia]+vec3],atoms=sisl.Atom(species))
            gtmp = gtmp.add(edge_atom)
    return gtmp

I attach a jupyter notebook that serves as an example of how could this function be used. example_passivation.ipynb.zip

Do you think it could be interesting?

tfrederiksen commented 1 year ago

Hi @decerio , this idea is related to #202 that also grew out of a need to passivate ribbon edges.

pfebrer commented 1 year ago

Welcome to the club :1st_place_medal: (of people that want the passivation feature) :)

Apart from #202 I wonder if the problem can now be framed in terms of the new composite geometries about to be merged in https://github.com/zerothi/sisl/pull/421.

So that you can do something like:

ribbon = sisl.graphene_nanoribbon(...)

passivator = Passivator()

passivated_ribbon = ribbon + passivator

where passivator is a "geometry section" in the terminology of that PR. If the composite geometries kept track of the child sections you could always "undo" to depassivate, which is cool (I don't know if useful).

pfebrer commented 1 year ago

Btw I think if you need to deal with very big geometries it would be very useful to have https://github.com/zerothi/sisl/pull/393, otherwise using Geometry.close will blow up the computation time unnecessarily.

decerio commented 1 year ago

OK, I see this has been extensively discussed before. It looked so obvious to me that this functionality would be very useful.

@pfebrer thanks! Yes, #393 would be convenient for big geometries.

zerothi commented 1 year ago

Ok, we need to do something here.. The other pr's mentioned are still in the pipeline, however I would like some general method that is applicable to other systems than carbon. I'll try and write a more thorough thought through suggestion :)