CompuCell3D::AcceptanceFunction Class Reference
#include <AcceptanceFunction.h>
Public Member Functions | |
| virtual double | accept (const double temp, const double change)=0 |
| virtual void | setOffset (double _offset)=0 |
| virtual void | setK (double _k)=0 |
Detailed Description
The Potts3D acceptance function interface.See DefaultAcceptanceFunction.
Definition at line 33 of file AcceptanceFunction.h.
Member Function Documentation
| virtual double CompuCell3D::AcceptanceFunction::accept | ( | const double | temp, | |
| const double | change | |||
| ) | [pure virtual] |
Calculates the probability that a change should be accepted based on the current temperature and the energy cost.
- Parameters:
-
temp The current temperature. change The change energy.
- Returns:
- The probability that the change should be accepted as a number in the range [0,1).
Implemented in CompuCell3D::DefaultAcceptanceFunction, and CompuCell3D::FirstOrderExpansionAcceptanceFunction.
Referenced by CompuCell3D::Potts3D::metropolisBoundaryWalker(), CompuCell3D::Potts3D::metropolisFast(), and CompuCell3D::Potts3D::metropolisList().
| virtual void CompuCell3D::AcceptanceFunction::setOffset | ( | double | _offset | ) | [pure virtual] |
Implemented in CompuCell3D::DefaultAcceptanceFunction, and CompuCell3D::FirstOrderExpansionAcceptanceFunction.
Referenced by CompuCell3D::Simulator::initializePottsCC3D(), and CompuCell3D::Potts3D::update().
| virtual void CompuCell3D::AcceptanceFunction::setK | ( | double | _k | ) | [pure virtual] |
Implemented in CompuCell3D::DefaultAcceptanceFunction, and CompuCell3D::FirstOrderExpansionAcceptanceFunction.
Referenced by CompuCell3D::Simulator::initializePottsCC3D(), and CompuCell3D::Potts3D::update().
The documentation for this class was generated from the following file:
- CompuCell/DOXYGEN/core/CompuCell3D/Potts3D/AcceptanceFunction.h
