tfCBond.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of Tissue Forge.
 * Copyright (c) 2022-2024 T.J. Sego
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 ******************************************************************************/

 
#ifndef _WRAPS_C_TFCBOND_H_
#define _WRAPS_C_TFCBOND_H_
 
#include "tf_port_c.h"
 
#include "tfCParticle.h"
#include "tfCPotential.h"
 
// Handles

struct CAPI_EXPORT tfBondHandleHandle {
    void *tfObj;
};

struct CAPI_EXPORT tfAngleHandleHandle {
    void *tfObj;
};

struct CAPI_EXPORT tfDihedralHandleHandle {
    void *tfObj;
};
 

// BondHandle //
 

CAPI_FUNC(HRESULT) tfBondHandle_init(struct tfBondHandleHandle *handle, unsigned int id);

CAPI_FUNC(HRESULT) tfBondHandle_create(
    struct tfBondHandleHandle *handle, 
    struct tfPotentialHandle *potential,
    struct tfParticleHandleHandle *i, 
    struct tfParticleHandleHandle *j
);

CAPI_FUNC(HRESULT) tfBondHandle_getId(struct tfBondHandleHandle *handle, int *id);

CAPI_FUNC(HRESULT) tfBondHandle_str(struct tfBondHandleHandle *handle, char **str, unsigned int *numChars);

CAPI_FUNC(HRESULT) tfBondHandle_check(struct tfBondHandleHandle *handle, bool *flag);

CAPI_FUNC(HRESULT) tfBondHandle_destroy(struct tfBondHandleHandle *handle);

CAPI_FUNC(HRESULT) tfBondHandle_decays(struct tfBondHandleHandle *handle, bool *flag);

CAPI_FUNC(HRESULT) tfBondHandle_hasPartId(struct tfBondHandleHandle *handle, int pid, bool *result);

CAPI_FUNC(HRESULT) tfBondHandle_hasPart(struct tfBondHandleHandle *handle, struct tfParticleHandleHandle *part, bool *result);

CAPI_FUNC(HRESULT) tfBondHandle_getEnergy(struct tfBondHandleHandle *handle, tfFloatP_t *value);

CAPI_FUNC(HRESULT) tfBondHandle_getParts(struct tfBondHandleHandle *handle, int *parti, int *partj);

CAPI_FUNC(HRESULT) tfBondHandle_getPartList(struct tfBondHandleHandle *handle, struct tfParticleListHandle *plist);

CAPI_FUNC(HRESULT) tfBondHandle_getPotential(struct tfBondHandleHandle *handle, struct tfPotentialHandle *potential);

CAPI_FUNC(HRESULT) tfBondHandle_getDissociationEnergy(struct tfBondHandleHandle *handle, tfFloatP_t *value);

CAPI_FUNC(HRESULT) tfBondHandle_setDissociationEnergy(struct tfBondHandleHandle *handle, tfFloatP_t value);

CAPI_FUNC(HRESULT) tfBondHandle_getHalfLife(struct tfBondHandleHandle *handle, tfFloatP_t *value);

CAPI_FUNC(HRESULT) tfBondHandle_setHalfLife(struct tfBondHandleHandle *handle, tfFloatP_t value);

CAPI_FUNC(HRESULT) tfBondHandle_setActive(struct tfBondHandleHandle *handle, bool flag);

CAPI_FUNC(HRESULT) tfBondHandle_getStyle(struct tfBondHandleHandle *handle, struct tfRenderingStyleHandle *style);

CAPI_FUNC(HRESULT) tfBondHandle_setStyle(struct tfBondHandleHandle *handle, struct tfRenderingStyleHandle *style);

CAPI_FUNC(HRESULT) tfBondHandle_getStyleDef(struct tfRenderingStyleHandle *style);

CAPI_FUNC(HRESULT) tfBondHandle_getAge(struct tfBondHandleHandle *handle, tfFloatP_t *value);

CAPI_FUNC(HRESULT) tfBondHandle_toString(struct tfBondHandleHandle *handle, char **str, unsigned int *numChars);

