Hamiltonian

Bases: app.forcefield.ForceField

Source code in dmff/api.py
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
class Hamiltonian(app.forcefield.ForceField):
    def __init__(self, *xmlnames, **kwargs):
        super().__init__(*xmlnames)
        self._pseudo_ff = app.ForceField(*xmlnames)
        # parse XML forcefields
        self.fftree = ForcefieldTree('ForcefieldTree')
        self.xmlparser = XMLParser(self.fftree)
        self.xmlparser.parse(*xmlnames)

        self._jaxGenerators = []
        self._potentials = []
        self.paramtree = {}

        self.ommsys = None

        for child in self.fftree.children:
            if child.tag in jaxGenerators:
                self._jaxGenerators.append(jaxGenerators[child.tag](self))

        # initialize paramtree
        self.extractParameterTree()

        # hook generators to self._forces
        # use noOmmSys to disable all traditional openmm system
        if kwargs.get("noOmmSys", False):
            self._forces = []
        for jaxGen in self._jaxGenerators:
            self._forces.append(jaxGen)

    def getGenerators(self):
        return self._jaxGenerators

    def extractParameterTree(self):
        # load Force info
        for jaxgen in self._jaxGenerators:
            jaxgen.extract()

    def overwriteParameterTree(self):
        # write Force info
        for jaxgen in self._jaxGenerators:
            jaxgen.overwrite()
        pass

    def createPotential(self,
                        topology,
                        nonbondedMethod=app.NoCutoff,
                        nonbondedCutoff=1.0 * unit.nanometer,
                        jaxForces=[],
                        **args):
        # load_constraints_from_system_if_needed
        # create potentials
        """
        Create differentiable jax potential for given openmm.app.Topology object

        Parameters
        ----------
        topology: openmm.app.Topology
            Input openmm topology
        nonbondedMethod: object=NoCutoff
            The method to use for nonbonded interactions. Allowed values are 
            NoCutoff, CutoffNonPeriodic, CutoffPeriodic, Ewald, PME, or LJPME.
        nonbondedCutoff : distance=1*nanometer
            The cutoff distance to use for nonbonded interactions
        jaxForces: list of str
            Specified forces to create. If set to [], will create all existing types of forces.
        args
            Arbitrary parameters in openmm.app.ForceField.createSystem function

        Return
        ------
        potObj: dmff.api.Potential
            Differentiable jax potential energy function
        """
        pseudo_data = app.ForceField._SystemData(topology)
        residueTemplates = {}
        templateForResidue = self._pseudo_ff._matchAllResiduesToTemplates(pseudo_data, topology, residueTemplates, False)
        self.templateNameForResidue = [i.name for i in templateForResidue]

        system = self.createSystem(
            topology,
            nonbondedMethod=nonbondedMethod,
            nonbondedCutoff=nonbondedCutoff,
            **args,
        )
        removeIdx = []
        jaxGens = [i.name for i in self._jaxGenerators]
        for nf, force in enumerate(system.getForces()):
            if (len(jaxForces) > 0
                    and force.getName() in jaxForces) or (force.getName()
                                                          in jaxGens):
                removeIdx.append(nf)
        for nf in removeIdx[::-1]:
            system.removeForce(nf)

        potObj = Potential()
        potObj.addOmmSystem(system)
        for generator in self._jaxGenerators:
            if len(jaxForces) > 0 and generator.name not in jaxForces:
                continue
            try:
                potentialImpl = generator.getJaxPotential()
                potObj.addDmffPotential(generator.name, potentialImpl)
            except Exception as e:
                print(e)
                pass

            # virtual site
            try:
                addVsiteFunc = generator.getAddVsiteFunc()
                self.setAddVirtualSiteFunc(addVsiteFunc)
                vsiteObj = generator.getVsiteObj()
                self.setVirtualSiteObj(vsiteObj)
            except AttributeError as e:
                pass

            # covalent map
            try:
                cov_map = generator.covalent_map
                self.setCovalentMap(cov_map)
            except AttributeError as e:
                pass

            # topology matrix (for BCC usage)
            try:
                top_mat = generator.getTopologyMatrix()
                self.setTopologyMatrix(top_mat)
            except AttributeError as e:
                pass

        return potObj

    def render(self, filename):
        self.overwriteParameterTree()
        self.xmlparser.write(filename)

    def getParameters(self):
        return self.paramtree

    def updateParameters(self, paramtree):
        def update_iter(node, ref):
            for key in ref:
                if isinstance(ref[key], dict):
                    update_iter(node[key], ref[key])
                else:
                    node[key] = ref[key]

        update_iter(self.paramtree, paramtree)

    def setCovalentMap(self, cov_map: jnp.ndarray):
        self._cov_map = cov_map

    def getCovalentMap(self) -> jnp.ndarray:
        """
        Get covalent map
        """
        if hasattr(self, "_cov_map"):
            return self._cov_map
        else:
            raise DMFFException("Covalent map is not set.")

    def getAddVirtualSiteFunc(self) -> Callable:
        return self._add_vsite_coords

    def setAddVirtualSiteFunc(self, func: Callable):
        self._add_vsite_coords = func

    def setVirtualSiteObj(self, vsite):
        self._vsite = vsite

    def getVirtualSiteObj(self):
        return self._vsite

    def setTopologyMatrix(self, top_mat):
        self._top_mat = top_mat

    def getTopologyMatrix(self):
        return self._top_mat

    def addVirtualSiteCoords(self, pos: jnp.ndarray, params: Dict[str, Any]) -> jnp.ndarray:
        """
        Add coordinates for virtual sites

        Parameters
        ----------
        pos: jnp.ndarray
            Coordinates without virtual sites
        params: dict
            Paramtree of hamiltonian, i.e. `dmff.Hamiltonian.paramtree`

        Return
        ------
        newpos: jnp.ndarray

        Examples
        --------
        >>> import jax.numpy as jnp
        >>> import openmm.app as app
        >>> from rdkit import Chem
        >>> from dmff import Hamiltonian
        >>> pdb = app.PDBFile("tests/data/chlorobenzene.pdb")
        >>> pos = jnp.array(pdb.getPositions(asNumpy=True)._value)
        >>> mol = Chem.MolFromMolFile("tests/data/chlorobenzene.mol", removeHs=False)
        >>> h = Hamiltonian("tests/data/cholorobenzene_vsite.xml")
        >>> potObj = h.createPotential(pdb.topology, rdmol=mol)
        >>> newpos = h.addVirtualSiteCoords(pos, h.paramtree)

        """
        func = self.getAddVirtualSiteFunc()
        newpos = func(pos, params)
        return newpos

    def addVirtualSiteToMol(self, rdmol, params):
        """
        Add coordinates for rdkit.Chem.Mol object

        Parameters
        ----------
        rdmol: rdkit.Chem.Mol
            Mol object to which virtual sites are added
        params: dict
            Paramtree of hamiltonian, i.e. `dmff.Hamiltonian.paramtree`

        Return
        ------
        newmol: rdkit.Chem.Mol
            Mol object with virtual sites added

        Examples
        --------
        >>> import jax.numpy as jnp
        >>> import openmm.app as app
        >>> from rdkit import Chem
        >>> from dmff import Hamiltonian
        >>> pdb = app.PDBFile("tests/data/chlorobenzene.pdb")
        >>> mol = Chem.MolFromMolFile("tests/data/chlorobenzene.mol", removeHs=False)
        >>> h = Hamiltonian("tests/data/cholorobenzene_vsite.xml")
        >>> potObj = h.createPotential(pdb.topology, rdmol=mol)
        >>> newmol = h.addVirtualSiteToMol(mol, h.paramtree)
        """
        vsiteObj = self.getVirtualSiteObj()
        newmol = vsiteObj.addVirtualSiteToMol(
            rdmol,
            params['NonbondedForce']['vsite_types'],
            params['NonbondedForce']['vsite_distances']
        )
        return newmol

    @staticmethod
    def buildTopologyFromMol(rdmol, resname: str = "MOL") -> app.Topology:
        """
        Build openmm.app.Topology from rdkit.Chem.Mol Object

        Parameters
        ----------
        rdmol: rdkit.Chem.Mol
            Mol object
        resname: str
            Name of the added residue, default "MOL"

        Return
        ------
        top: `openmm.app.Topology`
            Topology built based on the input rdkit Mol object
        """
        from rdkit import Chem

        top = app.Topology()
        chain = top.addChain(0)
        res = top.addResidue(resname, chain, "1", "")

        atCount = {}
        addedAtoms = []
        for idx, atom in enumerate(rdmol.GetAtoms()):
            symb = atom.GetSymbol().upper()
            atCount.update({symb: atCount.get(symb, 0) + 1})
            ele = app.Element.getBySymbol(symb)
            atName = f'{symb}{atCount[symb]}'

            addedAtom = top.addAtom(atName, ele, res, str(idx+1))
            addedAtoms.append(addedAtom)

        bondTypeMap = {
            Chem.rdchem.BondType.SINGLE: app.Single,
            Chem.rdchem.BondType.DOUBLE: app.Double,
            Chem.rdchem.BondType.TRIPLE: app.Triple,
            Chem.rdchem.BondType.AROMATIC: app.Aromatic
        }
        for bond in rdmol.GetBonds():
            top.addBond(
                addedAtoms[bond.GetBeginAtomIdx()],
                addedAtoms[bond.GetEndAtomIdx()],
                type=bondTypeMap.get(bond.GetBondType(), None)
            )
        return top

