FLAME GPU 2
Contents:
Quickstart Guide
Quickstart Guide
User Guide
First Steps
FLAMEGPU2 Design Philosophy
Creating a Project
Structure of a FLAMEGPU2 Program
Agent/Host Function Definitions
Model Declaration
Initialisation
Execution
Defining a Model
Creating a Model
What is a Model?
Creating a ModelDescription Object
More Info
Adding Environmental Properties
What is an Environment?
Creating an EnvironmentDescription Object
Defining Environmental Properties
Attaching the Environment to a Model
Full Example Code From This Page
More Info
Defining Agents
Defining a New Agent Type
Agent Variables
Agent Array Variables
Agent States
Full Example Code From This Page
More Info
Defining Behaviours
Defining Agent Functions
What is an Agent Function?
Defining an Agent Function
Defining a Runtime-Compiled Agent Function (C++)
FLAMEGPU Device Functions
FLAMEGPU Host Device Functions
Full Example Code From This Page
More Info
Modifying Agent Variables
Interacting with the Environment
Agent Communication
Defining Messages
Sending Messages
Reading Messages
Conditional Behaviours
Agent Function Conditions
Initial Conditions
Agent Populations
Creating an Agent Population
Initialising Agent Variables
Initialising a Population
Accessing a Single Agent
Random Number Generation
Initialisation from Disk
Running a Simulation
Defining Execution Order
Specifying Dependencies
Accessing the DependencyGraph
Specifying Roots
Generating Layers
Visualising the Dependencies
Manual Layer Specification
Launching a Simulation
Simulation Exit Conditions
Max Steps
Conditional Exit
Collecting Data
Saving Agent State
Collecting Other Information
Agent Birth/Death
Agent Birth from Agent Functions
Agent Creation Overview
Enabling Agent Creation
Creating the New Agent
Conditional Agent Creation
Full Example Code From This Page
More Info
Agent Birth from Host Functions
Agent Death
Enabling Agent Death
Agent Death
More Info
Submodels
Defining a Submodel
SubModel Definition
Running Multiple Simulations
Launching Ensembles
Visualisation
Building with Visualisation
Default Visualisation
Custom Models
Custom Colours
Custom Models
Performance Troubleshooting
Performance Troubleshooting
Building or Modifying the FGPU2 Source
Building FGPU2 from Source
Requesting Features
Contributing to FLAMEGPU2
Reporting Bugs
Submitting Pull Requests
License
Example Documentation
Boids Brute Force
Library API
Full API
Namespaces
Namespace @142
Namespace @195
Namespace curve_internal
Namespace FGPU_SA
Namespace flamegpu_internal
Namespace jitify
Namespace jitify::experimental
Namespace std
Namespace Stock
Namespace Stock::Colors
Namespace Stock::Palettes
Namespace tinyxml2
Namespace util
Namespace util::compute_capability
Namespace util::filesystem
Namespace util::nvtx
Classes and Structs
Struct AgentData
Struct AgentFunctionData
Struct AgentLogFrame
Struct AgentVariable
Struct Any
Struct Color
Struct CUDAEnsemble::EnsembleConfig
Struct CUDAFatAgent::AgentState
Struct CUDAFatAgent::AgentState_hash
Struct CUDAFatAgent::NewBuffer
Struct CUDAScanCompactionConfig
Struct CUDAScanCompactionPtrs
Struct CUDAScatter::InversionIterator
Struct CUDAScatter::ScatterData
Struct CUDAScatter::StreamData
Struct CUDASimulation::Config
Struct CUDASimulation::Singletons
Struct CurveRTCHost::RTCEnvVariableProperties
Struct CurveRTCHost::RTCVariableProperties
Template Struct CurveStringHash
Template Struct CurveStringHash< N, 1 >
Struct DeviceAgentVector_impl::VariableBufferPair
Struct DeviceExceptionBuffer
Struct EnvironmentDescription::PropData
Struct EnvironmentManager::DefragProp
Struct EnvironmentManager::EnvProp
Struct EnvironmentManager::EnvUpdateFlags
Struct EnvironmentManager::MappedProp
Struct EnvironmentManager::NamePairHash
Struct EnvironmentManager::RTCEnvPropCache
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 >
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
Struct HostAPI::key_hash
Struct JitifyCache::CachedProgram
Struct LayerData
Struct LogFrame
Struct LoggingConfig::NameReductionFn
Struct ModelData
Struct MsgArray2D::Data
Struct MsgArray2D::MetaData
Struct MsgArray3D::Data
Struct MsgArray3D::MetaData
Struct MsgArray::Data
Struct MsgArray::MetaData
Struct MsgBruteForce::Data
Struct MsgBruteForce::MetaData
Struct MsgBucket::Data
Struct MsgBucket::MetaData
Struct MsgSpatial2D::Data
Struct MsgSpatial2D::GridPos2D
Struct MsgSpatial2D::MetaData
Struct MsgSpatial3D::Data
Struct MsgSpatial3D::GridPos3D
Struct MsgSpatial3D::MetaData
Struct NewAgentStorage
Struct Palette
Struct RunLog
Struct Simulation::Config
Template Struct hash< AgentVariable >
Template Struct hash< std::pair< std::string, unsigned int > >
Struct Dark2
Struct Greys
Struct Pastel
Struct PiYG
Struct RdYlBu
Struct Set1
Struct Set2
Struct Viridis
Struct YlGn
Struct YlOrRd
Struct StringPairHash
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 >
Struct Variable
Struct VariableBuffer
Struct VarOffsetStruct
Struct VarOffsetStruct::OffsetLen
Class AgentDescription
Class AgentFunctionDescription
Class AgentIDCollision
Class AgentInstance
Class AgentInterface
Class AgentLoggingConfig
Class AgentRandom
Class AgentStateVis
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 AgentVis
Class ArrayMessageWriteConflict
Class AutoPalette
Class ColorFunction
Class CUDAAgent
Class CUDAAgentStateList
Class CUDAEnsemble
Class CUDAError
Class CUDAFatAgent
Class CUDAFatAgentStateList
Class CUDAMessage
Class CUDAMessageList
Class CUDAScanCompaction
Class CUDAScatter
Class CUDASimulation
Class Curve
Class CurveException
Class CurveRTCHost
Class DependencyGraph
Class DependencyNode
Class DeviceAgentVector_impl
Template Class DeviceAPI
Class DeviceAPI::AgentOut
Class DeviceEnvironment
Class DeviceError
Class DeviceException
Class DeviceExceptionManager
Class DifferentModel
Template Class DiscreteColor
Class DuplicateEnvProperty
Class EnvDescriptionAlreadyLoaded
Class EnvironmentDescription
Class EnvironmentManager
Class ExpiredWeakPtr
Class FGPUException
Class GenericMemoryVector
Class HostAgentAPI
Class HostAPI
Class HostEnvironment
Class HostFunctionCallback
Class HostFunctionConditionCallback
Class HostFunctionDescription
Class HostNewAgentAPI
Class HostRandom
Class HSVInterpolation
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 InvalidEnvProperty
Class InvalidEnvPropertyType
Class InvalidFilePath
Class InvalidFuncLayerIndx
Class InvalidHashList
Class InvalidHostFunc
Class InvalidInputFile
Class InvalidLayerMember
Class InvalidMapEntry
Class InvalidMemoryCapacity
Class InvalidMessage
Class InvalidMessageData
Class InvalidMessageName
Class InvalidMessageSize
Class InvalidMessageType
Class InvalidMessageVar
Class InvalidOperation
Class InvalidParent
Class InvalidPopulationData
Class InvalidStateName
Class InvalidSubAgentName
Class InvalidSubModel
Class InvalidSubModelName
Class InvalidVarArrayLen
Class InvalidVarType
Class JitifyCache
Class jsonLogger
Class jsonReader
Class jsonReader_agentsize_counter
Class jsonReader_impl
Class jsonWriter
Class LayerDescription
Class LineVis
Class Logger
Class LoggingConfig
Template Class MemoryVector
Class ModelDescription
Class ModelVis
Class MsgArray
Class MsgArray2D
Class MsgArray2D::CUDAModelHandler
Class MsgArray2D::Description
Class MsgArray2D::In
Class In::Filter
Class Filter::iterator
Class Filter::Message
Class In::Message
Class MsgArray2D::Out
Class MsgArray3D
Class MsgArray3D::CUDAModelHandler
Class MsgArray3D::Description
Class MsgArray3D::In
Class In::Filter
Class Filter::iterator
Class Filter::Message
Class In::Message
Class MsgArray3D::Out
Class MsgArray::CUDAModelHandler
Class MsgArray::Description
Class MsgArray::In
Class In::Filter
Class Filter::iterator
Class Filter::Message
Class In::Message
Class MsgArray::Out
Class MsgBruteForce
Class MsgBruteForce::CUDAModelHandler
Class MsgBruteForce::Description
Class MsgBruteForce::In
Class In::iterator
Class In::Message
Class MsgBruteForce::Out
Class MsgBucket
Class MsgBucket::CUDAModelHandler
Class MsgBucket::Description
Class MsgBucket::In
Class In::Filter
Class Filter::iterator
Class Filter::Message
Class MsgBucket::Out
Class MsgNone
Class MsgNone::CUDAModelHandler
Class MsgNone::In
Class MsgNone::Out
Class MsgSpatial2D
Class MsgSpatial2D::CUDAModelHandler
Class MsgSpatial2D::Description
Class MsgSpatial2D::In
Class In::Filter
Class Filter::iterator
Class Filter::Message
Class MsgSpatial2D::Out
Class MsgSpatial3D
Class MsgSpatial3D::CUDAModelHandler
Class MsgSpatial3D::Description
Class MsgSpatial3D::In
Class In::Filter
Class Filter::iterator
Class Filter::Message
Class MsgSpatial3D::Out
Class MsgSpecialisationHandler
Class OutOfBoundsException
Class OutOfMemory
Class OutOfRangeVarArray
Class Palette::const_iterator
Class RandomManager
Class RapidJSONError
Class ReaderFactory
Class ReadOnlyDeviceAPI
Class ReadOnlyEnvProperty
Class ReservedName
Class RunPlan
Class RunPlanVec
Class SignalHandlers
Class SimLogger
Class SimRunner
Class Simulation
Class StateReader
Class StateWriter
Class StaticColor
Class StaticModelVis
Class StepLoggingConfig
Class SubAgentDescription
Class SubEnvironmentDescription
Class SubModelDescription
Class TinyXMLError
Class UnknownError
Class UnknownInternalError
Class UnsupportedFileType
Class UnsupportedVarType
Class UnsycnedCUDAEventTimer
Class CUDAEventTimer
Class NVTXRange
Class SteadyClockTimer
Class VersionMismatch
Class ViridisInterpolation
Class VisualisationException
Class WriterFactory
Class xmlLogger
Class xmlReader
Class xmlWriter
Enums
Enum FLAME_GPU_AGENT_STATUS
Enum FLAME_GPU_CONDITION_RESULT
Functions
Template Function agent_function_condition_wrapper
Template Function agent_function_wrapper
Function allocateIDs
Function atomicHistogram1D
Function atomicHistogram2D
Function atomicHistogram3D
Function broadcastInitKernel
Function generateCollisionFlags
Template Function getAgentVariableMaxFunc
Template Function getAgentVariableMeanFunc
Template Function getAgentVariableMinFunc
Template Function getAgentVariableStandardDevFunc
Template Function getAgentVariableSumFunc
Function getFileExt
Function getGridPosition2D
Function getGridPosition3D
Function getHash2D
Function getHash3D
Function gpuAssert(cudaError_t, const char *, int)
Function gpuAssert(CUresult, const char *, int)
Function gpuLaunchAssert
Function init_curand
Function initToThreadIndex
Function pbm_reorder_generic
Function reorder_array_messages
Function scatter_all_generic
Template Function scatter_generic
Function scatter_new_agents
Function scatter_position_generic
Function sortBuffer_kernel
Function util::compute_capability::checkComputeCapability
Function util::compute_capability::getComputeCapability
Function util::compute_capability::minimumCompiledComputeCapability
Function util::filesystem::recursive_create_dir
Function util::nvtx::pop
Function util::nvtx::push
Variables
Variable curve_internal::d_curve_error
Variable curve_internal::d_hashes
Variable curve_internal::d_lengths
Variable curve_internal::d_sizes
Variable curve_internal::d_variables
Variable curve_internal::h_curve_error
Variable flamegpu_internal::c_envPropBuffer
Variable flamegpu_internal::standard_deviation_add
Variable flamegpu_internal::STANDARD_DEVIATION_MEAN
Variable flamegpu_internal::STANDARD_DEVIATION_MEAN_mutex
Variable flamegpu_internal::standard_deviation_subtract_mean
Variable ID_NOT_SET
Variable ID_VARIABLE_NAME
Variable Stock::Colors::BLACK
Variable Stock::Colors::BLUE
Variable Stock::Colors::GREEN
Variable Stock::Colors::RED
Variable Stock::Colors::WHITE
Variable Stock::Palettes::DARK2
Variable Stock::Palettes::GREYS
Variable Stock::Palettes::PASTEL
Variable Stock::Palettes::PIYG
Variable Stock::Palettes::RDYLBU
Variable Stock::Palettes::SET1
Variable Stock::Palettes::SET2
Variable Stock::Palettes::YLGN
Variable Stock::Palettes::YLORRD
Variable util::nvtx::colourCount
Variable util::nvtx::palette
Defines
Define _SILENCE_EXPERIMENTAL_FILESYSTEM_DEPRECATION_WARNING
Define _SILENCE_EXPERIMENTAL_FILESYSTEM_DEPRECATION_WARNING
Define _SILENCE_EXPERIMENTAL_FILESYSTEM_DEPRECATION_WARNING
Define _SILENCE_EXPERIMENTAL_FILESYSTEM_DEPRECATION_WARNING
Define _SILENCE_EXPERIMENTAL_FILESYSTEM_DEPRECATION_WARNING
Define curveReportErrors
Define curveReportLastDeviceError
Define curveReportLastHostError
Define DERIVED_FGPUException
Define DTHROW
Define FGPUDEVICEEXCEPTION_CU
Define FLAMEGPU_AGENT_FUNCTION
Define FLAMEGPU_AGENT_FUNCTION_CONDITION
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_INIT_FUNCTION
Define FLAMEGPU_STEP_FUNCTION
Define gpuErrchk
Define gpuErrchkDriverAPI
Define gpuErrchkLaunch
Define INCLUDE_FLAMEGPU_RUNTIME_UTILITY_AGENTRANDOM_CUH_
Define INCLUDE_FLAMEGPU_RUNTIME_UTILITY_DEVICEENVIRONMENT_CUH_
Define INCLUDE_FLAMEGPU_RUNTIME_UTILITY_ENVIRONMENTMANAGER_CUH_
Define INCLUDE_FLAMEGPU_RUNTIME_UTILITY_HOSTENVIRONMENT_CUH_
Define INCLUDE_FLAMEGPU_RUNTIME_UTILITY_HOSTRANDOM_CUH_
Define INCLUDE_FLAMEGPU_RUNTIME_UTILITY_RANDOMMANAGER_CUH_
Define INCLUDE_FLAMEGPU_SIM_AGENTLOGGINGCONFIG_REDUCTIONS_CUH_
Define INCLUDE_FLAMEGPU_UTIL_COMPUTE_CAPABILITY_CUH_
Define INCLUDE_FLAMEGPU_UTIL_CUDAEVENTTIMER_CUH_
Define NVTX_POP
Define NVTX_PUSH
Define NVTX_RANGE
Define THROW
Define XMLCheckResult
Define XMLCheckResult
Define XMLCheckResult
Typedefs
Typedef AgentFunctionConditionWrapper
Typedef AgentFunctionWrapper
Typedef CUDAMsgMap
Typedef CUDAMsgMapPair
Typedef DeviceAgentVector
Typedef FGPU_SA::false_type
Typedef FGPU_SA::true_type
Typedef FLAMEGPU_EXIT_CONDITION_POINTER
Typedef FLAMEGPU_EXIT_FUNCTION_POINTER
Typedef FLAMEGPU_HOST_CONDITION_POINTER
Typedef FLAMEGPU_HOST_FUNCTION_POINTER
Typedef FLAMEGPU_INIT_FUNCTION_POINTER
Typedef FLAMEGPU_STEP_FUNCTION_POINTER
Typedef id_t
Typedef iDiscreteColor
Typedef IntT
Typedef StateMemoryMap
Typedef StateMemoryMapPair
Typedef StringPair
Typedef StringPairMap
Typedef StringPairUnorderedMap
Typedef uDiscreteColor
Typedef VariableMap
FLAME GPU 2
»
Search
Please activate JavaScript to enable the search functionality.