avePot |
index |
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.
Classes | ||||||||||
|
Functions | ||
|
Data | ||
env = environ({'ARCH': 'Linux_x86_64', 'MWWM': 'allwm'...ib/Linux_x86_64::/usr/local/lib:/usr/local/lib'}) |