CAPI_FUNC(HRESULT) tfBondHandle_fromString(struct tfBondHandleHandle *handle, const char *str);

CAPI_FUNC(HRESULT) tfBondHandle_lt(struct tfBondHandleHandle *lhs, struct tfBondHandleHandle *rhs, bool *result);

CAPI_FUNC(HRESULT) tfBondHandle_gt(struct tfBondHandleHandle *lhs, struct tfBondHandleHandle *rhs, bool *result);

CAPI_FUNC(HRESULT) tfBondHandle_le(struct tfBondHandleHandle *lhs, struct tfBondHandleHandle *rhs, bool *result);

CAPI_FUNC(HRESULT) tfBondHandle_ge(struct tfBondHandleHandle *lhs, struct tfBondHandleHandle *rhs, bool *result);

CAPI_FUNC(HRESULT) tfBondHandle_eq(struct tfBondHandleHandle *lhs, struct tfBondHandleHandle *rhs, bool *result);

CAPI_FUNC(HRESULT) tfBondHandle_ne(struct tfBondHandleHandle *lhs, struct tfBondHandleHandle *rhs, bool *result);
 

// AngleHandle //
 

CAPI_FUNC(HRESULT) tfAngleHandle_init(struct tfAngleHandleHandle *handle, unsigned int id);

CAPI_FUNC(HRESULT) tfAngleHandle_create(
    struct tfAngleHandleHandle *handle, 
    struct tfPotentialHandle *potential,
    struct tfParticleHandleHandle *i, 
    struct tfParticleHandleHandle *j, 
    struct tfParticleHandleHandle *k
);

CAPI_FUNC(HRESULT) tfAngleHandle_str(struct tfAngleHandleHandle *handle, char **str, unsigned int *numChars);
 

CAPI_FUNC(HRESULT) tfAngleHandle_check(struct tfAngleHandleHandle *handle, bool *flag);

CAPI_FUNC(HRESULT) tfAngleHandle_destroy(struct tfAngleHandleHandle *handle);

CAPI_FUNC(HRESULT) tfAngleHandle_decays(struct tfAngleHandleHandle *handle, bool *flag);

CAPI_FUNC(HRESULT) tfAngleHandle_hasPartId(struct tfAngleHandleHandle *handle, int pid, bool *result);

CAPI_FUNC(HRESULT) tfAngleHandle_hasPart(struct tfAngleHandleHandle *handle, struct tfParticleHandleHandle *part, bool *result);

CAPI_FUNC(HRESULT) tfAngleHandle_getEnergy(struct tfAngleHandleHandle *handle, tfFloatP_t *value);

CAPI_FUNC(HRESULT) tfAngleHandle_getParts(struct tfAngleHandleHandle *handle, int *parti, int *partj);

CAPI_FUNC(HRESULT) tfAngleHandle_getPartList(struct tfAngleHandleHandle *handle, struct tfParticleListHandle *plist);

CAPI_FUNC(HRESULT) tfAngleHandle_getPotential(struct tfAngleHandleHandle *handle, struct tfPotentialHandle *potential);

CAPI_FUNC(HRESULT) tfAngleHandle_getDissociationEnergy(struct tfAngleHandleHandle *handle, tfFloatP_t *value);

CAPI_FUNC(HRESULT) tfAngleHandle_setDissociationEnergy(struct tfAngleHandleHandle *handle, tfFloatP_t value);

CAPI_FUNC(HRESULT) tfAngleHandle_getHalfLife(struct tfAngleHandleHandle *handle, tfFloatP_t *value);

CAPI_FUNC(HRESULT) tfAngleHandle_setHalfLife(struct tfAngleHandleHandle *handle, tfFloatP_t value);

CAPI_FUNC(HRESULT) tfAngleHandle_setActive(struct tfAngleHandleHandle *handle, bool flag);

CAPI_FUNC(HRESULT) tfAngleHandle_getStyle(struct tfAngleHandleHandle *handle, struct tfRenderingStyleHandle *style);

CAPI_FUNC(HRESULT) tfAngleHandle_setStyle(struct tfAngleHandleHandle *handle, struct tfRenderingStyleHandle *style);

