FLAMEGPU Documentation and User guide

This is the FLAME GPU technical report and user guide documentation. This documentation has been migrated from the old LaTex documents. Changes can be made via pull request on the GitHub repo. If you are looking for the main FLAME GPU website then go to www.flamegpu.com.

• 1. Introduction
  • 1.1. High-Level Overview of FLAME GPU
  • 1.2. Purpose of This Document
• 2. FLAMEGPU Model Specification
  • 2.1. Introduction
  • 2.2. The Environment
    • 2.2.1. Simulation Constants (Global Variables)
    • 2.2.2. Function Files
    • 2.2.3. Initialisation Functions
    • 2.2.4. Step Functions
    • 2.2.5. Exit Functions
    • 2.2.6. Graph Data Structures
  • 2.3. Defining an X-Machine Agent
    • 2.3.1. Agent Memory
    • 2.3.2. Agent States
  • 2.4. Defining Messages
    • 2.4.1. Message Variables
    • 2.4.2. Non partitioned Messages
    • 2.4.3. Discrete Partitioned Messages
    • 2.4.4. Spatially Partitioned Messages
    • 2.4.5. Graph Edge Partitioned Messaging
    • 2.4.6. Message Partitioning and Agent Type Compatibility
  • 2.5. Defining an Agent function
    • 2.5.1. Agent Function Message Inputs
    • 2.5.2. Agent Function Message Outputs
    • 2.5.3. Agent Function X-Agent Outputs
    • 2.5.4. Function Conditions
    • 2.5.5. Global Function Conditions
  • 2.6. Function Layers
  • 2.7. Initial XML Agent Data
    • 2.7.1. Initial Simulation Constants
    • 2.7.2. Host-based Agent Creation
  • 2.8. Loading StaticGraph Data from Disk
  • 2.9. FLAME GPU variable types
• 3. Agent Function Scripts and the Simulation API
  • 3.1. Introduction
  • 3.2. Agent and Message Data Structures
  • 3.3. A Basic Agent Function
  • 3.4. Use of the Message Output Simulation API
  • 3.5. Use of the Message Input Simulation API
    • 3.5.1. Non Partitioned Message Iteration
    • 3.5.2. Spatially Partitioned Message Iteration
    • 3.5.3. Discrete Partitioned Message Iteration
    • 3.5.4. Graph Edge Partitioned Message Iteration
    • 3.5.5. Message Type Macro Definition
  • 3.6. Use of the Agent Output Simulation API
    • 3.6.1. Agent Creation from the Host
    • 3.6.2. Agent Creation from the Device
    • 3.6.3. Generating new agent IDs
  • 3.7. Using Random Number Generation
  • 3.8. Summary of Agent Function Arguments
  • 3.9. Host Simulation Hooks
    • 3.9.1. Initialisation Functions (API)
    • 3.9.2. Step Functions (API)
    • 3.9.3. Exit Functions (API)
  • 3.10. Runtime Host Functions
    • 3.10.1. Getting and Setting Simulation Constants (Global Variables)
    • 3.10.2. Getting Static Graph Data
    • 3.10.3. Sorting Agents
    • 3.10.4. Analytics Functions
    • 3.10.5. Accessing Agent Data
    • 3.10.6. Exiting the Simulation Early
  • 3.11. Instrumentation for timing and population sizes
• 4. FLAME GPU Simulation and Visualisation
  • 4.1. Introduction
  • 4.2. Generating a Functions File Template
  • 4.3. FLAME GPU Template Files
  • 4.4. Compilation Using Visual Studio
    • 4.4.1. Visual Studio Project Build Configurations
    • 4.4.2. Visual Studio Project Virtual File Structure
    • 4.4.3. Build Process
    • 4.4.4. FLAME GPU Build Rule Options
    • 4.4.5. Visual Studio Launch Configuration Command Arguments
  • 4.5. Compilation using Make (for Linux and Windows)
  • 4.6. Creating a New FLAME GPU Example Project
  • 4.7. Simulation Execution Modes and Options
    • 4.7.1. Console Mode
    • 4.7.2. Visualisation Mode
  • 4.8. Creating a Custom Visualisation
  • 4.9. Performance Tips
  • 4.10. Detailed profiling using NVTX
    • 4.10.1. Enabling NVTX Markers via makefile
    • 4.10.2. Enabling NVTX Markers in Visual Studio
  • 4.11. Parameter Exploration