tfC_bind.h File Reference

#include "tf_port_c.h"
#include "tfCBond.h"
#include "tfCBoundaryConditions.h"
#include "tfCForce.h"
#include "tfCParticle.h"
#include "tfCPotential.h"

Include dependency graph for tfC_bind.h:

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

Go to the source code of this file.

Functions
HRESULT	tfBindParticles (struct tfPotentialHandle *p, struct tfParticleHandleHandle *a, struct tfParticleHandleHandle *b)
	Bind a potential to a pair of particles.
HRESULT	tfBindTypes (struct tfPotentialHandle *p, struct tfParticleTypeHandle *a, struct tfParticleTypeHandle *b, bool bound)
	Bind a potential to a pair of particle types.
HRESULT	tfBindBoundaryConditions (struct tfPotentialHandle *p, struct tfParticleTypeHandle *t)
	Bind a potential to a pair of particle type and all boundary conditions.
HRESULT	tfBindBoundaryCondition (struct tfPotentialHandle *p, struct tfBoundaryConditionHandle *bc, struct tfParticleTypeHandle *t)
	Bind a potential to a pair of particle type and a boundary conditions.
HRESULT	tfBindForce (struct tfForceHandle *force, struct tfParticleTypeHandle *a_type)
	Bind a force to a particle type.
HRESULT	tfBindForceS (struct tfForceHandle *force, struct tfParticleTypeHandle *a_type, const char *coupling_symbol)
	Bind a force to a particle type with magnitude proportional to a species amount.
HRESULT	tfBindBonds (struct tfPotentialHandle *potential, struct tfParticleListHandle *particles, tfFloatP_t cutoff, struct tfParticleTypeHandle **ppairsA, struct tfParticleTypeHandle **ppairsB, unsigned int numTypes, tfFloatP_t *half_life, tfFloatP_t *bond_energy, struct tfBondHandleHandle **out, unsigned int *numOut)
	Create bonds for a set of pairs of particles.

Function Documentation

tfBindBonds()

HRESULT tfBindBonds	(	struct tfPotentialHandle *	potential,
		struct tfParticleListHandle *	particles,
		tfFloatP_t	cutoff,
		struct tfParticleTypeHandle **	ppairsA,
		struct tfParticleTypeHandle **	ppairsB,
		unsigned int	numTypes,
		tfFloatP_t *	half_life,
		tfFloatP_t *	bond_energy,
		struct tfBondHandleHandle **	out,
		unsigned int *	numOut )

Create bonds for a set of pairs of particles.

Parameters

potential	The bond potential
particles	The list of particles
cutoff	Interaction cutoff
ppairsA	first elements of type pairs that are bonded, optional
ppairsB	second elements of type pairs that are bonded, optional
numTypes	number of passed type pairs
half_life	Bond half life, optional
bond_energy	Bond dissociation energy, optional
out	List of created bonds, optional
numOut	Number of created bonds, optional

Returns

S_OK on success

tfBindBoundaryCondition()

HRESULT tfBindBoundaryCondition	(	struct tfPotentialHandle *	p,
		struct tfBoundaryConditionHandle *	bc,
		struct tfParticleTypeHandle *	t )

Bind a potential to a pair of particle type and a boundary conditions.

Parameters

p	The potential
bc	The boundary condition
t	The particle type

Returns

S_OK on success

tfBindBoundaryConditions()

HRESULT tfBindBoundaryConditions	(	struct tfPotentialHandle *	p,
		struct tfParticleTypeHandle *	t )

Bind a potential to a pair of particle type and all boundary conditions.

Parameters

p	The potential
t	The particle type

Returns

S_OK on success

tfBindForce()

HRESULT tfBindForce	(	struct tfForceHandle *	force,
		struct tfParticleTypeHandle *	a_type )

Bind a force to a particle type.

Parameters

force	The force
a_type	The particle type

Returns

S_OK on success

tfBindForceS()

HRESULT tfBindForceS	(	struct tfForceHandle *	force,
		struct tfParticleTypeHandle *	a_type,
		const char *	coupling_symbol )

Bind a force to a particle type with magnitude proportional to a species amount.

Parameters

force	The force
a_type	The particle type
coupling_symbol	The symbol of the species

Returns

S_OK on success

tfBindParticles()

HRESULT tfBindParticles	(	struct tfPotentialHandle *	p,
		struct tfParticleHandleHandle *	a,
		struct tfParticleHandleHandle *	b )

Bind a potential to a pair of particles.

Parameters

p	The potential
a	The first particle
b	The second particle

Returns

S_OK on success

tfBindTypes()

HRESULT tfBindTypes	(	struct tfPotentialHandle *	p,
		struct tfParticleTypeHandle *	a,
		struct tfParticleTypeHandle *	b,
		bool	bound )

Bind a potential to a pair of particle types.

Parameters

p	The potential
a	The first type
b	The second type
bound	Flag signifying whether this potential exclusively operates on particles of different clusters

Returns

S_OK on success