tf_bind.h File Reference

#include <tfBoundaryConditions.h>
#include <tfForce.h>
#include <tfPotential.h>
#include <tfBond.h>
#include <utility>

Include dependency graph for tf_bind.h:

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

Go to the source code of this file.

Namespaces
namespace	TissueForge
	Include Python header, disable linking to pythonX_d.lib on Windows in debug mode.

Functions
HRESULT	TissueForge::bind::particles (Potential *p, Particle *a, Particle *b)
	Bind a potential to a pair of particles.
HRESULT	TissueForge::bind::types (Potential *p, ParticleType *a, ParticleType *b, bool bound=false)
	Bind a potential to a pair of particle types.
HRESULT	TissueForge::bind::boundaryConditions (Potential *p, ParticleType *t)
	Bind a potential to a pair of particle type and all boundary conditions.
HRESULT	TissueForge::bind::boundaryCondition (Potential *p, BoundaryCondition *bc, ParticleType *t)
	Bind a potential to a pair of particle type and a boundary conditions.
HRESULT	TissueForge::bind::force (Force *force, ParticleType *a_type)
	Bind a force to a particle type.
HRESULT	TissueForge::bind::force (Force *force, ParticleType *a_type, const std::string &coupling_symbol)
	Bind a force to a particle type with magnitude proportional to a species amount.
HRESULT	TissueForge::bind::bonds (Potential *potential, ParticleList &particles, const FloatP_t &cutoff, std::vector< std::pair< ParticleType *, ParticleType * > * > *pairs=NULL, const FloatP_t &half_life=std::numeric_limits< FloatP_t >::max(), const FloatP_t &bond_energy=std::numeric_limits< FloatP_t >::max(), uint32_t flags=0, std::vector< BondHandle > *out=NULL)
	Create bonds for a set of pairs of particles.
HRESULT	TissueForge::bind::sphere (Potential *potential, const int &n, FVector3 *center=NULL, const FloatP_t &radius=1.0, std::pair< FloatP_t, FloatP_t > *phi=NULL, ParticleType *type=NULL, ParticleList *partList=NULL, std::vector< BondHandle > *bondList=NULL)

Function Documentation

bonds()

HRESULT TissueForge::bind::bonds	(	Potential *	potential,
		ParticleList &	particles,
		const FloatP_t &	cutoff,
		std::vector< std::pair< ParticleType *, ParticleType * > * > *	pairs = NULL,
		const FloatP_t &	half_life = std::numeric_limits< FloatP_t >::max(),
		const FloatP_t &	bond_energy = std::numeric_limits< FloatP_t >::max(),
		uint32_t	flags = 0,
		std::vector< BondHandle > *	out = NULL )

Create bonds for a set of pairs of particles.

Parameters

potential	The bond potential
particles	The list of particles
cutoff	Interaction cutoff
pairs	Pairs to bind
half_life	Bond half life
bond_energy	Bond dissociation energy
flags	Bond flags
out	List of created bonds

Returns

HRESULT

boundaryCondition()

HRESULT TissueForge::bind::boundaryCondition	(	Potential *	p,
		BoundaryCondition *	bc,
		ParticleType *	t )

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

Automatically updates when running on a CUDA device.

Parameters

p	The potential
bc	The boundary condition
t	The particle type

Returns

HRESULT

boundaryConditions()

HRESULT TissueForge::bind::boundaryConditions	(	Potential *	p,
		ParticleType *	t )

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

Automatically updates when running on a CUDA device.

Parameters

p	The potential
t	The particle type

Returns

HRESULT

force() [1/2]

HRESULT TissueForge::bind::force	(	Force *	force,
		ParticleType *	a_type )

Bind a force to a particle type.

Parameters

force	The force
a_type	The particle type

Returns

HRESULT

force() [2/2]

HRESULT TissueForge::bind::force	(	Force *	force,
		ParticleType *	a_type,
		const std::string &	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

HRESULT

particles()

HRESULT TissueForge::bind::particles	(	Potential *	p,
		Particle *	a,
		Particle *	b )

Bind a potential to a pair of particles.

Parameters

p	The potential
a	The first particle
b	The second particle

Returns

HRESULT

types()

HRESULT TissueForge::bind::types	(	Potential *	p,
		ParticleType *	a,
		ParticleType *	b,
		bool	bound = false )

Bind a potential to a pair of particle types.

Automatically updates when running on a CUDA device.

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, optional

Returns

HRESULT