addVirtualSiteCoords(pos, params)

Add coordinates for virtual sites

Parameters
jnp.ndarray

Coordinates without virtual sites

Return

newpos: jnp.ndarray

Examples

import jax.numpy as jnp import openmm.app as app from rdkit import Chem from dmff import Hamiltonian pdb = app.PDBFile("tests/data/chlorobenzene.pdb") pos = jnp.array(pdb.getPositions(asNumpy=True)._value) mol = Chem.MolFromMolFile("tests/data/chlorobenzene.mol", removeHs=False) h = Hamiltonian("tests/data/cholorobenzene_vsite.xml") potObj = h.createPotential(pdb.topology, rdmol=mol) newpos = h.addVirtualSiteCoords(pos, h.paramtree)

Source code in dmff/api.py
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
def addVirtualSiteCoords(self, pos: jnp.ndarray, params: Dict[str, Any]) -> jnp.ndarray:
    """
    Add coordinates for virtual sites

    Parameters
    ----------
    pos: jnp.ndarray
        Coordinates without virtual sites
    params: dict
        Paramtree of hamiltonian, i.e. `dmff.Hamiltonian.paramtree`

    Return
    ------
    newpos: jnp.ndarray

    Examples
    --------
    >>> import jax.numpy as jnp
    >>> import openmm.app as app
    >>> from rdkit import Chem
    >>> from dmff import Hamiltonian
    >>> pdb = app.PDBFile("tests/data/chlorobenzene.pdb")
    >>> pos = jnp.array(pdb.getPositions(asNumpy=True)._value)
    >>> mol = Chem.MolFromMolFile("tests/data/chlorobenzene.mol", removeHs=False)
    >>> h = Hamiltonian("tests/data/cholorobenzene_vsite.xml")
    >>> potObj = h.createPotential(pdb.topology, rdmol=mol)
    >>> newpos = h.addVirtualSiteCoords(pos, h.paramtree)

    """
    func = self.getAddVirtualSiteFunc()
    newpos = func(pos, params)
    return newpos

