stim::simulation_description struct

Initialization parameters for stim::simulation.

Public variables

string_view id: An identifier for your simulation.
simulation_flags flags: Simulation flags.
const simulation_constants* constants: Constants used to tweak various aspects of the physics simulation.
workspace_description workspace: The workspace regions of your simulation.
environment* environment: The system environment context to use for allocations, threading, logging, et cetera.

Variable documentation

string_view stim::simulation_description::id

An identifier for your simulation.

This field is used in logging and error reporting.

simulation_flags stim::simulation_description::flags

Simulation flags.

const simulation_constants* stim::simulation_description::constants

Constants used to tweak various aspects of the physics simulation.

workspace_description stim::simulation_description::workspace

The workspace regions of your simulation.

This field indicates the 'sanity bounds' of the physics simulation, and affects things like soft-body constraint generation, volumetric fill area, et cetera.

environment* stim::simulation_description::environment

The system environment context to use for allocations, threading, logging, et cetera.