ensemble average a potential term
 
Used with an ensembleSimulation.EnsembleSimulation for an energy
term which is a simple ensemble average of an energy term. i.e. the
potential is 
 
      E = sum_i w_i E_i
 
where the sum is over all members of an ensemble, w_i is the weight
for ensemble member i, and E_i is the averaged energy.
 
Constructors:
 
   AvePot( otherPotentialName, args )
 
otherPotentialName could be e.g. xplorPot.XplorPot, noePot.NOEPot, etc. args are the arguments which these other terms
take. 
 
*or*
 
   AvePot( pot )
 
where pot is a previously defined potential term.
 
*or*
 
   AvePot( callable )
 
where callable is a function which creates a potential term. Before the
function is called, the current Simulation is replaced with the current
EnsembleSimulation's local member.
 
Methods:
 
  calcEnergy()
  calcEnergyAndDerivs()
 
  potName()
  instanceName()
 
  subPot() - return pot.Pot object which is averaged over.
 
  ensWeigth(index) - return the ensemble weight associated with the
                     specified member.
  setEnsWeights(vals) - use the specified ensemble weights instead of those
                        in the underlying EnsembleSimulation.
 
Accessors (read/write)
  scale - scale factor for the term. Overall scale is product of this value
          and subPot->scale().
  useSimEnsWeight - whether to use the ensemble wieghts set with setEnsWeights
                    or to use those of the underlying EnsembleSimulation.
 
Additionally, all of the methods of the underlying class can be accessed as if
the AvePot object was actually the sub-potential type.
 
 
 
