Python: module derivList
 
derivList
index

container for atomic derivative information.
 
An object which contains derivatives with respect to atomic position. 
 
Notes on derivLists of EnsembleSimulations:
   they share their derivList w/ their member() and subSim()
   while other EnsembleMemberSimulations have their derivLists initialized, 
   these derivLists are generally not used.
 
constructor:
  DerivList()
 
Methods
 
  
  init(simulation) - allocate and zero array corresponding to the specified
                     simulation.Simulation.
 
  clear()          - zero out all existing arrays.
 
  get(simulation)  - returns a cdsVector.CDSVector_Vec3 corresponding
                     to the derivatives of coordinates in the specified
                     simulation.Simulation.
 
  isInitialized(simulation) - returns bool indicating whether or not init()
                              has been called on this simulation
 
  simulations()    - return a list of Simulations which have nonzero entries
                     in this DerivList.
 
  sync()           - calls syncDerivs() for each Simulation which has a
                     gradient entry in this DerivList. For EnsembleSimulations,
                     SymSimulations, TagSimulations and EnsSymSimulations,
                     this function must be called to get correct gradients.
                     Calling an energy (Pot) term's calcEnergyAndDerivs()
                     will accumulate gradient information into an array
                     associated with a Simulation associated with that term.
                     The IVM only manipulates XplorSimulations and
                     EnsembleSimulations, and the other Simulations are coaxed 
                     to appropriately propagate their gradient info to
                     the dependent Simulations using these methods.
 
  Can be indexed by Simulation, in which case the (assignable) Vec3 array for
  that Simulation (determined using Simulation.lookupID()) is returned.
 
  Can also be index by Atom, returning the (assignable) Vec3 for a particular
  atom.
 
 
 
 
# 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.

 
Classes
       
builtins.object
DerivList

 
class DerivList(builtins.object)
    DerivList(*args, **kwargs)
 

 
  Methods defined here:
__getitem__(self, *args) -> 'Vec3'
__init__(self, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
__setitem__(self, *args) -> 'void'
clear(self, *args, **kwargs) -> 'void'
get(self, *args, **kwargs) -> 'CDSVector< Vec3 > &'
init(self, *args, **kwargs) -> 'void'
isInitialized(self, *args, **kwargs) -> 'bool'
pyXplorHelp(self, *args, **kwargs) -> 'String'
simulations(self, *args, **kwargs) -> 'CDSList< Simulation * >'
sync(self, *args, **kwargs) -> 'void'

Static methods defined here:
__swig_destroy__ = delete_DerivList(...)

Data descriptors defined here:
__dict__

 
dictionary for instance variables (if defined)
__weakref__

 
list of weak references to the object (if defined)
derivList

 
synced

 
thisown

 
The membership flag

 
Functions
       
pyXplorHelp(*args) -> 'String'