TissueForge_c.h File Reference

#include "tf_port_c.h"
#include "tfCBond.h"
#include "tfCBoundaryConditions.h"
#include "tfCClipPlane.h"
#include "tfCCluster.h"
#include "tfCFlux.h"
#include "tfCForce.h"
#include "tfCLogger.h"
#include "tfCParticle.h"
#include "tfCPotential.h"
#include "tfCSimulator.h"
#include "tfCSpecies.h"
#include "tfCStateVector.h"
#include "tfCStyle.h"
#include "tfCUniverse.h"
#include "tfC_bind.h"
#include "tfC_event.h"
#include "tfC_io.h"
#include "tfC_system.h"
#include "tfC_util.h"

Include dependency graph for TissueForge_c.h:

Go to the source code of this file.

Functions
HRESULT	tfVersionStr (char **str, unsigned int *numChars)
	Tissue Forge version.
HRESULT	tfSystemNameStr (char **str, unsigned int *numChars)
	System name.
HRESULT	tfSystemVersionStr (char **str, unsigned int *numChars)
	System version.
HRESULT	tfCompilerIDStr (char **str, unsigned int *numChars)
	Package compiler ID.
HRESULT	tfCompilerVersionStr (char **str, unsigned int *numChars)
	Package compiler version.
HRESULT	tfBuildDateStr (char **str, unsigned int *numChars)
	Package build date.
HRESULT	tfBuildTimeStr (char **str, unsigned int *numChars)
	Package build time.
HRESULT	tfVersionMajorStr (char **str, unsigned int *numChars)
	Tissue Forge major version.
HRESULT	tfVersionMinorStr (char **str, unsigned int *numChars)
	Tissue Forge minor version.
HRESULT	tfVersionPatchStr (char **str, unsigned int *numChars)
	Tissue Forge patch version.
bool	tfHasCUDA ()
	Test whether the installation supports CUDA.
HRESULT	tfClose ()
	Closes the main window, while the application / simulation continues to run.
HRESULT	tfShow ()
	Shows any windows that were specified in the config. Does not start the universe time propagation unlike run.
HRESULT	tfInit (char **argv, unsigned int nargs)
	Main simulator init method.
HRESULT	tfInitC (struct tfSimulatorConfigHandle *conf, char **appArgv, unsigned int nargs)
	Main simulator init method.
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	tfStop ()
	Stops the universe time evolution. This essentially freezes the universe, everything remains the same, except time no longer moves forward.
HRESULT	tfStart ()
	Starts the universe time evolution, and advanced the universe forward by timesteps in dt. All methods to build and manipulate universe objects are valid whether the universe time evolution is running or stopped.
HRESULT	tfRun (tfFloatP_t et)
	Runs the event loop until all windows close or simulation time expires. Automatically performs universe time propogation.

Function Documentation

tfBuildDateStr()

HRESULT tfBuildDateStr	(	char **	str,
		unsigned int *	numChars )

Package build date.

Parameters

str	value
numChars	number of characters

Returns

S_OK on success

tfBuildTimeStr()

HRESULT tfBuildTimeStr	(	char **	str,
		unsigned int *	numChars )

Package build time.

Parameters

str	value
numChars	number of characters

Returns

S_OK on success

tfCompilerIDStr()

HRESULT tfCompilerIDStr	(	char **	str,
		unsigned int *	numChars )

Package compiler ID.

Parameters

str	value
numChars	number of characters

Returns

S_OK on success

tfCompilerVersionStr()

HRESULT tfCompilerVersionStr	(	char **	str,
		unsigned int *	numChars )

Package compiler version.

Parameters

str	value
numChars	number of characters

Returns

S_OK on success

tfHasCUDA()

bool tfHasCUDA

(

)

Test whether the installation supports CUDA.

Returns

true if CUDA is supported

tfInit()

HRESULT tfInit	(	char **	argv,
		unsigned int	nargs )

Main simulator init method.

Parameters

argv	initializer arguments
nargs	number of arguments

Returns

S_OK on success

tfInitC()

HRESULT tfInitC	(	struct tfSimulatorConfigHandle *	conf,
		char **	appArgv,
		unsigned int	nargs )

Main simulator init method.

Parameters

conf	configuration
appArgv	app arguments
nargs	number of app arguments

Returns

S_OK on success

tfRun()

HRESULT tfRun

(

tfFloatP_t

et

)

Runs the event loop until all windows close or simulation time expires. Automatically performs universe time propogation.

Parameters

et	period to execute, in units of simulation time; a negative number runs infinitely

tfStart()

HRESULT tfStart

(

)

Starts the universe time evolution, and advanced the universe forward by timesteps in dt. All methods to build and manipulate universe objects are valid whether the universe time evolution is running or stopped.

Returns

S_OK on success

tfStep()

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.

Parameters

until	period to execute, in units of simulation time.
dt	overrides the existing time step, and uses this value for time stepping; currently not supported.

Returns

S_OK on success

tfStop()

HRESULT tfStop

(

)

Stops the universe time evolution. This essentially freezes the universe, everything remains the same, except time no longer moves forward.

Returns

S_OK on success

tfSystemNameStr()

HRESULT tfSystemNameStr	(	char **	str,
		unsigned int *	numChars )

System name.

Parameters

str	value
numChars	number of characters

Returns

S_OK on success

tfSystemVersionStr()

HRESULT tfSystemVersionStr	(	char **	str,
		unsigned int *	numChars )

System version.

Parameters

str	value
numChars	number of characters

Returns

S_OK on success

tfVersionMajorStr()

HRESULT tfVersionMajorStr	(	char **	str,
		unsigned int *	numChars )

Tissue Forge major version.

Parameters

str	value
numChars	number of characters

Returns

S_OK on success

tfVersionMinorStr()

HRESULT tfVersionMinorStr	(	char **	str,
		unsigned int *	numChars )

Tissue Forge minor version.

Parameters

str	value
numChars	number of characters

Returns

S_OK on success

tfVersionPatchStr()

HRESULT tfVersionPatchStr	(	char **	str,
		unsigned int *	numChars )

Tissue Forge patch version.

Parameters

str	value
numChars	number of characters

Returns

S_OK on success

tfVersionStr()

HRESULT tfVersionStr	(	char **	str,
		unsigned int *	numChars )

Tissue Forge version.

Parameters

str	value
numChars	number of characters

Returns

S_OK on success