tfCUniverse.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_TFCUNIVERSE_H_
#define _WRAPS_C_TFCUNIVERSE_H_
 
#include "tf_port_c.h"
 
#include "tfCParticle.h"
#include "tfCBoundaryConditions.h"
 
// Handles

struct CAPI_EXPORT tfUniverseConfigHandle {
    void *tfObj;
};
 

// Universe //
 

CAPI_FUNC(HRESULT) tfUniverse_getDim(tfFloatP_t **dim);

CAPI_FUNC(HRESULT) tfUniverse_getIsRunning(bool *isRunning);

CAPI_FUNC(HRESULT) tfUniverse_getName(char **name, unsigned int *numChars);

CAPI_FUNC(HRESULT) tfUniverse_getVirial(tfFloatP_t **virial);

CAPI_FUNC(HRESULT) tfUniverse_getVirialT(struct tfParticleTypeHandle **phandles, unsigned int numTypes, tfFloatP_t **virial);

CAPI_FUNC(HRESULT) tfUniverse_getVirialO(tfFloatP_t *origin, tfFloatP_t radius, tfFloatP_t **virial);

CAPI_FUNC(HRESULT) tfUniverse_getVirialOT(
    struct tfParticleTypeHandle **phandles, 
    unsigned int numTypes, 
    tfFloatP_t *origin, 
    tfFloatP_t radius, 
    tfFloatP_t **virial
);

CAPI_FUNC(HRESULT) tfUniverse_getNumParts(unsigned int *numParts);

CAPI_FUNC(HRESULT) tfUniverse_getParticle(unsigned int pidx, struct tfParticleHandleHandle *handle);

CAPI_FUNC(HRESULT) tfUniverse_getCenter(tfFloatP_t **center);

CAPI_FUNC(HRESULT) tfUniverse_step(tfFloatP_t until, tfFloatP_t dt);

CAPI_FUNC(HRESULT) tfUniverse_stop();

CAPI_FUNC(HRESULT) tfUniverse_start();

CAPI_FUNC(HRESULT) tfUniverse_reset();

CAPI_FUNC(HRESULT) tfUniverse_resetSpecies();

CAPI_FUNC(HRESULT) tfUniverse_getTemperature(tfFloatP_t *temperature);

CAPI_FUNC(HRESULT) tfUniverse_getTime(tfFloatP_t *time);

CAPI_FUNC(HRESULT) tfUniverse_getDt(tfFloatP_t *dt);

CAPI_FUNC(HRESULT) tfUniverse_getBoundaryConditions(struct tfBoundaryConditionsHandle *bcs);

CAPI_FUNC(HRESULT) tfUniverse_getKineticEnergy(tfFloatP_t *ke);

CAPI_FUNC(HRESULT) tfUniverse_getNumTypes(int *numTypes);

CAPI_FUNC(HRESULT) tfUniverse_getCutoff(tfFloatP_t *cutoff);
 

// tfUniverseConfigHandle //
 

CAPI_FUNC(HRESULT) tfUniverseConfig_init(struct tfUniverseConfigHandle *handle);

CAPI_FUNC(HRESULT) tfUniverseConfig_destroy(struct tfUniverseConfigHandle *handle);

CAPI_FUNC(HRESULT) tfUniverseConfig_getDim(struct tfUniverseConfigHandle *handle, tfFloatP_t **dim);

CAPI_FUNC(HRESULT) tfUniverseConfig_setDim(struct tfUniverseConfigHandle *handle, tfFloatP_t *dim);

CAPI_FUNC(HRESULT) tfUniverseConfig_getCells(struct tfUniverseConfigHandle *handle, int **cells);

CAPI_FUNC(HRESULT) tfUniverseConfig_setCells(struct tfUniverseConfigHandle *handle, int *cells);

CAPI_FUNC(HRESULT) tfUniverseConfig_getCutoff(struct tfUniverseConfigHandle *handle, tfFloatP_t *cutoff);

CAPI_FUNC(HRESULT) tfUniverseConfig_setCutoff(struct tfUniverseConfigHandle *handle, tfFloatP_t cutoff);

CAPI_FUNC(HRESULT) tfUniverseConfig_getFlags(struct tfUniverseConfigHandle *handle, unsigned int *flags);

CAPI_FUNC(HRESULT) tfUniverseConfig_setFlags(struct tfUniverseConfigHandle *handle, unsigned int flags);

CAPI_FUNC(HRESULT) tfUniverseConfig_getDt(struct tfUniverseConfigHandle *handle, tfFloatP_t *dt);

CAPI_FUNC(HRESULT) tfUniverseConfig_setDt(struct tfUniverseConfigHandle *handle, tfFloatP_t dt);

CAPI_FUNC(HRESULT) tfUniverseConfig_getTemperature(struct tfUniverseConfigHandle *handle, tfFloatP_t *temperature);

CAPI_FUNC(HRESULT) tfUniverseConfig_setTemperature(struct tfUniverseConfigHandle *handle, tfFloatP_t temperature);

CAPI_FUNC(HRESULT) tfUniverseConfig_getNumThreads(struct tfUniverseConfigHandle *handle, unsigned int *numThreads);

CAPI_FUNC(HRESULT) tfUniverseConfig_setNumThreads(struct tfUniverseConfigHandle *handle, unsigned int numThreads);

CAPI_FUNC(HRESULT) tfUniverseConfig_getNumFluxSteps(struct tfUniverseConfigHandle *handle, unsigned int *numFluxSteps);

CAPI_FUNC(HRESULT) tfUniverseConfig_setNumFluxSteps(struct tfUniverseConfigHandle *handle, unsigned int numFluxSteps);

CAPI_FUNC(HRESULT) tfUniverseConfig_getIntegrator(struct tfUniverseConfigHandle *handle, unsigned int *integrator);

CAPI_FUNC(HRESULT) tfUniverseConfig_setIntegrator(struct tfUniverseConfigHandle *handle, unsigned int integrator);

CAPI_FUNC(HRESULT) tfUniverseConfig_getBoundaryConditions(struct tfUniverseConfigHandle *handle, struct tfBoundaryConditionsArgsContainerHandle *bargsHandle);

CAPI_FUNC(HRESULT) tfUniverseConfig_setBoundaryConditions(struct tfUniverseConfigHandle *handle, struct tfBoundaryConditionsArgsContainerHandle *bargsHandle);
 
#endif // _WRAPS_C_TFCUNIVERSE_H_