#include "tf_port_c.h"

Include dependency graph for tfCForce.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	tfFORCE_TYPEHandle
	Handle to a FORCE_TYPE instance. More...

struct	tfUserForceFuncTypeHandle
	Handle to a UserForceFuncType instance. More...

struct	tfForceHandle
	Handle to a Force instance. More...

struct	tfForceSumHandle
	Handle to a ForceSum instance. More...

struct	tfCustomForceHandle
	Handle to a CustomForce instance. More...

struct	tfBerendsenHandle
	Handle to a Berendsen instance. More...

struct	tfGaussianHandle
	Handle to a Gaussian instance. More...

struct	tfFrictionHandle
	Handle to a Friction instance. More...

Typedefs
typedef void(*	tfUserForceFuncTypeHandleFcn) (struct tfCustomForceHandle , tfFloatP_t )

Functions
HRESULT	tfFORCE_TYPE_init (struct tfFORCE_TYPEHandle *handle)
	Initialize an instance.

HRESULT	tfForce_EvalFcn_init (struct tfUserForceFuncTypeHandle handle, tfUserForceFuncTypeHandleFcn fcn)
	Initialize an instance.

HRESULT	tfForce_EvalFcn_destroy (struct tfUserForceFuncTypeHandle *handle)
	Destroy an instance.

HRESULT	tfForce_getType (struct tfForceHandle handle, unsigned int te)
	Get the force type.

HRESULT	tfForce_bind_species (struct tfForceHandle handle, struct tfParticleTypeHandle a_type, const char *coupling_symbol)
	Bind a force to a species.

HRESULT	tfForce_toString (struct tfForceHandle handle, char str, unsigned int numChars)
	Get a JSON string representation.

HRESULT	tfForce_fromString (struct tfForceHandle handle, const char str)
	Create from a JSON string representation.

HRESULT	tfForce_destroy (struct tfForceHandle *handle)
	Destroy an instance.

HRESULT	tfForceSum_checkType (struct tfForceHandle handle, bool isType)
	Check whether a base handle is of this force type.

HRESULT	tfForceSum_toBase (struct tfForceSumHandle handle, struct tfForceHandle baseHandle)
	Cast to base force.

HRESULT	tfForceSum_fromBase (struct tfForceHandle baseHandle, struct tfForceSumHandle handle)
	Cast from base force. Fails if instance is not of this type.

HRESULT	tfForceSum_getConstituents (struct tfForceSumHandle handle, struct tfForceHandle f1, struct tfForceHandle *f2)
	Get the constituent forces.

HRESULT	tfCustomForce_init (struct tfCustomForceHandle handle, struct tfUserForceFuncTypeHandle func, tfFloatP_t period)
	Create a custom force with a force function.

HRESULT	tfCustomForce_checkType (struct tfForceHandle handle, bool isType)
	Check whether a base handle is of this force type.

HRESULT	tfCustomForce_toBase (struct tfCustomForceHandle handle, struct tfForceHandle baseHandle)
	Cast to base force.

HRESULT	tfCustomForce_fromBase (struct tfForceHandle baseHandle, struct tfCustomForceHandle handle)
	Cast from base force. Fails if instance is not of this type.

HRESULT	tfCustomForce_getPeriod (struct tfCustomForceHandle handle, tfFloatP_t period)
	Get force period.

HRESULT	tfCustomForce_setPeriod (struct tfCustomForceHandle *handle, tfFloatP_t period)
	Set force period.

HRESULT	tfCustomForce_setFunction (struct tfCustomForceHandle handle, struct tfUserForceFuncTypeHandle fcn)
	Set force function.

HRESULT	tfCustomForce_getValue (struct tfCustomForceHandle handle, tfFloatP_t *force)
	Get current force value.

HRESULT	tfCustomForce_setValue (struct tfCustomForceHandle handle, tfFloatP_t force)
	Set current force value.

HRESULT	tfCustomForce_getLastUpdate (struct tfCustomForceHandle handle, tfFloatP_t lastUpdate)
	Get time of last force update.

HRESULT	tfBerendsen_init (struct tfBerendsenHandle *handle, tfFloatP_t tau)
	Creates a Berendsen thermostat.

HRESULT	tfBerendsen_checkType (struct tfForceHandle handle, bool isType)
	Check whether a base handle is of this force type.

HRESULT	tfBerendsen_toBase (struct tfBerendsenHandle handle, struct tfForceHandle baseHandle)
	Cast to base force.

