An official website of the United States government

Here’s how you know

Here’s how you know

Search Site

Energy term restraining hydrogen-bonding geometries.
 
Documentation here is incomplete.
 
class HBSurf;
 
class HBPot_DAType has members
  typeStr  - string, an arbitrary name
  sel      - string, a selection specifying acceptor or donor
  nextSel  - string, a selection specifying neighboring atom
  num      - a self-index (into a/dTypeStrings)
 
const int aTypeBits = 8;
const int dTypeBits = 8;
const int deltaResidBits = 3;
 
struct HBPot_TypeInfo {
  unsigned char aType : aTypeBits;
  unsigned char dType : dTypeBits;
  unsigned char deltaResid : deltaResidBits;
};
 
struct HBPot_MapType {
  String typePair;
  String filename;
  int deltaResid;
  float_type scale;
  HBPot_TypeInfo id;
  HBSurf* surf;
};
 
struct HBPot_Geom {
  float_type r;
  float_type theta;
  float_type phi;
};
 
class HBPot : public Pot {
 
  AtomSel sel;
  CDSList<HBPot_DAType> aList;
  CDSList<HBPot_DAType> dList;
  CDSList<HBPot_MapType> mappings;
  
  CDSList< Pair<int,int> > hbonds_;
 
  class NeighborBin; // list of donors near each acceptor
  CDS::auto_ptr<NeighborBin> neighborBin;
 
  CDSVector<Vec3>       savePos;
 
  CDSMap<String,HBSurf*> surfMap;
 
public:
 
  HBPot(const String& instanceName,
        const CDSList<HBPot_DAType>& aList,
        const CDSList<HBPot_DAType>& dList,
        const CDSList<HBPot_MapType>& mappings,
              AtomSel selection     = AtomSel("not pseudo"),
        const String& thresholdStr  = "",
        const bool    verbose       = false
        );
 
  ~HBPot();
 
 
 
 
  donors()     - array of all possible proton donors, each represented by 
                HBPot_DAType objects.
  acceptors()  - array of all possible proton acceptors represented by 
                HBPot_DAType objects.
 
  getKernel()  - return internal structure
 
  hbonds() - return a sequence of (a,d) tuples representing identified
             hydrogen bonds. The values of a and d  are indices into the
             acceptors and donors member arrays, respectively. 
 
  HBPot_DA class
 
    Members:
  
      atom      - atom.Atom (donor or acceptor) involved in hydrogen bond
      nextAtom  - atom.Atom atom bonded to the atom member, used to define
                  hydrogen bonding geometry.
     typeNum
 
  void findAcceptorsDonors();
 
  HBPot_TypeInfo genPairType(const HBPot_DA& acceptor,
                             const HBPot_DA& donor   ,
                             const int       deltaResid) const;
  int getMap(const HBPot_DA& acceptor,
             const HBPot_DA& donor   ) const;
  String getMapString(const HBPot_DA& acceptor,
                   const HBPot_DA& donor   ) const {
   return mappings[ getMap(acceptor,donor) ].filename;
  }
  HBPot_MapType getMapping(const int index) const {
   // no boudns checking!
   return mappings[ index ];
  }
 
 
  bool movedTooMuch();
  void updateNeighborList();
  CDSList<CDSList<int> > neighbors;   // neighboring atoms to be considered
 
  ACCESSOR(thresholdStr,ThresholdStr,String);
  ACCESSOR(verbose,Verbose,bool);
  ACCESSOR(rMax,RMax,float_type); // usually set from HBSurf
  ACCESSOR(rOn,ROn,float_type); // distance where the cutoff function --> 1
  ACCESSOR(moveTol,MoveTol,float_type); // usually set from HBSurf
 
  AtomSel selection() { return sel; }
 
  String info() const;
 
  float_type calcEnergy();
  float_type calcEnergyAndDerivs(DerivList*);
 
  float_type rms() { return -1; }
 
  float_type energy(const HBPot_DA& acceptor,
                    const HBPot_DA& donor   ) const;
  void deriv(const HBPot_DA& acceptor,
             const HBPot_DA& donor   ,
                   DerivList& dlist);
 
  HBPot_Geom getGeom(const HBPot_DA& acceptor,
                     const HBPot_DA& donor   ) const;
 
 
  bool violated(const HBPot_DA& acceptor,
                const HBPot_DA& donor   ) const;
  float_type violations();
  int numRestraints() const { return -1; }
                          
};
 
class HBKernel:
 
  class members:
 
  CDSList<HBPot_MapType> mappings;
  CDSMap<String,HBSurf*> surfMap;
 
 
  thresholdStr(),setThresholdStr(val) - get/set the threshold string
 
  HBPot_TypeInfo genPairType(const HBPot_DA& acceptor,
                             const HBPot_DA& donor   ,
                             const int       deltaResid) const;
  int getMap(const HBPot_DA& acceptor,
             const HBPot_DA& donor   ) const;
  String getMapString(const HBPot_DA& acceptor,
                   const HBPot_DA& donor   ) const {
   return mappings[ getMap(acceptor,donor) ].filename;
  }
  HBPot_MapType getMapping(const int index) const {
   // no bounds checking!
   return mappings[ index ];
  }
 
  HBPot_Geom getGeom(const HBPot_DA& acceptor,
                     const HBPot_DA& donor   ) const;
 
  float_type energyMaybeDeriv(const HBPot_DA&  acceptor,
                              const HBPot_DA&  donor,
                                    DerivList* dListp) const;
 
  bool violated(const HBPot_DA& acceptor,
                const HBPot_DA& donor   ) const;
 
  void
  construct(const CDSList<HBPot_MapType>& mappings,
            const String& thresholdStr  = "");
 
  getNeighbors() - return a list of lists of integers which are indices into
                   the acceptors array, one for each donor
  
};
 
 
#endif /* __hbPot_hh__ */
 
 
 
# This file was automatically generated by SWIG (http://www.swig.org).
# Version 4.0.2
#
# Do not make changes to this file unless you know what you are doing--modify
# the SWIG interface file instead.