tfCFlux.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_TFCFLUX_H_
#define _WRAPS_C_TFCFLUX_H_
 
#include "tf_port_c.h"
 
#include "tfCParticle.h"
 
// Handles
 
struct CAPI_EXPORT tfFluxKindHandle {
    unsigned int FLUX_FICK;
    unsigned int FLUX_SECRETE;
    unsigned int FLUX_UPTAKE;
};

struct CAPI_EXPORT tfFluxHandle {
    void *tfObj;
};

struct CAPI_EXPORT tfFluxesHandle {
    void *tfObj;
};
 

// FluxKind //
 

CAPI_FUNC(HRESULT) tfFluxKindHandle_init(struct tfFluxKindHandle *handle);
 

// Flux //
 

CAPI_FUNC(HRESULT) tfFlux_getSize(struct tfFluxHandle *handle, unsigned int *size);

CAPI_FUNC(HRESULT) tfFlux_getKind(struct tfFluxHandle *handle, unsigned int index, unsigned int *kind);

CAPI_FUNC(HRESULT) tfFlux_getTypeIds(struct tfFluxHandle *handle, unsigned int index, unsigned int *typeid_a, unsigned int *typeid_b);

CAPI_FUNC(HRESULT) tfFlux_getCoef(struct tfFluxHandle *handle, unsigned int index, tfFloatP_t *coef);

CAPI_FUNC(HRESULT) tfFlux_setCoef(struct tfFluxHandle *handle, unsigned int index, tfFloatP_t coef);

CAPI_FUNC(HRESULT) tfFlux_getDecayCoef(struct tfFluxHandle *handle, unsigned int index, tfFloatP_t *decay_coef);

CAPI_FUNC(HRESULT) tfFlux_setDecayCoef(struct tfFluxHandle *handle, unsigned int index, tfFloatP_t decay_coef);

CAPI_FUNC(HRESULT) tfFlux_getTarget(struct tfFluxHandle *handle, unsigned int index, tfFloatP_t *target);

CAPI_FUNC(HRESULT) tfFlux_setTarget(struct tfFluxHandle *handle, unsigned int index, tfFloatP_t target);

CAPI_FUNC(HRESULT) tfFlux_getCutoff(struct tfFluxHandle *handle, unsigned int index, tfFloatP_t *cutoff);

CAPI_FUNC(HRESULT) tfFlux_setCutoff(struct tfFluxHandle *handle, unsigned int index, tfFloatP_t cutoff);
 

// Fluxes //
 

CAPI_FUNC(HRESULT) tfFluxes_getSize(struct tfFluxesHandle *handle, int *size);

CAPI_FUNC(HRESULT) tfFluxes_getFlux(struct tfFluxesHandle *handle, unsigned int index, struct tfFluxHandle *flux);
 

// Module functions //
 

CAPI_FUNC(HRESULT) tfFluxes_fluxFick(
    struct tfFluxesHandle *handle, 
    struct tfParticleTypeHandle *A, 
    struct tfParticleTypeHandle *B, 
    const char *name, 
    tfFloatP_t k, 
    tfFloatP_t decay, 
    tfFloatP_t cutoff
);

CAPI_FUNC(HRESULT) tfFluxes_secrete(
    struct tfFluxesHandle *handle, 
    struct tfParticleTypeHandle *A, 
    struct tfParticleTypeHandle *B, 
    const char *name, 
    tfFloatP_t k, 
    tfFloatP_t target, 
    tfFloatP_t decay, 
    tfFloatP_t cutoff
);

CAPI_FUNC(HRESULT) tfFluxes_uptake(
    struct tfFluxesHandle *handle, 
    struct tfParticleTypeHandle *A, 
    struct tfParticleTypeHandle *B, 
    const char *name, 
    tfFloatP_t k, 
    tfFloatP_t target, 
    tfFloatP_t decay, 
    tfFloatP_t cutoff
);
 
#endif // _WRAPS_C_TFCFLUX_H_