HRESULT	tfBerendsen_fromBase (struct tfForceHandle baseHandle, struct tfBerendsenHandle handle)
	Cast from base force. Fails if instance is not of this type.

HRESULT	tfBerendsen_getTimeConstant (struct tfBerendsenHandle handle, tfFloatP_t tau)
	Get the time constant.

HRESULT	tfBerendsen_setTimeConstant (struct tfBerendsenHandle *handle, tfFloatP_t tau)
	Set the time constant.

HRESULT	tfGaussian_init (struct tfGaussianHandle *handle, tfFloatP_t std, tfFloatP_t mean, tfFloatP_t duration)
	Creates a random force.

HRESULT	tfGaussian_checkType (struct tfForceHandle handle, bool isType)
	Check whether a base handle is of this force type.

HRESULT	tfGaussian_toBase (struct tfGaussianHandle handle, struct tfForceHandle baseHandle)
	Cast to base force.

HRESULT	tfGaussian_fromBase (struct tfForceHandle baseHandle, struct tfGaussianHandle handle)
	Cast from base force. Fails if instance is not of this type.

HRESULT	tfGaussian_getStd (struct tfGaussianHandle handle, tfFloatP_t std)
	Get the magnitude standard deviation.

HRESULT	tfGaussian_setStd (struct tfGaussianHandle *handle, tfFloatP_t std)
	Set the magnitude standard deviation.

HRESULT	tfGaussian_getMean (struct tfGaussianHandle handle, tfFloatP_t mean)
	Get the magnitude mean.

HRESULT	tfGaussian_setMean (struct tfGaussianHandle *handle, tfFloatP_t mean)
	Set the magnitude mean.

HRESULT	tfGaussian_getDuration (struct tfGaussianHandle handle, tfFloatP_t duration)
	Get the magnitude duration.

HRESULT	tfGaussian_setDuration (struct tfGaussianHandle *handle, tfFloatP_t duration)
	Set the magnitude duration.

HRESULT	tfFriction_init (struct tfFrictionHandle *handle, tfFloatP_t coeff)
	Creates a friction force.

HRESULT	tfFriction_checkType (struct tfForceHandle handle, bool isType)
	Check whether a base handle is of this force type.

HRESULT	tfFriction_toBase (struct tfFrictionHandle handle, struct tfForceHandle baseHandle)
	Cast to base force.

HRESULT	tfFriction_fromBase (struct tfForceHandle baseHandle, struct tfFrictionHandle handle)
	Cast from base force. Fails if instance is not of this type.

HRESULT	tfFriction_getCoef (struct tfFrictionHandle handle, tfFloatP_t coef)
	Get the friction coefficient.

HRESULT	tfFriction_setCoef (struct tfFrictionHandle *handle, tfFloatP_t coef)
	Set the friction coefficient.

HRESULT	tfForce_add (struct tfForceHandle f1, struct tfForceHandle f2, struct tfForceSumHandle *fSum)
	Add two forces.

Function Documentation

◆ tfBerendsen_checkType()

HRESULT tfBerendsen_checkType	(	struct tfForceHandle *	handle,
		bool *	isType )

Check whether a base handle is of this force type.

Parameters

handle	populated handle
isType	flag signifying whether the handle is of this force type

Returns: S_OK on success

◆ tfBerendsen_fromBase()

HRESULT tfBerendsen_fromBase	(	struct tfForceHandle *	baseHandle,
		struct tfBerendsenHandle *	handle )

Cast from base force. Fails if instance is not of this type.

Parameters

baseHandle	populated handle
handle	handle to populate

Returns: S_OK on success

◆ tfBerendsen_getTimeConstant()

HRESULT tfBerendsen_getTimeConstant	(	struct tfBerendsenHandle *	handle,
		tfFloatP_t *	tau )

Get the time constant.

Parameters

handle	populated handle
tau	time constant

Returns: S_OK on success

◆ tfBerendsen_init()

HRESULT tfBerendsen_init	(	struct tfBerendsenHandle *	handle,
		tfFloatP_t	tau )

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.

Parameters

handle	handle to populate
tau	time constant that determines how rapidly the thermostat effects the system.

Returns: S_OK on success

◆ tfBerendsen_setTimeConstant()

HRESULT tfBerendsen_setTimeConstant	(	struct tfBerendsenHandle *	handle,
		tfFloatP_t	tau )

Set the time constant.

Parameters

handle	populated handle
tau	time constant

Returns: S_OK on success

◆ tfBerendsen_toBase()

HRESULT tfBerendsen_toBase	(	struct tfBerendsenHandle *	handle,
		struct tfForceHandle *	baseHandle )