CAPI_FUNC(HRESULT) tfAngleHandle_getStyleDef(struct tfRenderingStyleHandle *style);

CAPI_FUNC(HRESULT) tfAngleHandle_getAge(struct tfAngleHandleHandle *handle, tfFloatP_t *value);

CAPI_FUNC(HRESULT) tfAngleHandle_toString(struct tfAngleHandleHandle *handle, char **str, unsigned int *numChars);

CAPI_FUNC(HRESULT) tfAngleHandle_fromString(struct tfAngleHandleHandle *handle, const char *str);

CAPI_FUNC(HRESULT) tfAngleHandle_lt(struct tfAngleHandleHandle *lhs, struct tfAngleHandleHandle *rhs, bool *result);

CAPI_FUNC(HRESULT) tfAngleHandle_gt(struct tfAngleHandleHandle *lhs, struct tfAngleHandleHandle *rhs, bool *result);

CAPI_FUNC(HRESULT) tfAngleHandle_le(struct tfAngleHandleHandle *lhs, struct tfAngleHandleHandle *rhs, bool *result);

CAPI_FUNC(HRESULT) tfAngleHandle_ge(struct tfAngleHandleHandle *lhs, struct tfAngleHandleHandle *rhs, bool *result);

CAPI_FUNC(HRESULT) tfAngleHandle_eq(struct tfAngleHandleHandle *lhs, struct tfAngleHandleHandle *rhs, bool *result);

CAPI_FUNC(HRESULT) tfAngleHandle_ne(struct tfAngleHandleHandle *lhs, struct tfAngleHandleHandle *rhs, bool *result);
 

// DihedralHandle //
 

CAPI_FUNC(HRESULT) tfDihedralHandle_init(struct tfDihedralHandleHandle *handle, unsigned int id);

CAPI_FUNC(HRESULT) tfDihedralHandle_create(
    struct tfDihedralHandleHandle *handle, 
    struct tfPotentialHandle *potential,
    struct tfParticleHandleHandle *i, 
    struct tfParticleHandleHandle *j, 
    struct tfParticleHandleHandle *k, 
    struct tfParticleHandleHandle *l
);

CAPI_FUNC(HRESULT) tfDihedralHandle_str(struct tfDihedralHandleHandle *handle, char **str, unsigned int *numChars);
 

CAPI_FUNC(HRESULT) tfDihedralHandle_check(struct tfDihedralHandleHandle *handle, bool *flag);

CAPI_FUNC(HRESULT) tfDihedralHandle_destroy(struct tfDihedralHandleHandle *handle);

CAPI_FUNC(HRESULT) tfDihedralHandle_decays(struct tfDihedralHandleHandle *handle, bool *flag);

CAPI_FUNC(HRESULT) tfDihedralHandle_hasPartId(struct tfDihedralHandleHandle *handle, int pid, bool *result);

CAPI_FUNC(HRESULT) tfDihedralHandle_hasPart(struct tfDihedralHandleHandle *handle, struct tfParticleHandleHandle *part, bool *result);

CAPI_FUNC(HRESULT) tfDihedralHandle_getEnergy(struct tfDihedralHandleHandle *handle, tfFloatP_t *value);

CAPI_FUNC(HRESULT) tfDihedralHandle_getParts(struct tfDihedralHandleHandle *handle, int *parti, int *partj);

CAPI_FUNC(HRESULT) tfDihedralHandle_getPartList(struct tfDihedralHandleHandle *handle, struct tfParticleListHandle *plist);

CAPI_FUNC(HRESULT) tfDihedralHandle_getPotential(struct tfDihedralHandleHandle *handle, struct tfPotentialHandle *potential);

CAPI_FUNC(HRESULT) tfDihedralHandle_getDissociationEnergy(struct tfDihedralHandleHandle *handle, tfFloatP_t *value);

CAPI_FUNC(HRESULT) tfDihedralHandle_setDissociationEnergy(struct tfDihedralHandleHandle *handle, tfFloatP_t value);

CAPI_FUNC(HRESULT) tfDihedralHandle_getHalfLife(struct tfDihedralHandleHandle *handle, tfFloatP_t *value);

