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
      • 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
        • Related Links
      • Agent Communication
        • Sending Messages
        • Reading Messages
        • Related Links
      • Agent Birth & Death
        • Agent Death
        • Agent Birth
        • Related Links
      • Random Numbers
        • Related Links
      • Agent Function Conditions (Conditional Behaviours)
        • Related Links
      • 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
        • 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
      • 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)
        • 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
  • 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
  • Search

© Copyright 2023, University of Sheffield.

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