Cast to base force.

Parameters

handle	populated handle
baseHandle	handle to populate

Returns: S_OK on success

◆ tfCustomForce_checkType()

HRESULT tfCustomForce_checkType	(	struct tfForceHandle *	handle,
		bool *	isType )

Check whether a base handle is of this force type.

Parameters

handle	populated handle
isType	flag signifying whether the handle is of this force type

Returns: S_OK on success

◆ tfCustomForce_fromBase()

HRESULT tfCustomForce_fromBase	(	struct tfForceHandle *	baseHandle,
		struct tfCustomForceHandle *	handle )

Cast from base force. Fails if instance is not of this type.

Parameters

baseHandle	populated handle
handle	handle to populate

Returns: S_OK on success

◆ tfCustomForce_getLastUpdate()

HRESULT tfCustomForce_getLastUpdate	(	struct tfCustomForceHandle *	handle,
		tfFloatP_t *	lastUpdate )

Get time of last force update.

Parameters

handle	populated handle
lastUpdate	time of last force update

Returns: S_OK on success

◆ tfCustomForce_getPeriod()

HRESULT tfCustomForce_getPeriod	(	struct tfCustomForceHandle *	handle,
		tfFloatP_t *	period )

Get force period.

Parameters

handle	populated handle
period	force period

Returns: S_OK on success

◆ tfCustomForce_getValue()

HRESULT tfCustomForce_getValue	(	struct tfCustomForceHandle *	handle,
		tfFloatP_t **	force )

Get current force value.

Parameters

handle	populated handle
force	force value

Returns: S_OK on success

◆ tfCustomForce_init()

HRESULT tfCustomForce_init	(	struct tfCustomForceHandle *	handle,
		struct tfUserForceFuncTypeHandle *	func,
		tfFloatP_t	period )

Create a custom force with a force function.

Parameters

handle	handle to populate
func	function to evaluate the force components
period	force period; infinite if a negative value is passed

Returns: S_OK on success

◆ tfCustomForce_setFunction()

HRESULT tfCustomForce_setFunction	(	struct tfCustomForceHandle *	handle,
		struct tfUserForceFuncTypeHandle *	fcn )

Set force function.

Parameters

handle	populated handle
fcn	force function

Returns: S_OK on success

◆ tfCustomForce_setPeriod()

HRESULT tfCustomForce_setPeriod	(	struct tfCustomForceHandle *	handle,
		tfFloatP_t	period )

Set force period.

Parameters

handle	populated handle
period	force period

Returns: S_OK on success

◆ tfCustomForce_setValue()

HRESULT tfCustomForce_setValue	(	struct tfCustomForceHandle *	handle,
		tfFloatP_t *	force )

Set current force value.

Parameters

handle	populated handle
force	force value

Returns: S_OK on success

◆ tfCustomForce_toBase()

HRESULT tfCustomForce_toBase	(	struct tfCustomForceHandle *	handle,
		struct tfForceHandle *	baseHandle )

Cast to base force.

Parameters

handle	populated handle
baseHandle	handle to populate

Returns: S_OK on success

◆ tfForce_add()

HRESULT tfForce_add	(	struct tfForceHandle *	f1,
		struct tfForceHandle *	f2,
		struct tfForceSumHandle *	fSum )

Add two forces.

Parameters

f1	first force
f2	second force
fSum	handle to populate with force sum

Returns: S_OK on success

◆ tfForce_bind_species()

HRESULT tfForce_bind_species	(	struct tfForceHandle *	handle,
		struct tfParticleTypeHandle *	a_type,
		const char *	coupling_symbol )

Bind a force to a species.

When a force is bound to a species, the magnitude of the force is scaled by the concentration of the species.

Parameters

handle	populated handle
a_type	particle type containing the species
coupling_symbol	symbol of the species

Returns: S_OK on success

◆ tfForce_destroy()

HRESULT tfForce_destroy ( struct tfForceHandle * handle )

Destroy an instance.

Parameters

handle populated handle

Returns: S_OK on success

◆ tfForce_EvalFcn_destroy()

HRESULT tfForce_EvalFcn_destroy ( struct tfUserForceFuncTypeHandle * handle )

Destroy an instance.

Parameters

handle handle to populate

Returns: S_OK on success

◆ tfForce_EvalFcn_init()

HRESULT tfForce_EvalFcn_init	(	struct tfUserForceFuncTypeHandle *	handle,
		tfUserForceFuncTypeHandleFcn *	fcn )

Initialize an instance.

Parameters

handle	handle to populate
fcn	evaluation function

