CompuCell3D::FirstOrderExpansionAcceptanceFunction Class Reference

#include <FirstOrderExpansionAcceptanceFunction.h>

Inheritance diagram for CompuCell3D::FirstOrderExpansionAcceptanceFunction:

[legend]

Collaboration diagram for CompuCell3D::FirstOrderExpansionAcceptanceFunction:

[legend]

List of all members.

Public Member Functions
	FirstOrderExpansionAcceptanceFunction (const double _k=1.0, const double _offset=0.0)
virtual void	setOffset (double _offset)
virtual void	setK (double _k)
double	accept (const double temp, const double change)
Private Attributes
double	k
double	offset
double	firstOrderTerm

---

Detailed Description

The default Boltzman acceptance function.

Definition at line 36 of file FirstOrderExpansionAcceptanceFunction.h.

---

Constructor & Destructor Documentation

CompuCell3D::FirstOrderExpansionAcceptanceFunction::FirstOrderExpansionAcceptanceFunction	(	const double	_k = 1.0,
		const double	_offset = 0.0
	)			[inline]

Definition at line 41 of file FirstOrderExpansionAcceptanceFunction.h.

---

Member Function Documentation

virtual void CompuCell3D::FirstOrderExpansionAcceptanceFunction::setOffset

(

double

_offset

)

[inline, virtual]

Implements CompuCell3D::AcceptanceFunction.

Definition at line 42 of file FirstOrderExpansionAcceptanceFunction.h.

References offset.

virtual void CompuCell3D::FirstOrderExpansionAcceptanceFunction::setK

(

double

_k

)

[inline, virtual]

Implements CompuCell3D::AcceptanceFunction.

Definition at line 43 of file FirstOrderExpansionAcceptanceFunction.h.

References k.

double CompuCell3D::FirstOrderExpansionAcceptanceFunction::accept	(	const double	temp,
		const double	change
	)			[inline, 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).

Implements CompuCell3D::AcceptanceFunction.

Definition at line 44 of file FirstOrderExpansionAcceptanceFunction.h.

References firstOrderTerm, k, and offset.

---

Member Data Documentation

double CompuCell3D::FirstOrderExpansionAcceptanceFunction::k [private]

Definition at line 37 of file FirstOrderExpansionAcceptanceFunction.h.

Referenced by accept(), and setK().

double CompuCell3D::FirstOrderExpansionAcceptanceFunction::offset [private]

Definition at line 38 of file FirstOrderExpansionAcceptanceFunction.h.

Referenced by accept(), and setOffset().

double CompuCell3D::FirstOrderExpansionAcceptanceFunction::firstOrderTerm [private]

Definition at line 39 of file FirstOrderExpansionAcceptanceFunction.h.

Referenced by accept().

---

The documentation for this class was generated from the following file:

• CompuCell/DOXYGEN/core/CompuCell3D/Potts3D/FirstOrderExpansionAcceptanceFunction.h