addVirtualSiteToMol(rdmol, params)

Add coordinates for rdkit.Chem.Mol object

Parameters
rdkit.Chem.Mol

Mol object to which virtual sites are added

Return
rdkit.Chem.Mol

Mol object with virtual sites added

Examples

import jax.numpy as jnp import openmm.app as app from rdkit import Chem from dmff import Hamiltonian pdb = app.PDBFile("tests/data/chlorobenzene.pdb") mol = Chem.MolFromMolFile("tests/data/chlorobenzene.mol", removeHs=False) h = Hamiltonian("tests/data/cholorobenzene_vsite.xml") potObj = h.createPotential(pdb.topology, rdmol=mol) newmol = h.addVirtualSiteToMol(mol, h.paramtree)

Source code in dmff/api.py
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
def addVirtualSiteToMol(self, rdmol, params):
    """
    Add coordinates for rdkit.Chem.Mol object

    Parameters
    ----------
    rdmol: rdkit.Chem.Mol
        Mol object to which virtual sites are added
    params: dict
        Paramtree of hamiltonian, i.e. `dmff.Hamiltonian.paramtree`

    Return
    ------
    newmol: rdkit.Chem.Mol
        Mol object with virtual sites added

    Examples
    --------
    >>> import jax.numpy as jnp
    >>> import openmm.app as app
    >>> from rdkit import Chem
    >>> from dmff import Hamiltonian
    >>> pdb = app.PDBFile("tests/data/chlorobenzene.pdb")
    >>> mol = Chem.MolFromMolFile("tests/data/chlorobenzene.mol", removeHs=False)
    >>> h = Hamiltonian("tests/data/cholorobenzene_vsite.xml")
    >>> potObj = h.createPotential(pdb.topology, rdmol=mol)
    >>> newmol = h.addVirtualSiteToMol(mol, h.paramtree)
    """
    vsiteObj = self.getVirtualSiteObj()
    newmol = vsiteObj.addVirtualSiteToMol(
        rdmol,
        params['NonbondedForce']['vsite_types'],
        params['NonbondedForce']['vsite_distances']
    )
    return newmol

