tfCForce.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_TFCFORCE_H_
#define _WRAPS_C_TFCFORCE_H_
 
#include "tf_port_c.h"
 
typedef void (*tfUserForceFuncTypeHandleFcn)(struct tfCustomForceHandle*, tfFloatP_t*);
 
// Handles
 
struct CAPI_EXPORT tfFORCE_TYPEHandle {
    unsigned int FORCE_FORCE;
    unsigned int FORCE_BERENDSEN;
    unsigned int FORCE_GAUSSIAN;
    unsigned int FORCE_FRICTION;
    unsigned int FORCE_SUM;
    unsigned int FORCE_CUSTOM;
};
 
struct CAPI_EXPORT tfUserForceFuncTypeHandle {
    void *tfObj;
};
 
struct CAPI_EXPORT tfForceHandle {
    void *tfObj;
};
 
struct CAPI_EXPORT tfForceSumHandle {
    void *tfObj;
};
 
struct CAPI_EXPORT tfCustomForceHandle {
    void *tfObj;
};
 
struct CAPI_EXPORT tfBerendsenHandle {
    void *tfObj;
};
 
struct CAPI_EXPORT tfGaussianHandle {
    void *tfObj;
};
 
struct CAPI_EXPORT tfFrictionHandle {
    void *tfObj;
};
 
 
// FORCE_TYPE //
 
 
CAPI_FUNC(HRESULT) tfFORCE_TYPE_init(struct tfFORCE_TYPEHandle *handle);
 
 
// UserForceFuncType //
 
 
CAPI_FUNC(HRESULT) tfForce_EvalFcn_init(struct tfUserForceFuncTypeHandle *handle, tfUserForceFuncTypeHandleFcn *fcn);
 
CAPI_FUNC(HRESULT) tfForce_EvalFcn_destroy(struct tfUserForceFuncTypeHandle *handle);
 
 
// Force //
 
CAPI_FUNC(HRESULT) tfForce_getType(struct tfForceHandle *handle, unsigned int *te);
 
CAPI_FUNC(HRESULT) tfForce_bind_species(struct tfForceHandle *handle, struct tfParticleTypeHandle *a_type, const char *coupling_symbol);
 
CAPI_FUNC(HRESULT) tfForce_toString(struct tfForceHandle *handle, char **str, unsigned int *numChars);
 
CAPI_FUNC(HRESULT) tfForce_fromString(struct tfForceHandle *handle, const char *str);
 
CAPI_FUNC(HRESULT) tfForce_destroy(struct tfForceHandle *handle);
 
 
// ForceSum //
 
 
CAPI_FUNC(HRESULT) tfForceSum_checkType(struct tfForceHandle *handle, bool *isType);
 
CAPI_FUNC(HRESULT) tfForceSum_toBase(struct tfForceSumHandle *handle, struct tfForceHandle *baseHandle);
 
CAPI_FUNC(HRESULT) tfForceSum_fromBase(struct tfForceHandle *baseHandle, struct tfForceSumHandle *handle);
 
CAPI_FUNC(HRESULT) tfForceSum_getConstituents(struct tfForceSumHandle *handle, struct tfForceHandle *f1, struct tfForceHandle *f2);
 
 
// CustomForce //
 
 
CAPI_FUNC(HRESULT) tfCustomForce_init(struct tfCustomForceHandle *handle, struct tfUserForceFuncTypeHandle *func, tfFloatP_t period);
 
CAPI_FUNC(HRESULT) tfCustomForce_checkType(struct tfForceHandle *handle, bool *isType);
 
CAPI_FUNC(HRESULT) tfCustomForce_toBase(struct tfCustomForceHandle *handle, struct tfForceHandle *baseHandle);
 
CAPI_FUNC(HRESULT) tfCustomForce_fromBase(struct tfForceHandle *baseHandle, struct tfCustomForceHandle *handle);
 
CAPI_FUNC(HRESULT) tfCustomForce_getPeriod(struct tfCustomForceHandle *handle, tfFloatP_t *period);
 
CAPI_FUNC(HRESULT) tfCustomForce_setPeriod(struct tfCustomForceHandle *handle, tfFloatP_t period);
 
