FLAME GPU 2 Logo

Contents:

  • Quickstart
    • Prerequisites
    • C++
      • Installation
      • Creating a New Project
      • Compiling Your Project
        • CMake GUI (Windows Only)
      • Running Your Project
    • Python 3
      • Installation
      • Building From Source
      • Creating a New Project
      • Running your project
  • User Guide
    • Creating a Model
      • What is a Model?
      • Creating a ModelDescription Object
      • Supported Types
    • Environmental Properties
      • Accessing the EnvironmentDescription Object
      • Defining Properties
      • Defining Macro Properties
      • Defining a Directed Graph
      • Related Links
    • Defining Agents
      • Defining a New Agent Type
      • Agent Variables
        • Agent ID
        • User Defined Variables
      • Agent States
      • Related Links
    • Defining Messages (Communication)
      • Communication Strategies
      • Defining a New Message Type
        • Brute Force Specialisation
        • Bucket Specialisation
        • Spatial Specialisation
        • Array Specialisation
      • Related Links
    • Agent Functions
      • Defining Agent Functions
        • C++ Compile Time Agent Functions
        • C++ and Python Runtime Compiled Agent Functions
        • FLAME GPU Python Agent Functions
        • FLAME GPU Device Functions
        • FLAME GPU Host Device Functions
        • Related Links
      • Accessing Agent Variables
        • Reading an Agent’s ID
        • Related Links
      • Accessing the Environment
        • Environment Properties
        • Environment Macro Properties
        • Environment Directed Graph
        • Related Links
      • Agent Communication
        • Sending Messages
        • Reading Messages
        • Related Links
      • Agent Birth & Death
        • Agent Death
        • Agent Birth
        • Related Links
      • Random Numbers
        • Related Links
      • Agent State Transitions
        • Agent Function Conditions (Conditional Behaviours)
      • Miscellaneous Methods
        • Related Links
    • Host Functions & Conditions
      • Defining Host Functions
        • Types of Host Function
        • Adding Host Functions to a Model
        • Related Links
      • Accessing the Environment
        • Environment Properties
        • Environment Macro Properties
        • Environment Directed Graph
        • Related Links
      • Agent Operations
        • Variable Reductions
        • Sorting Agents
        • Agent Creation
        • Direct Agent Access
        • Miscellaneous Methods
        • Related Links
      • Random Numbers
        • Seeding the Random State
        • Related Links
      • Miscellaneous Methods
        • Related Links
    • Defining Execution Order
      • Dependency Graph
        • Specifying Dependencies
        • Specifying Roots
        • Host Layer Functions
        • Generating Layers
        • Visualising the Dependencies
        • Accessing the DependencyGraph
        • Related Links
      • Layers
        • Manual Layer Specification
        • Layer Specification Rules
        • Related Links
      • Exit Conditions
        • Related Links
      • Submodels
        • Defining a Submodel
        • Related Links
    • Running a Simulation
      • Configuring Execution
        • Related Links
      • Overriding the Initial State
        • With Code
        • From File
        • Related Links
      • Collecting Data
        • Logging
        • Accessing the Complete Agent State
        • Additional Notes
        • Related Links
    • Running Multiple Simulations
      • Creating a CUDAEnsemble
      • Creating a RunPlanVector
      • Creating a Logging Configuration
      • Configuring & Running the Ensemble
      • Error Handling Within Ensembles
      • Distributed Ensembles via MPI
      • Related Links
    • Visualisation
      • Enabling Visualisation
        • Detecting Visualisation Support
      • Configuring a Visualisation
        • Visualisation Options
        • Visualising After Simulation Exit
        • Related Links
      • Visualising Agents
        • Agent Model
        • Agent Position
        • Agent Direction
        • Agent Scale
        • Agent Color
        • Agent States
        • Related Links
      • Visualising Additional Details
        • User Interface (Environment Properties)
        • Environment Directed Graphs
        • Lines
        • Models
        • Related Links
      • Visualisation Controls
    • Debugging Models
      • What is FLAMEGPU_SEATBELTS?
        • Enabling/Disabling FLAMEGPU_SEATBELTS
        • Understanding FLAMEGPU_SEATBELTS Exceptions
        • Related Links
      • Using Print Statements
        • Printing From Agent Functions
      • Logging Timeseries Data
        • Environment Macro Property Counters
        • Related Links
      • Using a Debugger
        • Windows
        • Linux
        • Related Links
    • Performance Troubleshooting
    • Building or Modifying the FLAME GPU 2 Source
      • Building FLAME GPU from Source
        • Related Links
      • Requesting Features
      • Contributing to FLAMEGPU2
        • Reporting Bugs
        • Submitting Pull Requests
        • License
    • Telemetry
      • When is Data sent
      • Where and How is Data Sent
      • What Data is Sent
      • Disabling Telemetry (Opt-out)
      • Developer Notes
  • Library API
    • Page Hierarchy
    • Full API
      • Namespaces
        • Namespace flamegpu
        • Namespace flamegpu::@224
        • Namespace flamegpu::detail
        • Namespace flamegpu::detail::@167
        • Namespace flamegpu::detail::compute_capability
        • Namespace flamegpu::detail::cuda
        • Namespace flamegpu::detail::curve
        • Namespace flamegpu::detail::cxxname
        • Namespace flamegpu::detail::StaticAssert
        • Namespace flamegpu::detail::wddm
        • Namespace flamegpu::exception
        • Namespace flamegpu::io
        • Namespace flamegpu::io::@172
        • Namespace flamegpu::io::@173
        • Namespace flamegpu::io::@178
        • Namespace flamegpu::util
        • Namespace flamegpu::util::nvtx
        • Namespace flamegpu::visualiser
        • Namespace flamegpu::visualiser::Stock
        • Namespace flamegpu::visualiser::Stock::Colors
        • Namespace flamegpu::visualiser::Stock::Palettes
        • Namespace rapidjson
        • Namespace std
      • Classes and Structs
        • Struct AgentData
        • Struct AgentFunctionData
        • Struct AgentLogFrame
        • Struct CUDAEnsemble::EnsembleConfig
        • Struct CUDASimulation::Config
        • Struct CUDASimulation::Singletons
        • Struct AbstractSimRunner::ErrorDetail
        • Struct AgentVariable
        • Struct AgentVariableHash
        • Struct Any
        • Struct CUDAEnvironmentDirectedGraphBuffers::Buffer
        • Struct CUDAFatAgent::AgentState
        • Struct CUDAFatAgent::AgentState_hash
        • Struct CUDAFatAgent::NewBuffer
        • Struct CUDAMacroEnvironment::MacroEnvProp
        • Struct CUDAScanCompactionConfig
        • Struct CUDAScanCompactionPtrs
        • Struct CUDAScatter::InversionIterator
        • Struct CUDAScatter::ScatterData
        • Struct CUDAScatter::StreamData
        • Struct CurveRTCHost::RTCEnvMacroPropertyProperties
        • Struct CurveRTCHost::RTCEnvVariableProperties
        • Struct CurveRTCHost::RTCVariableProperties
        • Template Struct CurveStringHash
        • Template Struct CurveStringHash< N, 1 >
        • Struct CurveTable
        • Struct CustomMin
        • Template Struct Dims
        • Struct EnvironmentManager::DefragProp
        • Struct EnvironmentManager::EnvProp
        • Struct EnvironmentManager::MappedProp
        • Struct JitifyCache::CachedProgram
        • Struct ReverseIterator
        • Struct SharedBlock
        • Struct standard_deviation_add_impl
        • Template Struct standard_deviation_add_impl::binary_function
        • Struct standard_deviation_subtract_mean_impl
        • Template Struct standard_deviation_subtract_mean_impl::unary_function
        • Template Struct _Cat_base
        • Template Struct _Is_IntType
        • Template Struct _Is_RealType
        • Template Struct integral_constant
        • Template Struct is_same
        • Template Struct is_same< _Ty1, _Ty1 >
        • Template Struct type_decode
        • Struct VariableBuffer
        • Struct DeviceAgentVector_impl::VariableBufferPair
        • Struct EnvironmentData
        • Struct EnvironmentData::MacroPropData
        • Struct EnvironmentData::PropData
        • Struct EnvironmentDirectedGraphData
        • Struct DeviceExceptionBuffer
        • Struct ExitLogFrame
        • Struct HostMacroProperty_MetaData
        • Struct LayerData
        • Struct LogFrame
        • Struct LoggingConfig::NameReductionFn
        • Struct MessageArray2D::Data
        • Struct MessageArray2D::MetaData
        • Struct MessageArray3D::Data
        • Struct MessageArray3D::MetaData
        • Struct MessageArray::Data
        • Struct MessageArray::MetaData
        • Struct MessageBruteForce::Data
        • Struct MessageBruteForce::MetaData
        • Struct MessageBucket::Data
        • Struct MessageBucket::MetaData
        • Struct MessageSpatial2D::Data
        • Struct MessageSpatial2D::GridPos2D
        • Struct MessageSpatial2D::MetaData
        • Struct MessageSpatial3D::Data
        • Struct MessageSpatial3D::GridPos3D
        • Struct MessageSpatial3D::MetaData
        • Struct ModelData
        • Struct NewAgentStorage
        • Struct RunLog
        • Struct RunLog::PerformanceSpecs
        • Struct Simulation::Config
        • Struct StepLogFrame
        • Struct SubAgentData
        • Struct SubEnvironmentData
        • Struct SubModelData
        • Template Struct sum_input_t
        • Template Struct sum_input_t< char >
        • Template Struct sum_input_t< double >
        • Template Struct sum_input_t< float >
        • Template Struct sum_input_t< int16_t >
        • Template Struct sum_input_t< int32_t >
        • Template Struct sum_input_t< int64_t >
        • Template Struct sum_input_t< int8_t >
        • Template Struct sum_input_t< uint16_t >
        • Template Struct sum_input_t< uint32_t >
        • Template Struct sum_input_t< uint64_t >
        • Template Struct sum_input_t< uint8_t >
        • Template Struct PairCompare
        • Template Struct PairHash
        • Struct Variable
        • Struct VarOffsetStruct
        • Struct VarOffsetStruct::OffsetLen
        • Struct AgentStateVisData
        • Struct AgentVisData
        • Struct Color
        • Struct EnvironmentGraphVisData
        • Struct ModelVisData
        • Struct Palette
        • Struct Dark2
        • Struct Greys
        • Struct Pastel
        • Struct PiYG
        • Struct RdYlBu
        • Struct Set1
        • Struct Set2
        • Struct Viridis
        • Struct YlGn
        • Struct YlOrRd
        • Class AgentDescription
        • Class AgentFunctionDescription
        • Class AgentInstance
        • Class AgentLoggingConfig
        • Class AgentRandom
        • Class AgentVector
        • Class AgentVector::const_iterator
        • Class AgentVector::const_reverse_iterator
        • Class AgentVector::iterator
        • Class AgentVector::reverse_iterator
        • Class AgentVector_Agent
        • Class AgentVector_CAgent
        • Class CAgentDescription
        • Class CAgentFunctionDescription
        • Class CEnvironmentDescription
        • Class CEnvironmentDirectedGraphDescription
        • Class CLayerDescription
        • Class CSubAgentDescription
        • Class CSubEnvironmentDescription
        • Class CSubModelDescription
        • Class CUDAEnsemble
        • Class CUDASimulation
        • Class DependencyGraph
        • Class DependencyNode
        • Class AbstractSimRunner
        • Class AgentInterface
        • Class CubTemporaryMemory
        • Class CUDAAgent
        • Class CUDAAgentStateList
        • Class CUDAEnvironmentDirectedGraphBuffers
        • Class CUDAEventTimer
        • Class CUDAFatAgent
        • Class CUDAFatAgentStateList
        • Class CUDAMacroEnvironment
        • Class CUDAMessage
        • Class CUDAMessageList
        • Class CUDAScanCompaction
        • Class CUDAScatter
        • Class Curve
        • Class CurveRTCHost
        • Class DeviceCurve
        • Class HostCurve
        • Class DeviceStrings
        • Class EnvironmentManager
        • Class GenericMemoryVector
        • Class JitifyCache
        • Template Class MemoryVector
        • Class MPIEnsemble
        • Class MPISimRunner
        • Class RandomManager
        • Class SignalHandlers
        • Class SimLogger
        • Class SimRunner
        • Class SteadyClockTimer
        • Class TestSuiteTelemetry
        • Class Timer
        • Class DeviceAgentVector_impl
        • Template Class DeviceAPI
        • Class DeviceAPI::AgentOut
        • Class DeviceEnvironment
        • Class DeviceEnvironmentDirectedGraph
        • Class DeviceEnvironmentDirectedGraph::InEdgeFilter
        • Class InEdgeFilter::Edge
        • Class InEdgeFilter::iterator
        • Class DeviceEnvironmentDirectedGraph::OutEdgeFilter
        • Class OutEdgeFilter::Edge
        • Class OutEdgeFilter::iterator
        • Template Class DeviceMacroProperty
        • Class EnvironmentDescription
        • Class EnvironmentDirectedGraphDescription
        • Class AgentIDCollision
        • Class ArrayMessageWriteConflict
        • Class CUDAError
        • Class CurveException
        • Class DeviceError
        • Class DeviceExceptionManager
        • Class DifferentModel
        • Class DuplicateEnvProperty
        • Class EnsembleError
        • Class EnvDescriptionAlreadyLoaded
        • Class ExpiredWeakPtr
        • Class FileAlreadyExists
        • Class FLAMEGPUException
        • Class IDCollision
        • Class IDNotSet
        • Class IDOutOfBounds
        • Class InvalidAgent
        • Class InvalidAgentFunc
        • Class InvalidAgentName
        • Class InvalidAgentState
        • Class InvalidAgentVar
        • Class InvalidArgument
        • Class InvalidCudaAgent
        • Class InvalidCudaAgentDesc
        • Class InvalidCudaAgentMapSize
        • Class InvalidCudaAgentState
        • Class InvalidCUDAComputeCapability
        • Class InvalidCUDAdevice
        • Class InvalidCudaMessage
        • Class InvalidDependencyGraph
        • Class InvalidEnvGraph
        • Class InvalidEnvProperty
        • Class InvalidEnvPropertyType
        • Class InvalidFilePath
        • Class InvalidFuncLayerIndx
        • Class InvalidGraphName
        • Class InvalidGraphProperty
        • Class InvalidHostFunc
        • Class InvalidID
        • Class InvalidInputFile
        • Class InvalidLayerMember
        • Class InvalidMemoryCapacity
        • Class InvalidMessage
        • Class InvalidMessageData
        • Class InvalidMessageName
        • Class InvalidMessageType
        • Class InvalidMessageVar
        • Class InvalidOperation
        • Class InvalidParent
        • Class InvalidStateName
        • Class InvalidSubAgentName
        • Class InvalidSubModel
        • Class InvalidSubModelName
        • Class InvalidVarArrayLen
        • Class InvalidVarType
        • Class OutOfBoundsException
        • Class OutOfMemory
        • Class OutOfRangeVarArray
        • Class RapidJSONError
        • Class ReadOnlyEnvProperty
        • Class ReservedName
        • Class TimerException
        • Class TinyXMLError
        • Class UnknownError
        • Class UnknownInternalError
        • Class UnsupportedFileType
        • Class UnsupportedVarType
        • Class VersionMismatch
        • Class VisualisationException
        • Class HostAgentAPI
        • Class HostAPI
        • Class HostConditionCallback
        • Class HostEnvironment
        • Class HostEnvironmentDirectedGraph
        • Class HostEnvironmentDirectedGraph::EdgeMap
        • Class EdgeMap::Edge
        • Class HostEnvironmentDirectedGraph::VertexMap
        • Class VertexMap::Vertex
        • Class HostFunctionCallback
        • Class HostFunctionDescription
        • Template Class HostMacroProperty
        • Class HostNewAgentAPI
        • Class HostRandom
        • Class JSONGraphReader
        • Class JSONGraphWriter
        • Class JSONLogger
        • Class JSONStateReader
        • Class JSONStateReader_agentsize_counter
        • Class JSONStateReader_impl
        • Class JSONStateWriter
        • Class Logger
        • Class LoggerFactory
        • Class StateReader
        • Class StateReaderFactory
        • Class StateWriter
        • Class StateWriterFactory
        • Class Telemetry
        • Class XMLLogger
        • Class XMLStateReader
        • Class XMLStateWriter
        • Class LayerDescription
        • Class LoggingConfig
        • Class MessageArray
        • Class MessageArray2D
        • Class MessageArray2D::CDescription
        • Class MessageArray2D::CUDAModelHandler
        • Class MessageArray2D::Description
        • Class MessageArray2D::In
        • Class In::Filter
        • Class Filter::iterator
        • Class Filter::Message
        • Class In::Message
        • Class In::VonNeumannFilter
        • Class VonNeumannFilter::iterator
        • Class VonNeumannFilter::Message
        • Class In::VonNeumannWrapFilter
        • Class VonNeumannWrapFilter::iterator
        • Class VonNeumannWrapFilter::Message
        • Class In::WrapFilter
        • Class WrapFilter::iterator
        • Class WrapFilter::Message
        • Class MessageArray2D::Out
        • Class MessageArray3D
        • Class MessageArray3D::CDescription
        • Class MessageArray3D::CUDAModelHandler
        • Class MessageArray3D::Description
        • Class MessageArray3D::In
        • Class In::Filter
        • Class Filter::iterator
        • Class Filter::Message
        • Class In::Message
        • Class In::VonNeumannFilter
        • Class VonNeumannFilter::iterator
        • Class VonNeumannFilter::Message
        • Class In::VonNeumannWrapFilter
        • Class VonNeumannWrapFilter::iterator
        • Class VonNeumannWrapFilter::Message
        • Class In::WrapFilter
        • Class WrapFilter::iterator
        • Class WrapFilter::Message
        • Class MessageArray3D::Out
        • Class MessageArray::CDescription
        • Class MessageArray::CUDAModelHandler
        • Class MessageArray::Description
        • Class MessageArray::In
        • Class In::Filter
        • Class Filter::iterator
        • Class Filter::Message
        • Class In::Message
        • Class In::WrapFilter
        • Class WrapFilter::iterator
        • Class WrapFilter::Message
        • Class MessageArray::Out
        • Class MessageBruteForce
        • Class MessageBruteForce::CDescription
        • Class MessageBruteForce::CUDAModelHandler
        • Class MessageBruteForce::Description
        • Class MessageBruteForce::In
        • Class In::iterator
        • Class In::Message
        • Class MessageBruteForce::Out
        • Class MessageBucket
        • Class MessageBucket::CDescription
        • Class MessageBucket::CUDAModelHandler
        • Class MessageBucket::Description
        • Class MessageBucket::In
        • Class In::Filter
        • Class Filter::iterator
        • Class Filter::Message
        • Class MessageBucket::Out
        • Class MessageNone
        • Class MessageNone::CUDAModelHandler
        • Class MessageNone::In
        • Class MessageNone::Out
        • Class MessageSpatial2D
        • Class MessageSpatial2D::CDescription
        • Class MessageSpatial2D::CUDAModelHandler
        • Class MessageSpatial2D::Description
        • Class MessageSpatial2D::In
        • Class In::Filter
        • Class Filter::iterator
        • Class Filter::Message
        • Class In::WrapFilter
        • Class WrapFilter::iterator
        • Class WrapFilter::Message
        • Class MessageSpatial2D::Out
        • Class MessageSpatial3D
        • Class MessageSpatial3D::CDescription
        • Class MessageSpatial3D::CUDAModelHandler
        • Class MessageSpatial3D::Description
        • Class MessageSpatial3D::In
        • Class In::Filter
        • Class Filter::iterator
        • Class Filter::Message
        • Class In::WrapFilter
        • Class WrapFilter::iterator
        • Class WrapFilter::Message
        • Class MessageSpatial3D::Out
        • Class MessageSpecialisationHandler
        • Class ModelDescription
        • Class ReadOnlyDeviceAPI
        • Class ReadOnlyDeviceEnvironment
        • Template Class ReadOnlyDeviceMacroProperty
        • Class RunPlan
        • Class RunPlanVector
        • Class Simulation
        • Class StepLoggingConfig
        • Class SubAgentDescription
        • Class SubEnvironmentDescription
        • Class SubModelDescription
        • Class Range
        • Class AgentStateVis
        • Class AgentVis
        • Class AutoPalette
        • Class ColorFunction
        • Template Class DiscreteColor
        • Class EnvironmentGraphVis
        • Class HSVInterpolation
        • Class LineVis
        • Class ModelVis
        • Class Palette::const_iterator
        • Class PanelVis
        • Class StaticColor
        • Class StaticModelVis
        • Class ViridisInterpolation
      • Enums
        • Enum AGENT_STATUS
        • Enum CONDITION_RESULT
        • Enum MessageSortingType
        • Enum Verbosity
      • Functions
        • Template Function flamegpu::agent_function_condition_wrapper
        • Template Function flamegpu::agent_function_wrapper
        • Function flamegpu::atomicHistogram1D
        • Function flamegpu::atomicHistogram2D
        • Function flamegpu::atomicHistogram3D
        • Function flamegpu::calculateSpatialHash
        • Function flamegpu::calculateSpatialHashFloat2
        • Function flamegpu::calculateSpatialHashFloat3
        • Function flamegpu::detail::allocateIDs
        • Function flamegpu::detail::broadcastInitKernel
        • Function flamegpu::detail::buildIDMap
        • Function flamegpu::detail::compute_capability::checkComputeCapability
        • Function flamegpu::detail::compute_capability::getComputeCapability
        • Function flamegpu::detail::compute_capability::getDeviceName
        • Function flamegpu::detail::compute_capability::getDeviceNames
        • Function flamegpu::detail::compute_capability::getNVRTCSupportedComputeCapabilties
        • Function flamegpu::detail::compute_capability::minimumCompiledComputeCapability
        • Function flamegpu::detail::compute_capability::selectAppropraiteComputeCapability
        • Function flamegpu::detail::cuda::cudaFree
        • Function flamegpu::detail::cuda::cudaFreeHost
        • Function flamegpu::detail::cuda::cuDevicePrimaryContextIsActive
        • Function flamegpu::detail::cxxname::getUnqualifiedName
        • Function flamegpu::detail::fillKVPairs
        • Function flamegpu::detail::fillKVPairs_inverted
        • Function flamegpu::detail::findBinStart
        • Function flamegpu::detail::generateCollisionFlags
        • Function flamegpu::detail::gpuAssert(cudaError_t, const char *, int)
        • Function flamegpu::detail::gpuAssert(CUresult, const char *, int)
        • Function flamegpu::detail::gpuLaunchAssert
        • Function flamegpu::detail::init_curand
        • Function flamegpu::detail::pbm_reorder_generic
        • Function flamegpu::detail::reorder_array_messages
        • Function flamegpu::detail::scatter_all_generic
        • Template Function flamegpu::detail::scatter_generic
        • Function flamegpu::detail::scatter_new_agents
        • Function flamegpu::detail::scatter_position_generic
        • Function flamegpu::detail::sm
        • Function flamegpu::detail::translateSrcDest
        • Function flamegpu::detail::validateSrcDest
        • Function flamegpu::detail::wddm::deviceIsWDDM(int)
        • Function flamegpu::detail::wddm::deviceIsWDDM()
        • Template Function flamegpu::getAgentVariableMaxFunc
        • Template Function flamegpu::getAgentVariableMeanFunc
        • Template Function flamegpu::getAgentVariableMinFunc
        • Template Function flamegpu::getAgentVariableStandardDevFunc
        • Template Function flamegpu::getAgentVariableSumFunc
        • Function flamegpu::getGridPosition2D
        • Function flamegpu::getGridPosition3D
        • Function flamegpu::getHash2D
        • Function flamegpu::getHash3D
        • Function flamegpu::initToThreadIndex
        • Function flamegpu::sortBuffer_kernel
        • Function flamegpu::util::cleanup
        • Function flamegpu::util::clearRTCDiskCache
        • Function flamegpu::util::dstrcmp
        • Function flamegpu::util::nvtx::pop
        • Function flamegpu::util::nvtx::push
      • Variables
        • Variable current_index
        • Variable current_variable_array_index
        • Variable edge_count
        • Variable filename
        • Variable flamegpu::detail::standard_deviation_add
        • Variable flamegpu::detail::STANDARD_DEVIATION_MEAN
        • Variable flamegpu::detail::STANDARD_DEVIATION_MEAN_mutex
        • Variable flamegpu::detail::standard_deviation_subtract_mean
        • Variable flamegpu::GRAPH_SOURCE_DEST_VARIABLE_NAME
        • Variable flamegpu::GRAPH_VERTEX_INDEX_MAP_VARIABLE_NAME
        • Variable flamegpu::GRAPH_VERTEX_IPBM_EDGES_VARIABLE_NAME
        • Variable flamegpu::GRAPH_VERTEX_IPBM_VARIABLE_NAME
        • Variable flamegpu::GRAPH_VERTEX_PBM_VARIABLE_NAME
        • Variable flamegpu::ID_NOT_SET
        • Variable flamegpu::ID_VARIABLE_NAME
        • Variable flamegpu::TELEMETRY_RANDOM_ID
        • Variable flamegpu::util::nvtx::colourCount
        • Variable flamegpu::util::nvtx::ENABLED
        • Variable flamegpu::util::nvtx::palette
        • Variable flamegpu::VERSION
        • Variable flamegpu::VERSION_BUILDMETADATA
        • Variable flamegpu::VERSION_FULL
        • Variable flamegpu::VERSION_MAJOR
        • Variable flamegpu::VERSION_MINOR
        • Variable flamegpu::VERSION_PATCH
        • Variable flamegpu::VERSION_PRERELEASE
        • Variable flamegpu::VERSION_STRING
        • Variable flamegpu::visualiser::Stock::Colors::BLACK
        • Variable flamegpu::visualiser::Stock::Colors::BLUE
        • Variable flamegpu::visualiser::Stock::Colors::GREEN
        • Variable flamegpu::visualiser::Stock::Colors::RED
        • Variable flamegpu::visualiser::Stock::Colors::WHITE
        • Variable flamegpu::visualiser::Stock::Palettes::DARK2
        • Variable flamegpu::visualiser::Stock::Palettes::GREYS
        • Variable flamegpu::visualiser::Stock::Palettes::PASTEL
        • Variable flamegpu::visualiser::Stock::Palettes::PIYG
        • Variable flamegpu::visualiser::Stock::Palettes::RDYLBU
        • Variable flamegpu::visualiser::Stock::Palettes::SET1
        • Variable flamegpu::visualiser::Stock::Palettes::SET2
        • Variable flamegpu::visualiser::Stock::Palettes::YLGN
        • Variable flamegpu::visualiser::Stock::Palettes::YLORRD
        • Variable graph
        • Variable last_source
        • Variable last_target
        • Variable lastKey
        • Variable metagraph
        • Variable mode
        • Variable next_id
        • Variable stream
        • Variable used_vertex_ids
        • Variable vertex_count
        • Variable vertex_id_map
      • Defines
        • Define DERIVED_FLAMEGPUException
        • Define DTHROW
        • Define FLAMEGPU_AGENT_FUNCTION
        • Define FLAMEGPU_AGENT_FUNCTION_CONDITION
        • Define FLAMEGPU_AGENT_FUNCTION_CONDITION_DECL
        • Define FLAMEGPU_AGENT_FUNCTION_CONDITION_DEF
        • Define FLAMEGPU_AGENT_FUNCTION_DECL
        • Define FLAMEGPU_AGENT_FUNCTION_DEF
        • Define FLAMEGPU_CUSTOM_REDUCTION
        • Define FLAMEGPU_CUSTOM_TRANSFORM
        • Define FLAMEGPU_DEVICE_FUNCTION
        • Define FLAMEGPU_EXIT_CONDITION
        • Define FLAMEGPU_EXIT_FUNCTION
        • Define FLAMEGPU_HOST_CONDITION
        • Define FLAMEGPU_HOST_DEVICE_FUNCTION
        • Define FLAMEGPU_HOST_FUNCTION
        • Define FLAMEGPU_HOST_FUNCTION_DECL
        • Define FLAMEGPU_HOST_FUNCTION_DEF
        • Define FLAMEGPU_INIT_FUNCTION
        • Define FLAMEGPU_STEP_FUNCTION
        • Define FLAMEGPU_VERSION
        • Define gpuErrchk
        • Define gpuErrchkDriverAPI
        • Define gpuErrchkLaunch
        • Define INCLUDE_FLAMEGPU_DETAIL_COMPUTE_CAPABILITY_CUH_
        • Define INCLUDE_FLAMEGPU_DETAIL_CUDA_CUH_
        • Define INCLUDE_FLAMEGPU_DETAIL_CUDAEVENTTIMER_CUH_
        • Define INCLUDE_FLAMEGPU_DETAIL_CURAND_CUH_
        • Define INCLUDE_FLAMEGPU_DETAIL_WDDM_CUH_
        • Define INCLUDE_FLAMEGPU_EXCEPTION_FLAMEGPUDEVICEEXCEPTION_CUH_
        • Define INCLUDE_FLAMEGPU_EXCEPTION_FLAMEGPUDEVICEEXCEPTION_DEVICE_CUH_
        • Define INCLUDE_FLAMEGPU_MODEL_AGENTFUNCTIONDATA_CUH_
        • Define INCLUDE_FLAMEGPU_MODEL_ENVIRONMENTDIRECTEDGRAPHDATA_CUH_
        • Define INCLUDE_FLAMEGPU_MODEL_ENVIRONMENTDIRECTEDGRAPHDESCRIPTION_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_AGENT_HOSTAGENTAPI_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_AGENTFUNCTION_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_AGENTFUNCTION_SHIM_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_AGENTFUNCTIONCONDITION_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_AGENTFUNCTIONCONDITION_SHIM_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_DETAIL_CURVE_CURVE_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_DETAIL_CURVE_CURVE_RTC_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_DETAIL_CURVE_DEVICECURVE_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_DETAIL_CURVE_HOSTCURVE_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_DEVICEAPI_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_ENVIRONMENT_DEVICEENVIRONMENT_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_ENVIRONMENT_DEVICEENVIRONMENTDIRECTEDGRAPH_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_ENVIRONMENT_DEVICEMACROPROPERTY_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_ENVIRONMENT_HOSTENVIRONMENT_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_ENVIRONMENT_HOSTENVIRONMENTDIRECTEDGRAPH_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_ENVIRONMENT_HOSTMACROPROPERTY_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_MESSAGING_MESSAGEARRAY2D_MESSAGEARRAY2DDEVICE_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_MESSAGING_MESSAGEARRAY3D_MESSAGEARRAY3DDEVICE_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_MESSAGING_MESSAGEARRAY_MESSAGEARRAYDEVICE_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_MESSAGING_MESSAGEBRUTEFORCE_MESSAGEBRUTEFORCEDEVICE_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_MESSAGING_MESSAGEBUCKET_MESSAGEBUCKETDEVICE_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_MESSAGING_MESSAGENONE_MESSAGENONEDEVICE_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_MESSAGING_MESSAGESPATIAL2D_MESSAGESPATIAL2DDEVICE_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_MESSAGING_MESSAGESPATIAL3D_MESSAGESPATIAL3DDEVICE_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_RANDOM_AGENTRANDOM_CUH_
        • Define INCLUDE_FLAMEGPU_RUNTIME_RANDOM_HOSTRANDOM_CUH_
        • Define INCLUDE_FLAMEGPU_SIMULATION_AGENTLOGGINGCONFIG_REDUCTIONS_CUH_
        • Define INCLUDE_FLAMEGPU_SIMULATION_DETAIL_CUBTEMPORARYMEMORY_CUH_
        • Define INCLUDE_FLAMEGPU_SIMULATION_DETAIL_CUDAENVIRONMENTDIRECTEDGRAPHBUFFERS_CUH_
        • Define INCLUDE_FLAMEGPU_SIMULATION_DETAIL_CUDAERRORCHECKING_CUH_
        • Define INCLUDE_FLAMEGPU_SIMULATION_DETAIL_CUDASCATTER_CUH_
        • Define INCLUDE_FLAMEGPU_SIMULATION_DETAIL_ENVIRONMENTMANAGER_CUH_
        • Define INCLUDE_FLAMEGPU_SIMULATION_DETAIL_RANDOMMANAGER_CUH_
        • Define MAP_GET
        • Define THROW
        • Define XMLCheckResult
        • Define XMLCheckResult
        • Define XMLCheckResult
      • Typedefs
        • Typedef flamegpu::AgentFunctionConditionWrapper
        • Typedef flamegpu::AgentFunctionWrapper
        • Typedef flamegpu::detail::CUDAMessageMap
        • Typedef flamegpu::detail::CUDAMessageMapPair
        • Typedef flamegpu::detail::curandState
        • Typedef flamegpu::detail::StateMemoryMap
        • Typedef flamegpu::detail::StateMemoryMapPair
        • Typedef flamegpu::detail::StaticAssert::false_type
        • Typedef flamegpu::detail::StaticAssert::true_type
        • Typedef flamegpu::DeviceAgentVector
        • Typedef flamegpu::Edge
        • Typedef flamegpu::EdgeMap
        • Typedef flamegpu::FLAMEGPU_EXIT_CONDITION_POINTER
        • Typedef flamegpu::FLAMEGPU_EXIT_FUNCTION_POINTER
        • Typedef flamegpu::FLAMEGPU_HOST_CONDITION_POINTER
        • Typedef flamegpu::FLAMEGPU_HOST_FUNCTION_POINTER
        • Typedef flamegpu::FLAMEGPU_INIT_FUNCTION_POINTER
        • Typedef flamegpu::FLAMEGPU_STEP_FUNCTION_POINTER
        • Typedef flamegpu::id_t
        • Typedef flamegpu::IntT
        • Typedef flamegpu::size_type
        • Typedef flamegpu::util::PairMap
        • Typedef flamegpu::util::PairUnorderedMap
        • Typedef flamegpu::util::StringPair
        • Typedef flamegpu::util::StringPairCompare
        • Typedef flamegpu::util::StringPairHash
        • Typedef flamegpu::util::StringPairMap
        • Typedef flamegpu::util::StringPairUnorderedMap
        • Typedef flamegpu::VariableMap
        • Typedef flamegpu::Vertex
        • Typedef flamegpu::VertexMap
        • Typedef flamegpu::visualiser::iDiscreteColor
        • Typedef flamegpu::visualiser::uDiscreteColor
  • Tutorial
    • FLAME GPU Design Philosophy
    • Creating a Project
    • Structure of a FLAME GPU 2 Program
      • Agent/Host Function Definitions
      • Model Declaration
      • Initialisation
      • Execution
    • Tutorial: Creating the Circles Model
      • Introducing The Circles Model
      • Configuring CMake
      • Opening the Project
      • Model Description
      • Message Description
      • Agent Description
      • Environment Description
      • Agent Function Description Implementation
      • Execution Order
      • Initialisation Function
      • Configuring the Simulation
      • Configuring Logging (Optional)
      • Visualisation Config (Optional)
      • Running the Simulation
      • Complete Tutorial Code
    • Related Links
  • Forum
FLAME GPU 2
  • File cleanup.h
  • View page source

File cleanup.h

↰ Parent directory (include/flamegpu/util)

Contents

  • Definition (include/flamegpu/util/cleanup.h)

  • Included By

  • Namespaces

Definition (include/flamegpu/util/cleanup.h)

  • Program Listing for File cleanup.h

Included By

  • File flamegpu.h

  • File cleanup.cu

Namespaces

  • Namespace flamegpu

  • Namespace flamegpu::util

© Copyright 2024, University of Sheffield.

Built with Sphinx using a theme provided by Read the Docs.