CompuCell3D::DefaultAcceptanceFunction Class Reference

#include <DefaultAcceptanceFunction.h>

Inheritance diagram for CompuCell3D::DefaultAcceptanceFunction:

Collaboration diagram for CompuCell3D::DefaultAcceptanceFunction:

List of all members.

Public Member Functions

DefaultAcceptanceFunction (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

Detailed Description

The default Boltzman acceptance function.

Definition at line 35 of file DefaultAcceptanceFunction.h.

Constructor & Destructor Documentation

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

Definition at line 40 of file DefaultAcceptanceFunction.h.

Member Function Documentation

virtual void CompuCell3D::DefaultAcceptanceFunction::setOffset ( double _offset ) [inline, virtual]

Implements CompuCell3D::AcceptanceFunction.

Definition at line 41 of file DefaultAcceptanceFunction.h.

References offset.

virtual void CompuCell3D::DefaultAcceptanceFunction::setK ( double _k ) [inline, virtual]

Implements CompuCell3D::AcceptanceFunction.

Definition at line 42 of file DefaultAcceptanceFunction.h.

References k.

double CompuCell3D::DefaultAcceptanceFunction::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 43 of file DefaultAcceptanceFunction.h.

References k, and offset.

Member Data Documentation

double CompuCell3D::DefaultAcceptanceFunction::k [private]

Definition at line 36 of file DefaultAcceptanceFunction.h.

Referenced by accept(), and setK().

double CompuCell3D::DefaultAcceptanceFunction::offset [private]

Definition at line 37 of file DefaultAcceptanceFunction.h.

Referenced by accept(), and setOffset().

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

CompuCell/DOXYGEN/core/CompuCell3D/Potts3D/DefaultAcceptanceFunction.h


Public Member Functions
	DefaultAcceptanceFunction (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