User Guide

Comprehensive guides for all PyFDS features and capabilities.

Overview

The User Guide provides detailed documentation for creating FDS simulations with PyFDS. Each guide focuses on a specific aspect of simulation building.

Quick Navigation

• Building Simulations

  ---

  Learn the basics of creating and configuring simulations

  Building Simulations

• Computational Domain

  ---

  Define meshes and computational grids

  Domain Setup

• Geometry

  ---

  Create walls, floors, furniture, and obstacles

  Geometry Guide

• Boundary Conditions

  ---

  Set up vents, openings, and HVAC systems

  Boundaries

• Materials & Surfaces

  ---

  Define material properties and surface characteristics

  Materials Guide

• Fire Sources

  ---

  Create and configure fire sources

  Fire Sources

• Devices & Measurement

  ---

  Add sensors and measurement devices

  Devices Guide

• Time-Varying Properties

  ---

  Use RAMPs for time-dependent parameters

  RAMP Guide

• Control Logic

  ---

  Implement activation and control logic

  Controls Guide

• Initial Conditions

  ---

  Set initial temperature and velocity fields

  Initial Conditions

• Combustion

  ---

  Define custom fuel and combustion reactions

  Combustion Guide

• Global Settings

  ---

  Configure ambient conditions and solver parameters

  Global Settings

Guides by Topic

Getting Started

• Building Simulations - Create your first simulation
• Computational Domain - Set up the mesh
• Geometry - Add walls and obstacles

Fire and Combustion

• Fire Sources - Create fire sources
• Materials & Surfaces - Material properties
• Combustion - Custom fuel definitions

Measurement and Control

• Devices & Measurement - Add sensors
• Control Logic - Activation logic
• Time-Varying Properties - Time-dependent parameters

Advanced Topics

• Boundary Conditions - HVAC, vents, openings
• Initial Conditions - Initial fields
• Global Settings - Solver and ambient settings

Learning Path

Beginners

Start with these guides:

1. Building Simulations
2. Computational Domain
3. Fire Sources
4. Devices & Measurement

Intermediate

Expand your knowledge:

1. Geometry
2. Materials & Surfaces
3. Boundary Conditions
4. Time-Varying Properties

Advanced

Master complex features:

1. Control Logic
2. Combustion
3. Initial Conditions
4. Global Settings

---

Choose a topic above to begin, or start with Building Simulations →