CAPI_FUNC(HRESULT) tfCustomForce_setFunction(struct tfCustomForceHandle *handle, struct tfUserForceFuncTypeHandle *fcn);
 
CAPI_FUNC(HRESULT) tfCustomForce_getValue(struct tfCustomForceHandle *handle, tfFloatP_t **force);
 
CAPI_FUNC(HRESULT) tfCustomForce_setValue(struct tfCustomForceHandle *handle, tfFloatP_t *force);
 
CAPI_FUNC(HRESULT) tfCustomForce_getLastUpdate(struct tfCustomForceHandle *handle, tfFloatP_t *lastUpdate);
 
 
// Berendsen //
 
CAPI_FUNC(HRESULT) tfBerendsen_init(struct tfBerendsenHandle *handle, tfFloatP_t tau);
 
CAPI_FUNC(HRESULT) tfBerendsen_checkType(struct tfForceHandle *handle, bool *isType);
 
CAPI_FUNC(HRESULT) tfBerendsen_toBase(struct tfBerendsenHandle *handle, struct tfForceHandle *baseHandle);
 
CAPI_FUNC(HRESULT) tfBerendsen_fromBase(struct tfForceHandle *baseHandle, struct tfBerendsenHandle *handle);
 
CAPI_FUNC(HRESULT) tfBerendsen_getTimeConstant(struct tfBerendsenHandle *handle, tfFloatP_t *tau);
 
CAPI_FUNC(HRESULT) tfBerendsen_setTimeConstant(struct tfBerendsenHandle *handle, tfFloatP_t tau);
 
 
// Gaussian //
 
CAPI_FUNC(HRESULT) tfGaussian_init(struct tfGaussianHandle *handle, tfFloatP_t std, tfFloatP_t mean, tfFloatP_t duration);
 
CAPI_FUNC(HRESULT) tfGaussian_checkType(struct tfForceHandle *handle, bool *isType);
 
CAPI_FUNC(HRESULT) tfGaussian_toBase(struct tfGaussianHandle *handle, struct tfForceHandle *baseHandle);
 
CAPI_FUNC(HRESULT) tfGaussian_fromBase(struct tfForceHandle *baseHandle, struct tfGaussianHandle *handle);
 
CAPI_FUNC(HRESULT) tfGaussian_getStd(struct tfGaussianHandle *handle, tfFloatP_t *std);
 
CAPI_FUNC(HRESULT) tfGaussian_setStd(struct tfGaussianHandle *handle, tfFloatP_t std);
 
CAPI_FUNC(HRESULT) tfGaussian_getMean(struct tfGaussianHandle *handle, tfFloatP_t *mean);
 
CAPI_FUNC(HRESULT) tfGaussian_setMean(struct tfGaussianHandle *handle, tfFloatP_t mean);
 
CAPI_FUNC(HRESULT) tfGaussian_getDuration(struct tfGaussianHandle *handle, tfFloatP_t *duration);
 
CAPI_FUNC(HRESULT) tfGaussian_setDuration(struct tfGaussianHandle *handle, tfFloatP_t duration);
 
 
// Friction //
 
 
CAPI_FUNC(HRESULT) tfFriction_init(struct tfFrictionHandle *handle, tfFloatP_t coeff);
 
CAPI_FUNC(HRESULT) tfFriction_checkType(struct tfForceHandle *handle, bool *isType);
 
CAPI_FUNC(HRESULT) tfFriction_toBase(struct tfFrictionHandle *handle, struct tfForceHandle *baseHandle);
 
CAPI_FUNC(HRESULT) tfFriction_fromBase(struct tfForceHandle *baseHandle, struct tfFrictionHandle *handle);
 
CAPI_FUNC(HRESULT) tfFriction_getCoef(struct tfFrictionHandle *handle, tfFloatP_t *coef);
 
CAPI_FUNC(HRESULT) tfFriction_setCoef(struct tfFrictionHandle *handle, tfFloatP_t coef);
 
 
// Module functions //
 
 
CAPI_FUNC(HRESULT) tfForce_add(struct tfForceHandle *f1, struct tfForceHandle *f2, struct tfForceSumHandle *fSum);
 
 
#endif // _WRAPS_C_TFCFORCE_H_