CAPI_FUNC(HRESULT) tfDihedralHandle_setHalfLife(struct tfDihedralHandleHandle *handle, tfFloatP_t value);

CAPI_FUNC(HRESULT) tfDihedralHandle_setActive(struct tfDihedralHandleHandle *handle, bool flag);

CAPI_FUNC(HRESULT) tfDihedralHandle_getStyle(struct tfDihedralHandleHandle *handle, struct tfRenderingStyleHandle *style);

CAPI_FUNC(HRESULT) tfDihedralHandle_setStyle(struct tfDihedralHandleHandle *handle, struct tfRenderingStyleHandle *style);

CAPI_FUNC(HRESULT) tfDihedralHandle_getStyleDef(struct tfRenderingStyleHandle *style);

CAPI_FUNC(HRESULT) tfDihedralHandle_getAge(struct tfDihedralHandleHandle *handle, tfFloatP_t *value);

CAPI_FUNC(HRESULT) tfDihedralHandle_toString(struct tfDihedralHandleHandle *handle, char **str, unsigned int *numChars);

CAPI_FUNC(HRESULT) tfDihedralHandle_fromString(struct tfDihedralHandleHandle *handle, const char *str);

CAPI_FUNC(HRESULT) tfDihedralHandle_lt(struct tfDihedralHandleHandle *lhs, struct tfDihedralHandleHandle *rhs, bool *result);

CAPI_FUNC(HRESULT) tfDihedralHandle_gt(struct tfDihedralHandleHandle *lhs, struct tfDihedralHandleHandle *rhs, bool *result);

CAPI_FUNC(HRESULT) tfDihedralHandle_le(struct tfDihedralHandleHandle *lhs, struct tfDihedralHandleHandle *rhs, bool *result);

CAPI_FUNC(HRESULT) tfDihedralHandle_ge(struct tfDihedralHandleHandle *lhs, struct tfDihedralHandleHandle *rhs, bool *result);

CAPI_FUNC(HRESULT) tfDihedralHandle_eq(struct tfDihedralHandleHandle *lhs, struct tfDihedralHandleHandle *rhs, bool *result);

CAPI_FUNC(HRESULT) tfDihedralHandle_ne(struct tfDihedralHandleHandle *lhs, struct tfDihedralHandleHandle *rhs, bool *result);
 

// Module functions //
 

CAPI_FUNC(HRESULT) tfBondHandle_getAll(struct tfBondHandleHandle **handles, unsigned int *numBonds);

CAPI_FUNC(HRESULT) tfBond_pairwise(
    struct tfPotentialHandle *pot, 
    struct tfParticleListHandle *parts, 
    tfFloatP_t cutoff, 
    struct tfParticleTypeHandle *ppairsA, 
    struct tfParticleTypeHandle *ppairsB, 
    unsigned int numTypePairs, 
    tfFloatP_t *half_life, 
    tfFloatP_t *bond_energy, 
    struct tfBondHandleHandle **bonds, 
    unsigned int *numBonds
);

CAPI_FUNC(HRESULT) tfBond_getIdsForParticle(unsigned int pid, unsigned int **bids, unsigned int *numIds);

CAPI_FUNC(HRESULT) tfBond_destroyAll();

CAPI_FUNC(HRESULT) tfAngleHandle_getAll(struct tfAngleHandleHandle **handles, unsigned int *numBonds);

CAPI_FUNC(HRESULT) tfAngle_getIdsForParticle(unsigned int pid, unsigned int **bids, unsigned int *numIds);

CAPI_FUNC(HRESULT) tfAngle_destroyAll();

CAPI_FUNC(HRESULT) tfDihedralHandle_getAll(struct tfDihedralHandleHandle **handles, unsigned int *numBonds);

CAPI_FUNC(HRESULT) tfDihedral_getIdsForParticle(unsigned int pid, unsigned int **bids, unsigned int *numIds);

CAPI_FUNC(HRESULT) tfDihedral_destroyAll();
 
#endif // _WRAPS_C_TFCBOND_H_