Returns: S_OK on success

◆ tfForce_fromString()

HRESULT tfForce_fromString	(	struct tfForceHandle *	handle,
		const char *	str )

Create from a JSON string representation.

The returned type is automatically registered with the engine.

Returns: S_OK on success

◆ tfForce_getType()

HRESULT tfForce_getType	(	struct tfForceHandle *	handle,
		unsigned int *	te )

Get the force type.

Parameters

handle	populated handle
te	type enum

Returns: S_OK on success

◆ tfForce_toString()

HRESULT tfForce_toString	(	struct tfForceHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get a JSON string representation.

Parameters

handle	populated handle
str	string representation; can be used as an argument in a type particle factory
numChars	number of characters of string representation

Returns: S_OK on success

◆ tfFORCE_TYPE_init()

HRESULT tfFORCE_TYPE_init ( struct tfFORCE_TYPEHandle * handle )

Initialize an instance.

Parameters

handle handle to populate

Returns: S_OK on success

◆ tfForceSum_checkType()

HRESULT tfForceSum_checkType	(	struct tfForceHandle *	handle,
		bool *	isType )

Check whether a base handle is of this force type.

Parameters

handle	populated handle
isType	flag signifying whether the handle is of this force type

Returns: S_OK on success

◆ tfForceSum_fromBase()

HRESULT tfForceSum_fromBase	(	struct tfForceHandle *	baseHandle,
		struct tfForceSumHandle *	handle )

Cast from base force. Fails if instance is not of this type.

Parameters

baseHandle	populated handle
handle	handle to populate

Returns: S_OK on success

◆ tfForceSum_getConstituents()

HRESULT tfForceSum_getConstituents	(	struct tfForceSumHandle *	handle,
		struct tfForceHandle *	f1,
		struct tfForceHandle *	f2 )

Get the constituent forces.

Parameters

handle	populated handle
f1	first constituent force
f2	second constituent force

Returns: S_OK on success

◆ tfForceSum_toBase()

HRESULT tfForceSum_toBase	(	struct tfForceSumHandle *	handle,
		struct tfForceHandle *	baseHandle )

Cast to base force.

Parameters

handle	populated handle
baseHandle	handle to populate

Returns: S_OK on success

◆ tfFriction_checkType()

HRESULT tfFriction_checkType	(	struct tfForceHandle *	handle,
		bool *	isType )

Check whether a base handle is of this force type.

Parameters

handle	populated handle
isType	flag signifying whether the handle is of this force type

Returns: S_OK on success

◆ tfFriction_fromBase()

HRESULT tfFriction_fromBase	(	struct tfForceHandle *	baseHandle,
		struct tfFrictionHandle *	handle )

Cast from base force. Fails if instance is not of this type.

Parameters

baseHandle	populated handle
handle	handle to populate

Returns: S_OK on success

◆ tfFriction_getCoef()

HRESULT tfFriction_getCoef	(	struct tfFrictionHandle *	handle,
		tfFloatP_t *	coef )

Get the friction coefficient.

Parameters

handle	populated handle
coef	friction coefficient

Returns: S_OK on success

◆ tfFriction_init()

HRESULT tfFriction_init	(	struct tfFrictionHandle *	handle,
		tfFloatP_t	coeff )

Creates a friction force.

A friction force has the form:

$- \frac{|| \mathbf{v} ||}{\tau} \mathbf{v} ,$

where $\mathbf{v}$ is the velocity of a particle and $\tau$ is a time constant.

Parameters

handle	handle to populate
coeff	time constant

Returns: S_OK on success

◆ tfFriction_setCoef()

HRESULT tfFriction_setCoef	(	struct tfFrictionHandle *	handle,
		tfFloatP_t	coef )

Set the friction coefficient.

Parameters

handle	populated handle
coef	friction coefficient

Returns: S_OK on success

◆ tfFriction_toBase()

HRESULT tfFriction_toBase	(	struct tfFrictionHandle *	handle,
		struct tfForceHandle *	baseHandle )

Cast to base force.

Parameters

handle	populated handle
baseHandle	handle to populate

Returns: S_OK on success

◆ tfGaussian_checkType()

HRESULT tfGaussian_checkType	(	struct tfForceHandle *	handle,
		bool *	isType )

Check whether a base handle is of this force type.

Parameters

handle	populated handle
isType	flag signifying whether the handle is of this force type

Returns: S_OK on success

◆ tfGaussian_fromBase()

HRESULT tfGaussian_fromBase	(	struct tfForceHandle *	baseHandle,
		struct tfGaussianHandle *	handle )

Cast from base force. Fails if instance is not of this type.

Parameters

baseHandle	populated handle
handle	handle to populate

Returns: S_OK on success

◆ tfGaussian_getDuration()

HRESULT tfGaussian_getDuration	(	struct tfGaussianHandle *	handle,
		tfFloatP_t *	duration )

Get the magnitude duration.

Parameters

handle	populated handle
duration	magnitude duration

Returns: S_OK on success

◆ tfGaussian_getMean()

HRESULT tfGaussian_getMean	(	struct tfGaussianHandle *	handle,
		tfFloatP_t *	mean )

Get the magnitude mean.

Parameters

handle	populated handle
mean	mean magnitude

Returns: S_OK on success

◆ tfGaussian_getStd()

HRESULT tfGaussian_getStd	(	struct tfGaussianHandle *	handle,
		tfFloatP_t *	std )

Get the magnitude standard deviation.

Parameters

handle	populated handle
std	magnitude standard deviation

Returns: S_OK on success

◆ tfGaussian_init()

HRESULT tfGaussian_init	(	struct tfGaussianHandle *	handle,
		tfFloatP_t	std,
		tfFloatP_t	mean,
		tfFloatP_t	duration )

Creates a random force.

A random force has a randomly selected orientation and magnitude.

Orientation is selected according to a uniform distribution on the unit sphere.

Magnitude is selected according to a prescribed mean and standard deviation.

Parameters

handle	handle to populate
std	standard deviation of magnitude
mean	mean of magnitude
duration	duration of force.

Returns: S_OK on success

◆ tfGaussian_setDuration()

HRESULT tfGaussian_setDuration	(	struct tfGaussianHandle *	handle,
		tfFloatP_t	duration )

Set the magnitude duration.

Parameters

handle	populated handle
duration	magnitude duration

Returns: S_OK on success

◆ tfGaussian_setMean()

HRESULT tfGaussian_setMean	(	struct tfGaussianHandle *	handle,
		tfFloatP_t	mean )

Set the magnitude mean.

Parameters

handle	populated handle
mean	mean magnitude

Returns: S_OK on success

◆ tfGaussian_setStd()

HRESULT tfGaussian_setStd	(	struct tfGaussianHandle *	handle,
		tfFloatP_t	std )

Set the magnitude standard deviation.

Parameters

handle	populated handle
std	magnitude standard deviation

Returns: S_OK on success

◆ tfGaussian_toBase()

HRESULT tfGaussian_toBase	(	struct tfGaussianHandle *	handle,
		struct tfForceHandle *	baseHandle )

Cast to base force.

Parameters

handle	populated handle
baseHandle	handle to populate

Returns: S_OK on success

Data Structures

Typedefs

Functions

Function Documentation

◆ tfBerendsen_checkType()

◆ tfBerendsen_fromBase()

◆ tfBerendsen_getTimeConstant()

◆ tfBerendsen_init()

◆ tfBerendsen_setTimeConstant()

◆ tfBerendsen_toBase()

◆ tfCustomForce_checkType()

◆ tfCustomForce_fromBase()

◆ tfCustomForce_getLastUpdate()

◆ tfCustomForce_getPeriod()

◆ tfCustomForce_getValue()

◆ tfCustomForce_init()

◆ tfCustomForce_setFunction()

◆ tfCustomForce_setPeriod()

◆ tfCustomForce_setValue()

◆ tfCustomForce_toBase()

◆ tfForce_add()

◆ tfForce_bind_species()

◆ tfForce_destroy()

◆ tfForce_EvalFcn_destroy()

◆ tfForce_EvalFcn_init()

◆ tfForce_fromString()

◆ tfForce_getType()

◆ tfForce_toString()

◆ tfFORCE_TYPE_init()

◆ tfForceSum_checkType()

◆ tfForceSum_fromBase()

◆ tfForceSum_getConstituents()

◆ tfForceSum_toBase()

◆ tfFriction_checkType()

◆ tfFriction_fromBase()

◆ tfFriction_getCoef()

◆ tfFriction_init()

◆ tfFriction_setCoef()

◆ tfFriction_toBase()

◆ tfGaussian_checkType()

◆ tfGaussian_fromBase()

◆ tfGaussian_getDuration()

◆ tfGaussian_getMean()

◆ tfGaussian_getStd()

◆ tfGaussian_init()

◆ tfGaussian_setDuration()

◆ tfGaussian_setMean()

◆ tfGaussian_setStd()

◆ tfGaussian_toBase()