TissueForge::UniverseConfig Struct Reference

Initialize an #engine with the given data. More...

#include <tfUniverse.h>

Collaboration diagram for TissueForge::UniverseConfig:

Public Member Functions
void	setBoundaryConditions (BoundaryConditionsArgsContainer *_bcArgs)

Public Attributes
FVector3	dim
iVector3	spaceGridSize
FloatP_t	cutoff
uint32_t	flags
uint32_t	maxTypes
FloatP_t	dt
long	start_step
FloatP_t	temp
int	nParticles
int	threads
unsigned int	nr_fluxsteps
EngineIntegrator	integrator
BoundaryConditionsArgsContainer *	boundaryConditionsPtr
FloatP_t	max_distance
uint32_t	timers_mask
long	timer_output_period

Detailed Description

Initialize an #engine with the given data.

The number of spatial cells in each cartesion dimension is floor( dim[i] / L[i] ), or the physical size of the space in that dimension divided by the minimum size size of each cell.

Parameters

e	The #engine to initialize.
dim	An array of three doubles containing the size of the space.
L	The minimum spatial cell edge length in each dimension.
cutoff	The maximum interaction cutoff to use.
period	A bitmask describing the periodicity of the domain (see space_periodic_full).
max_type	The maximum number of particle types that will be used by this engine.
flags	Bit-mask containing the flags for this engine.

Returns

#engine_err_ok or < 0 on error (see #engine_err).

Member Data Documentation

cutoff

FloatP_t TissueForge::UniverseConfig::cutoff

Global cutoff

dim

FVector3 TissueForge::UniverseConfig::dim

Dimensions of the universe

dt

FloatP_t TissueForge::UniverseConfig::dt

Simulation time step, in units of simulation time

integrator

EngineIntegrator TissueForge::UniverseConfig::integrator

Type of integrator

nr_fluxsteps

unsigned int TissueForge::UniverseConfig::nr_fluxsteps

Number of flux steps per simulation step

spaceGridSize

iVector3 TissueForge::UniverseConfig::spaceGridSize

Discretization of the universe

start_step

long TissueForge::UniverseConfig::start_step

Starting step of simulation

threads

int TissueForge::UniverseConfig::threads

Number of simulation threads

---

The documentation for this struct was generated from the following file:

• source/tfUniverse.h