Tissue Forge C 0.2.1
Interactive, particle-based physics, chemistry and biology modeling and simulation environment
Loading...
Searching...
No Matches
tfC_bind.h
Go to the documentation of this file.
1/*******************************************************************************
2 * This file is part of Tissue Forge.
3 * Copyright (c) 2022-2024 T.J. Sego
4 *
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU Lesser General Public License as published
7 * by the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 *
18 ******************************************************************************/
19
25#ifndef _WRAPS_C_TFC_BIND_H_
26#define _WRAPS_C_TFC_BIND_H_
27
28#include "tf_port_c.h"
29
30#include "tfCBond.h"
32#include "tfCForce.h"
33#include "tfCParticle.h"
34#include "tfCPotential.h"
35
36
38// Module functions //
40
41
50CAPI_FUNC(HRESULT) tfBindParticles(struct tfPotentialHandle *p, struct tfParticleHandleHandle *a, struct tfParticleHandleHandle *b);
51
61CAPI_FUNC(HRESULT) tfBindTypes(struct tfPotentialHandle *p, struct tfParticleTypeHandle *a, struct tfParticleTypeHandle *b, bool bound);
62
70CAPI_FUNC(HRESULT) tfBindBoundaryConditions(struct tfPotentialHandle *p, struct tfParticleTypeHandle *t);
71
81
89CAPI_FUNC(HRESULT) tfBindForce(struct tfForceHandle *force, struct tfParticleTypeHandle *a_type);
90
99CAPI_FUNC(HRESULT) tfBindForceS(struct tfForceHandle *force, struct tfParticleTypeHandle *a_type, const char *coupling_symbol);
100
116CAPI_FUNC(HRESULT) tfBindBonds(
117 struct tfPotentialHandle *potential,
118 struct tfParticleListHandle *particles,
119 tfFloatP_t cutoff,
120 struct tfParticleTypeHandle **ppairsA,
121 struct tfParticleTypeHandle **ppairsB,
122 unsigned int numTypes,
123 tfFloatP_t *half_life,
124 tfFloatP_t *bond_energy,
125 struct tfBondHandleHandle **out,
126 unsigned int *numOut
127);
128
129#endif // _WRAPS_C_TFC_BIND_H_
Handle to a BondHandle instance.
Definition tfCBond.h:39
Handle to a BoundaryCondition instance.
Definition tfCBoundaryConditions.h:64
Handle to a Force instance.
Definition tfCForce.h:59
Handle to a ParticleHandle instance.
Definition tfCParticle.h:111
Handle to a ParticleList instance.
Definition tfCParticle.h:127
Handle to a ParticleType instance.
Definition tfCParticle.h:119
Handle to a Potential instance.
Definition tfCPotential.h:144
HRESULT tfBindBoundaryConditions(struct tfPotentialHandle *p, struct tfParticleTypeHandle *t)
Bind a potential to a pair of particle type and all boundary conditions.
HRESULT tfBindTypes(struct tfPotentialHandle *p, struct tfParticleTypeHandle *a, struct tfParticleTypeHandle *b, bool bound)
Bind a potential to a pair of particle types.
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.
HRESULT tfBindForce(struct tfForceHandle *force, struct tfParticleTypeHandle *a_type)
Bind a force to a particle type.
HRESULT tfBindParticles(struct tfPotentialHandle *p, struct tfParticleHandleHandle *a, struct tfParticleHandleHandle *b)
Bind a potential to a pair of particles.
HRESULT tfBindBoundaryCondition(struct tfPotentialHandle *p, struct tfBoundaryConditionHandle *bc, struct tfParticleTypeHandle *t)
Bind a potential to a pair of particle type and a boundary conditions.