Package schrodinger :: Package application :: Package matsci :: Module clusterstruct :: Class Dimer
[hide private]
[frames] | no frames]

Class Dimer

object --+
         |
        Dimer

Class to hold and process a pair of neighboring molecules.

Instance Methods [hide private]
 
__init__(self, stindex, mol1, mol2, neighbor_info, pbc=None)
Create a Dimer object
 
evaluateSpeciesCriterion(self, crit_species, crit, species)
Check whether this dimer meets the species criterion - sets the meets_species_criterion property.
schrodinger.structure.Structure
getPairStructure(self, struct)
Create the dimer structure
schrodinger.structure.Structure
getClusterStructure(self, struct, cell=None, distance=None)
Get a structure that is the dimer surrounded by all nearest neighbor molecules.
schrodinger.structure.Structure
getPeriodicPairStructure(self, struct)
Create a dimer structure for a pair of molecules that takes into account the periodic boundary condition.
schrodinger.structure.Structure
getNonPeriodicPairStructure(self, struct)
Create a dimer structure for a pair of molecules in a non-periodic system

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, stindex, mol1, mol2, neighbor_info, pbc=None)
(Constructor)

 

Create a Dimer object

Parameters:
  • stindex (int) - The index of the structure this dimer comes from
  • mol1 (int) - The molecule number in the structure of the first molecule in this dimer
  • mol2 (int) - The molecule number in the structure of the second molecule in this dimer
  • neighbor_info (Neighbor) - The Neighbor information for this dimer
  • pbc (schrodinger.infra.structure.PBC) - The PBC object to use for this dimer, if any
Overrides: object.__init__

evaluateSpeciesCriterion(self, crit_species, crit, species)

 

Check whether this dimer meets the species criterion - sets the meets_species_criterion property.

Parameters:
  • crit_species (SpeciesData or None) - The species the criterion applies to. Use None if there are no criteria - the dimer will be marked as meeting all criteria
  • crit (str) - The criterion - should be one of the constants NO_MOLS, ONE_ONLY_MOL, AT_LEAST_ONE_MOL, TWO_MOLS
  • species (dict) - The dictionary containing information for all species. Keys are unique SMILES strings for a species, values are SpeciesData for the species with that SMILES string.

getPairStructure(self, struct)

 

Create the dimer structure

Parameters:
Returns: schrodinger.structure.Structure
The structure object for the dimer

getClusterStructure(self, struct, cell=None, distance=None)

 

Get a structure that is the dimer surrounded by all nearest neighbor molecules. The dimer and all molecules are positioned at their nearest neighbor images to the original position of the first molecule in the dimer.

Parameters:
  • struct (schrodinger.structure.Structure) - The structure containing this Dimer and all neighbor molecules
  • cell (schrodinger.infra.structure.DistanceCell) - The DistanceCell to use when finding nearest neighbors. If not given, will be calculated based on struct and distance. Either cell or distance must be given.
  • distance (float) - The distance to use when creating a new distance cell if needed. Either cell or distance must be given.
Returns: schrodinger.structure.Structure
The structure of the dimer with nearest neighbor molecules. The dimer molecules appear first in the cluster.

getPeriodicPairStructure(self, struct)

 

Create a dimer structure for a pair of molecules that takes into account the periodic boundary condition.

If | represents a cell boundary, and .... represents some long distance, imagine two molecules X and Y on opposite sides of the cell.

Y|X....Y|X

We need to extract coordinates for Y that represent the Y|X case, not the X....Y case.

Parameters:
Returns: schrodinger.structure.Structure
The structure object for the dimer

getNonPeriodicPairStructure(self, struct)

 

Create a dimer structure for a pair of molecules in a non-periodic system

Parameters:
Returns: schrodinger.structure.Structure
The structure object for the dimer