Force is a metatype, in that Tissue Forge has lots of different instances of force functions, that have different attributes, but only have one base type. More...

#include <tfForce.h>

Inheritance diagram for TissueForge::Force:

[legend]

Collaboration diagram for TissueForge::Force:

[legend]

Public Member Functions
virtual bool	isCustom ()
	Tests whether this object is a custom force type.

HRESULT	bind_species (struct ParticleType *a_type, const std::string &coupling_symbol)
	Bind a force to a species.

Force &	operator+ (const Force &rhs)

virtual std::string	toString ()
	Get a JSON string representation.

Static Public Member Functions
static Berendsen *	berendsen_tstat (const FPTYPE &tau)
	Creates a Berendsen thermostat.

static Gaussian *	random (const FPTYPE &std, const FPTYPE &mean, const FPTYPE &duration=0.01)
	Creates a random force.

static Friction *	friction (const FPTYPE &coef)
	Creates a friction force.

static Force *	fromString (const std::string &str)
	Create from a JSON string representation.

Public Attributes
FORCE_TYPE	type = FORCE_FORCE

Force_EvalFcn	func

int	stateVectorIndex = -1

Detailed Description

Force is a metatype, in that Tissue Forge has lots of different instances of force functions, that have different attributes, but only have one base type.

Forces are one of the fundamental processes in Tissue Forge that cause objects to move.

Member Function Documentation

◆ berendsen_tstat()

static Berendsen * TissueForge::Force::berendsen_tstat ( const FPTYPE & tau )

static

Creates a Berendsen thermostat.

The thermostat uses the target temperature $ T_0 $ from the object to which it is bound. The Berendsen thermostat effectively re-scales the velocities of an object in order to make the temperature of that family of objects match a specified temperature.

The Berendsen thermostat force has the function form:

$\frac{\mathbf{p}}{\tau_T} \left(\frac{T_0}{T} - 1 \right),$

where $\mathbf{p}$ is the momentum, $ T $ is the measured temperature of a family of particles, $ T_0 $ is the control temperature, and $\tau_T$ is the coupling constant. The coupling constant is a measure of the time scale on which the thermostat operates, and has units of time. Smaller values of $\tau_T$ result in a faster acting thermostat, and larger values result in a slower acting thermostat.