buildTopologyFromMol(rdmol, resname='MOL') staticmethod

Build openmm.app.Topology from rdkit.Chem.Mol Object

Parameters
rdkit.Chem.Mol

Mol object

str

Name of the added residue, default "MOL"

Return
openmm.app.Topology

Topology built based on the input rdkit Mol object

Source code in dmff/api.py
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
@staticmethod
def buildTopologyFromMol(rdmol, resname: str = "MOL") -> app.Topology:
    """
    Build openmm.app.Topology from rdkit.Chem.Mol Object

    Parameters
    ----------
    rdmol: rdkit.Chem.Mol
        Mol object
    resname: str
        Name of the added residue, default "MOL"

    Return
    ------
    top: `openmm.app.Topology`
        Topology built based on the input rdkit Mol object
    """
    from rdkit import Chem

    top = app.Topology()
    chain = top.addChain(0)
    res = top.addResidue(resname, chain, "1", "")

    atCount = {}
    addedAtoms = []
    for idx, atom in enumerate(rdmol.GetAtoms()):
        symb = atom.GetSymbol().upper()
        atCount.update({symb: atCount.get(symb, 0) + 1})
        ele = app.Element.getBySymbol(symb)
        atName = f'{symb}{atCount[symb]}'

        addedAtom = top.addAtom(atName, ele, res, str(idx+1))
        addedAtoms.append(addedAtom)

    bondTypeMap = {
        Chem.rdchem.BondType.SINGLE: app.Single,
        Chem.rdchem.BondType.DOUBLE: app.Double,
        Chem.rdchem.BondType.TRIPLE: app.Triple,
        Chem.rdchem.BondType.AROMATIC: app.Aromatic
    }
    for bond in rdmol.GetBonds():
        top.addBond(
            addedAtoms[bond.GetBeginAtomIdx()],
            addedAtoms[bond.GetEndAtomIdx()],
            type=bondTypeMap.get(bond.GetBondType(), None)
        )
    return top

