Tissue Forge C++ 0.2.1
Interactive, particle-based physics, chemistry and biology modeling and simulation environment
Loading...
Searching...
No Matches
tf_runtime.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 _INCLUDE_TF_RUNTIME_H_
26#define _INCLUDE_TF_RUNTIME_H_
27
28#include <stdio.h>
29
30#include <tfSimulator.h>
31#include <tf_bind.h>
32#include <tf_util.h>
33#include <tfCluster.h>
34#include <tfFlux.h>
37#include <io/tfIO.h>
39#include <rendering/tfKeyEvent.h>
41#include <rendering/tfStyle.h>
42#include <state/tfSpeciesValue.h>
43
44
45namespace TissueForge {
46
47
53 CPPAPI_FUNC(std::string) version_str();
54
60 CPPAPI_FUNC(std::string) systemNameStr();
61
67 CPPAPI_FUNC(std::string) systemVersionStr();
68
74 CPPAPI_FUNC(std::string) compilerIdStr();
75
81 CPPAPI_FUNC(std::string) compilerVersionStr();
82
88 CPPAPI_FUNC(std::string) buildDate();
89
95 CPPAPI_FUNC(std::string) buildTime();
96
102 CPPAPI_FUNC(bool) hasCuda();
103
109 CPPAPI_FUNC(HRESULT) initialize(int args);
110
114 CPPAPI_FUNC(HRESULT) close();
115
120 CPPAPI_FUNC(HRESULT) show();
121
125 CPPAPI_FUNC(HRESULT) init(const std::vector<std::string> &argv);
126
130 CPPAPI_FUNC(HRESULT) init(Simulator::Config &conf, const std::vector<std::string> &appArgv=std::vector<std::string>());
131
140 CPPAPI_FUNC(HRESULT) step(const FloatP_t &until=0, const FloatP_t &dt=0);
141
146 CPPAPI_FUNC(HRESULT) stop();
147
153 CPPAPI_FUNC(HRESULT) start();
154
161 CPPAPI_FUNC(HRESULT) run(FloatP_t et=-1);
162
163};
164
165#endif // _INCLUDE_TF_RUNTIME_H_
Include Python header, disable linking to pythonX_d.lib on Windows in debug mode.
Definition tfAngleConfig.h:26
HRESULT show()
Shows any windows that were specified in the config. Does not start the universe time propagation unl...
HRESULT initialize(int args)
Initialization method that may be a mandatory first call, depending on the runtime scenario.
HRESULT close()
Closes the main window, while the application / simulation continues to run.
HRESULT stop()
Stops the universe time evolution. This essentially freezes the universe, everything remains the same...
std::string version_str()
Installation version.
HRESULT init(const std::vector< std::string > &argv)
std::string compilerVersionStr()
Compiler version.
HRESULT run(FloatP_t et=-1)
Runs the event loop until all windows close or simulation time expires. Automatically performs univer...
std::string buildDate()
Build data.
std::string compilerIdStr()
Compiler id.
HRESULT step(const FloatP_t &until=0, const FloatP_t &dt=0)
Performs a single time step dt of the universe if no arguments are given. Optionally runs until until...
std::string systemNameStr()
System name.
bool hasCuda()
Flag for whether the installation supports CUDA.
std::string buildTime()
Build time.
std::string systemVersionStr()
System version.
HRESULT start()
Starts the universe time evolution, and advanced the universe forward by timesteps in dt....
Definition tfSimulator.h:368
int32_t HRESULT
Definition tf_port.h:255