Binding

tissue_forge.bind.particles(p: _Potential, a: Particle, b: Particle) → HRESULT

Bind a potential to a pair of particles

Parameters:

  • p (Potential) – The potential

  • a (Particle) – The first particle

  • b (Particle) – The second particle

Return type:

int

Returns:

HRESULT

tissue_forge.bind.types(p: _Potential, a: ParticleType, b: ParticleType, bound: bool = False) → HRESULT

Bind a potential to a pair of particle types.

Automatically updates when running on a CUDA device.

Parameters:

  • p (Potential) – The potential

  • a (ParticleType) – The first type

  • b (ParticleType) – The second type

  • bound (boolean) – Flag signifying whether this potential exclusively operates on particles of different clusters, optional

Return type:

int

Returns:

HRESULT

tissue_forge.bind.boundary_conditions(p: _Potential, t: ParticleType) → HRESULT

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

Automatically updates when running on a CUDA device.

Parameters:

  • p (Potential) – The potential

  • t (ParticleType) – The particle type

Return type:

int

Returns:

HRESULT

tissue_forge.bind.boundary_condition(p: _Potential, bc: BoundaryCondition, t: ParticleType) → HRESULT

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

Automatically updates when running on a CUDA device.

Parameters:

  • p (Potential) – The potential

  • bc (BoundaryCondition) – The boundary condition

  • t (ParticleType) – The particle type

Return type:

int

Returns:

HRESULT

tissue_forge.bind.force(*args) → HRESULT

Overload 1:

Bind a force to a particle type

Parameters:

  • force (Force) – The force

  • a_type (ParticleType) – The particle type

Return type:

int

Returns:

HRESULT


Overload 2:

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

Parameters:

  • force (Force) – The force

  • a_type (ParticleType) – The particle type

  • coupling_symbol (string) – The symbol of the species

Return type:

int

Returns:

HRESULT

tissue_forge.bind.bonds(potential, particles, cutoff, pairs=None, half_life=None, bond_energy=None, flags=0)