# 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 AvePot EnsemblePot AvePot_LetterClass Modified ModifiedBase VarEnsWeights rc_EnsemblePot   class AvePot_LetterClass(EnsemblePot)     AvePot_LetterClass(*args, **kwargs)       Method resolution order: AvePot_LetterClass EnsemblePot builtins.object Methods defined here: __init__(self, *args, **kwargs) Initialize self.  See help(type(self)) for accurate signature. __repr__ = _swig_repr(self) energyMaybeDerivs0(self, *args, **kwargs) -> 'float_type' energyMaybeDerivs1(self, *args, **kwargs) -> 'float_type' numRestraints(self, *args, **kwargs) -> 'int' pyXplorHelp(self, *args, **kwargs) -> 'String' rcPot(self, *args, **kwargs) -> 'rc_Pot' rms(self, *args, **kwargs) -> 'float_type' setThreshold(self, *args, **kwargs) -> 'void' subPot(self) threshold(self, *args, **kwargs) -> 'float_type' violations(self, *args, **kwargs) -> 'float_type' Static methods defined here: __swig_destroy__ = delete_AvePot_LetterClass(...) Data descriptors defined here: thisown   The membership flag Methods inherited from EnsemblePot: addEnsWeights(self, *args, **kwargs) -> 'void' calcEnergy(self, *args, **kwargs) -> 'float_type' calcEnergyAndDerivs(self, *args, **kwargs) -> 'float_type' calcWDerivs(self, *args, **kwargs) -> 'bool const' clearEnsWeights(self, *args, **kwargs) -> 'void' energyMaybeDerivs2(self, *args, **kwargs) -> 'float_type' energyMaybeDerivs3(self, *args, **kwargs) -> 'float_type' energyMaybeDerivs4(self, *args, **kwargs) -> 'float_type' energyMaybeDerivsPost(self, *args, **kwargs) -> 'float_type' energyMaybeDerivsPre(self, *args, **kwargs) -> 'float_type' ensWeight(self, *args, **kwargs) -> 'float_type' ensWeights(self, *args, **kwargs) -> 'CDSList< float_type >' ensWeightsInfo(self, *args, **kwargs) -> 'String' getEnsWeights(self, *args, **kwargs) -> 'CDSList< VarEnsWeights > &' setCalcWDerivs(self, *args, **kwargs) -> 'void' setEnsWeights(self, *args, **kwargs) -> 'void' setUseSimEnsWeights(self, *args, **kwargs) -> 'void' simulation(self, *args) -> 'EnsembleSimulationBase const *' updateEnsWeights(self, *args, **kwargs) -> 'void' useSimEnsWeights(self, *args, **kwargs) -> 'bool const' Data descriptors inherited from EnsemblePot: __dict__   dictionary for instance variables (if defined) __weakref__   list of weak references to the object (if defined)   class EnsemblePot(builtins.object)     EnsemblePot(*args, **kwargs)       Methods defined here: __init__(self, *args, **kwargs) Initialize self.  See help(type(self)) for accurate signature. __repr__ = _swig_repr(self) addEnsWeights(self, *args, **kwargs) -> 'void' calcEnergy(self, *args, **kwargs) -> 'float_type' calcEnergyAndDerivs(self, *args, **kwargs) -> 'float_type' calcWDerivs(self, *args, **kwargs) -> 'bool const' clearEnsWeights(self, *args, **kwargs) -> 'void' energyMaybeDerivs0(self, *args, **kwargs) -> 'float_type' energyMaybeDerivs1(self, *args, **kwargs) -> 'float_type' energyMaybeDerivs2(self, *args, **kwargs) -> 'float_type' energyMaybeDerivs3(self, *args, **kwargs) -> 'float_type' energyMaybeDerivs4(self, *args, **kwargs) -> 'float_type' energyMaybeDerivsPost(self, *args, **kwargs) -> 'float_type' energyMaybeDerivsPre(self, *args, **kwargs) -> 'float_type' ensWeight(self, *args, **kwargs) -> 'float_type' ensWeights(self, *args, **kwargs) -> 'CDSList< float_type >' ensWeightsInfo(self, *args, **kwargs) -> 'String' getEnsWeights(self, *args, **kwargs) -> 'CDSList< VarEnsWeights > &' setCalcWDerivs(self, *args, **kwargs) -> 'void' setEnsWeights(self, *args, **kwargs) -> 'void' setUseSimEnsWeights(self, *args, **kwargs) -> 'void' simulation(self, *args) -> 'EnsembleSimulationBase const *' updateEnsWeights(self, *args, **kwargs) -> 'void' useSimEnsWeights(self, *args, **kwargs) -> 'bool const' Static methods defined here: __swig_destroy__ = delete_EnsemblePot(...) Data descriptors defined here: __dict__   dictionary for instance variables (if defined) __weakref__   list of weak references to the object (if defined) thisown   The membership flag   class Modified(builtins.object)     Modified(*args, **kwargs)       Methods defined here: __call__(self, *args, **kwargs) -> 'int' Call self as a function. __init__(self, *args, **kwargs) Initialize self.  See help(type(self)) for accurate signature. __repr__ = _swig_repr(self) asString(self, *args, **kwargs) -> 'String' assertClear(self, *args, **kwargs) -> 'void' clear(self, *args, **kwargs) -> 'void' set(self, *args, **kwargs) -> 'void' update(self, *args, **kwargs) -> 'void' value(self, *args, **kwargs) -> 'int' Static methods defined here: __swig_destroy__ = delete_Modified(...) Data descriptors defined here: __dict__   dictionary for instance variables (if defined) __weakref__   list of weak references to the object (if defined) thisown   The membership flag Data and other attributes defined here: MOD_SELF = 1 MOD_SIMULATION = 2   class ModifiedBase(builtins.object)     ModifiedBase(*args, **kwargs)       Methods defined here: __init__(self, *args, **kwargs) Initialize self.  See help(type(self)) for accurate signature. __repr__ = _swig_repr(self) registerTo(self, *args, **kwargs) -> 'void' unRegister(self, *args, **kwargs) -> 'void' updateValues(self, *args, **kwargs) -> 'void' Static methods defined here: __swig_destroy__ = delete_ModifiedBase(...) Data descriptors defined here: __dict__   dictionary for instance variables (if defined) __weakref__   list of weak references to the object (if defined) modified   registeredSimulations   thisown   The membership flag   class VarEnsWeights(builtins.object)     VarEnsWeights(*args, **kwargs)       Methods defined here: __init__(self, *args, **kwargs) Initialize self.  See help(type(self)) for accurate signature. __repr__ = _swig_repr(self) Static methods defined here: __swig_destroy__ = delete_VarEnsWeights(...) Data descriptors defined here: __dict__   dictionary for instance variables (if defined) __weakref__   list of weak references to the object (if defined) ensWeights   mult   thisown   The membership flag   class rc_EnsemblePot(builtins.object)     rc_EnsemblePot(*args, **kwargs)       Methods defined here: __init__(self, *args, **kwargs) Initialize self.  See help(type(self)) for accurate signature. __repr__ = _swig_repr(self) Static methods defined here: __swig_destroy__ = delete_rc_EnsemblePot(...) Data descriptors defined here: __dict__   dictionary for instance variables (if defined) __weakref__   list of weak references to the object (if defined) thisown   The membership flag   realAvePot = class AvePot(builtins.object)     realAvePot(*args)       Methods defined here: __deref__(self, *args, **kwargs) -> 'AvePot *' __init__(self, *args) __oldinit0__ = __init__(self, *args) __oldinit__ = __init__(self, *args, **kwargs) __ref__(self, *args, **kwargs) -> 'AvePot &' __repr__ = _swig_repr(self) addEnsWeights(self, *args, **kwargs) -> 'void' calcEnergy(self, *args, **kwargs) -> 'float_type' calcEnergyAndDerivs(self, *args, **kwargs) -> 'float_type' calcWDerivs(self, *args, **kwargs) -> 'bool const' clearEnsWeights(self, *args, **kwargs) -> 'void' decrRefCnt(self, *args, **kwargs) -> 'void' energyMaybeDerivs0(self, *args, **kwargs) -> 'float_type' energyMaybeDerivs1(self, *args, **kwargs) -> 'float_type' energyMaybeDerivs2(self, *args, **kwargs) -> 'float_type' energyMaybeDerivs3(self, *args, **kwargs) -> 'float_type' energyMaybeDerivs4(self, *args, **kwargs) -> 'float_type' energyMaybeDerivsPost(self, *args, **kwargs) -> 'float_type' energyMaybeDerivsPre(self, *args, **kwargs) -> 'float_type' ensWeight(self, *args, **kwargs) -> 'float_type' ensWeights(self, *args, **kwargs) -> 'CDSList< float_type >' ensWeightsInfo(self, *args, **kwargs) -> 'String' getEnsWeights(self, *args, **kwargs) -> 'CDSList< VarEnsWeights > &' incrRefCnt(self, *args, **kwargs) -> 'void' instanceData(self, *args, **kwargs) -> 'PyObject *' instanceName(self, *args, **kwargs) -> 'char const *' numRestraints(self, *args, **kwargs) -> 'int' potName(self, *args, **kwargs) -> 'char const *' pyXplorHelp(self, *args, **kwargs) -> 'String' rcPot(self, *args, **kwargs) -> 'rc_Pot' refCnt(self, *args, **kwargs) -> 'int' registerInstanceData(self, *args, **kwargs) -> 'void' registerTo(self, *args, **kwargs) -> 'void' resetInstanceName(self, *args, **kwargs) -> 'void' resetPotName(self, *args, **kwargs) -> 'void' rms(self, *args, **kwargs) -> 'float_type' scale(self, *args, **kwargs) -> 'float_type const' setCalcWDerivs(self, *args, **kwargs) -> 'void' setEnsWeights(self, *args, **kwargs) -> 'void' setScale(self, *args, **kwargs) -> 'void' setThreshold(self, *args, **kwargs) -> 'void' setUseSimEnsWeights(self, *args, **kwargs) -> 'void' simulation(self, *args) -> 'EnsembleSimulationBase const *' subPot(self) threshold(self, *args, **kwargs) -> 'float_type' unRegister(self, *args, **kwargs) -> 'void' updateDelta(self, *args, **kwargs) -> 'void' updateEnsWeights(self, *args, **kwargs) -> 'void' updateValues(self, *args, **kwargs) -> 'void' useSimEnsWeights(self, *args, **kwargs) -> 'bool const' violations(self, *args, **kwargs) -> 'float_type' Static methods defined here: __swig_destroy__ = delete_AvePot(...) Data descriptors defined here: __dict__   dictionary for instance variables (if defined) __weakref__   list of weak references to the object (if defined) instanceDataCleanup   instanceDataCreate   instanceData_   modified   registeredSimulations   thisown   The membership flag

Functions
		AvePot(*args) pyXplorHelp(*args) -> 'String'