createPotential(topology, nonbondedMethod=app.NoCutoff, nonbondedCutoff=1.0 * unit.nanometer, jaxForces=[], **args)

Create differentiable jax potential for given openmm.app.Topology object

Parameters
openmm.app.Topology

Input openmm topology

object=NoCutoff

The method to use for nonbonded interactions. Allowed values are NoCutoff, CutoffNonPeriodic, CutoffPeriodic, Ewald, PME, or LJPME.

distance=1*nanometer

The cutoff distance to use for nonbonded interactions

list of str

Specified forces to create. If set to [], will create all existing types of forces.

args Arbitrary parameters in openmm.app.ForceField.createSystem function

Return
dmff.api.Potential

Differentiable jax potential energy function

Source code in dmff/api.py
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
def createPotential(self,
                    topology,
                    nonbondedMethod=app.NoCutoff,
                    nonbondedCutoff=1.0 * unit.nanometer,
                    jaxForces=[],
                    **args):
    # load_constraints_from_system_if_needed
    # create potentials
    """
    Create differentiable jax potential for given openmm.app.Topology object

    Parameters
    ----------
    topology: openmm.app.Topology
        Input openmm topology
    nonbondedMethod: object=NoCutoff
        The method to use for nonbonded interactions. Allowed values are 
        NoCutoff, CutoffNonPeriodic, CutoffPeriodic, Ewald, PME, or LJPME.
    nonbondedCutoff : distance=1*nanometer
        The cutoff distance to use for nonbonded interactions
    jaxForces: list of str
        Specified forces to create. If set to [], will create all existing types of forces.
    args
        Arbitrary parameters in openmm.app.ForceField.createSystem function

    Return
    ------
    potObj: dmff.api.Potential
        Differentiable jax potential energy function
    """
    pseudo_data = app.ForceField._SystemData(topology)
    residueTemplates = {}
    templateForResidue = self._pseudo_ff._matchAllResiduesToTemplates(pseudo_data, topology, residueTemplates, False)
    self.templateNameForResidue = [i.name for i in templateForResidue]

    system = self.createSystem(
        topology,
        nonbondedMethod=nonbondedMethod,
        nonbondedCutoff=nonbondedCutoff,
        **args,
    )
    removeIdx = []
    jaxGens = [i.name for i in self._jaxGenerators]
    for nf, force in enumerate(system.getForces()):
        if (len(jaxForces) > 0
                and force.getName() in jaxForces) or (force.getName()
                                                      in jaxGens):
            removeIdx.append(nf)
    for nf in removeIdx[::-1]:
        system.removeForce(nf)

    potObj = Potential()
    potObj.addOmmSystem(system)
    for generator in self._jaxGenerators:
        if len(jaxForces) > 0 and generator.name not in jaxForces:
            continue
        try:
            potentialImpl = generator.getJaxPotential()
            potObj.addDmffPotential(generator.name, potentialImpl)
        except Exception as e:
            print(e)
            pass

        # virtual site
        try:
            addVsiteFunc = generator.getAddVsiteFunc()
            self.setAddVirtualSiteFunc(addVsiteFunc)
            vsiteObj = generator.getVsiteObj()
            self.setVirtualSiteObj(vsiteObj)
        except AttributeError as e:
            pass

        # covalent map
        try:
            cov_map = generator.covalent_map
            self.setCovalentMap(cov_map)
        except AttributeError as e:
            pass

        # topology matrix (for BCC usage)
        try:
            top_mat = generator.getTopologyMatrix()
            self.setTopologyMatrix(top_mat)
        except AttributeError as e:
            pass

    return potObj

getCovalentMap()

Get covalent map

Source code in dmff/api.py
236
237
238
239
240
241
242
243
def getCovalentMap(self) -> jnp.ndarray:
    """
    Get covalent map
    """
    if hasattr(self, "_cov_map"):
        return self._cov_map
    else:
        raise DMFFException("Covalent map is not set.")