TissueForge::Bond Struct Reference

Bonds apply a potential to a particular set of particles. More...

#include <tfBond.h>

Collaboration diagram for TissueForge::Bond:

Public Member Functions
std::string	toString ()
	Get a JSON string representation.

Static Public Member Functions
static rendering::Style *	styleDef ()
	Get the default style.
static BondHandle *	create (struct Potential *potential, ParticleHandle *i, ParticleHandle *j, FPTYPE *half_life=NULL, FPTYPE *dissociation_energy=NULL, uint32_t flags=0)
	Construct a new bond handle and underlying bond.
static Bond *	fromString (const std::string &str)
	Create from a JSON string representation.

Public Attributes
uint32_t	flags
int32_t	i
int32_t	j
uint32_t	id
uint64_t	creation_time
FPTYPE	half_life
FPTYPE	dissociation_energy
FPTYPE	potential_energy
struct Potential *	potential
struct rendering::Style *	style

Detailed Description

Bonds apply a potential to a particular set of particles.

If you're building a model, you should probably instead be working with a BondHandle.

Member Function Documentation

create()

static BondHandle * TissueForge::Bond::create ( struct Potential * potential, ParticleHandle * i, ParticleHandle * j, FPTYPE * half_life = NULL, FPTYPE * dissociation_energy = NULL, uint32_t flags = 0 )

static

Construct a new bond handle and underlying bond.

Automatically updates when running on a CUDA device.

Parameters

potential	bond potential
i	ith particle
j	jth particle
half_life	bond half life
dissociation_energy	dissociation energy
flags	bond flags

fromString()

static Bond * TissueForge::Bond::fromString ( const std::string & str )

static

Create from a JSON string representation.

The returned bond is not automatically registered with the engine.

Parameters

str

Member Data Documentation

half_life

FPTYPE TissueForge::Bond::half_life

half life decay time for this bond.

---

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

• source/mdcore/include/tfBond.h