Tissue Forge C 0.2.1
Interactive, particle-based physics, chemistry and biology modeling and simulation environment
Loading...
Searching...
No Matches
TissueForge_c.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_TISSUEFORGE_C_H_
26#define _WRAPS_C_TISSUEFORGE_C_H_
27
28#include "tf_port_c.h"
29
30#include "tfCBond.h"
32#include "tfCClipPlane.h"
33#include "tfCCluster.h"
34#include "tfCFlux.h"
35#include "tfCForce.h"
36#include "tfCLogger.h"
37#include "tfCParticle.h"
38#include "tfCPotential.h"
39#include "tfCSimulator.h"
40#include "tfCSpecies.h"
41#include "tfCStateVector.h"
42#include "tfCStyle.h"
43#include "tfCUniverse.h"
44#include "tfC_bind.h"
45#include "tfC_event.h"
46#include "tfC_io.h"
47#include "tfC_system.h"
48#include "tfC_util.h"
49
50#ifdef TF_WITHCUDA
51# include "tfC_cuda.h"
52#endif
53
54
56// Module functions //
58
59
67CAPI_FUNC(HRESULT) tfVersionStr(char **str, unsigned int *numChars);
68
76CAPI_FUNC(HRESULT) tfSystemNameStr(char **str, unsigned int *numChars);
77
85CAPI_FUNC(HRESULT) tfSystemVersionStr(char **str, unsigned int *numChars);
86
94CAPI_FUNC(HRESULT) tfCompilerIDStr(char **str, unsigned int *numChars);
95
103CAPI_FUNC(HRESULT) tfCompilerVersionStr(char **str, unsigned int *numChars);
104
112CAPI_FUNC(HRESULT) tfBuildDateStr(char **str, unsigned int *numChars);
113
121CAPI_FUNC(HRESULT) tfBuildTimeStr(char **str, unsigned int *numChars);
122
130CAPI_FUNC(HRESULT) tfVersionMajorStr(char **str, unsigned int *numChars);
131
139CAPI_FUNC(HRESULT) tfVersionMinorStr(char **str, unsigned int *numChars);
140
148CAPI_FUNC(HRESULT) tfVersionPatchStr(char **str, unsigned int *numChars);
149
155CAPI_FUNC(bool) tfHasCUDA();
156
160CAPI_FUNC(HRESULT) tfClose();
161
166CAPI_FUNC(HRESULT) tfShow();
167
175CAPI_FUNC(HRESULT) tfInit(char **argv, unsigned int nargs);
176
185CAPI_FUNC(HRESULT) tfInitC(struct tfSimulatorConfigHandle *conf, char **appArgv, unsigned int nargs);
186
195CAPI_FUNC(HRESULT) tfStep(tfFloatP_t until, tfFloatP_t dt);
196
203CAPI_FUNC(HRESULT) tfStop();
204
212CAPI_FUNC(HRESULT) tfStart();
213
220CAPI_FUNC(HRESULT) tfRun(tfFloatP_t et);
221
222
223#endif // _WRAPS_C_TISSUEFORGE_C_H_
HRESULT tfInit(char **argv, unsigned int nargs)
Main simulator init method.
HRESULT tfVersionMajorStr(char **str, unsigned int *numChars)
Tissue Forge major version.
HRESULT tfStart()
Starts the universe time evolution, and advanced the universe forward by timesteps in dt....
HRESULT tfStop()
Stops the universe time evolution. This essentially freezes the universe, everything remains the same...
HRESULT tfClose()
Closes the main window, while the application / simulation continues to run.
HRESULT tfBuildTimeStr(char **str, unsigned int *numChars)
Package build time.
HRESULT tfSystemVersionStr(char **str, unsigned int *numChars)
System version.
HRESULT tfStep(tfFloatP_t until, tfFloatP_t dt)
Integrates the universe for a duration as given by until, or for a single time step if 0 is passed.
HRESULT tfRun(tfFloatP_t et)
Runs the event loop until all windows close or simulation time expires. Automatically performs univer...
HRESULT tfVersionPatchStr(char **str, unsigned int *numChars)
Tissue Forge patch version.
HRESULT tfBuildDateStr(char **str, unsigned int *numChars)
Package build date.
HRESULT tfVersionMinorStr(char **str, unsigned int *numChars)
Tissue Forge minor version.
HRESULT tfShow()
Shows any windows that were specified in the config. Does not start the universe time propagation unl...
HRESULT tfInitC(struct tfSimulatorConfigHandle *conf, char **appArgv, unsigned int nargs)
Main simulator init method.
bool tfHasCUDA()
Test whether the installation supports CUDA.
HRESULT tfVersionStr(char **str, unsigned int *numChars)
Tissue Forge version.
HRESULT tfSystemNameStr(char **str, unsigned int *numChars)
System name.
HRESULT tfCompilerIDStr(char **str, unsigned int *numChars)
Package compiler ID.
HRESULT tfCompilerVersionStr(char **str, unsigned int *numChars)
Package compiler version.
Handle to a Simulator::Config instance.
Definition tfCSimulator.h:43