Guides

Developer guides for building, configuring, and using DNDSR.

• Building DNDSR
  • Prerequisites
  • Building External Dependencies
  • CMake Module Architecture
  • Building C++ (Solvers and Libraries)
  • Building the Python Package
  • Type Stub Generation
  • CUDA Support
  • Running Tests
  • Build Mode Summary
  • Developer Tooling
• Project Structure
  • Directory Layout
  • C++ Source Organization (src/)
  • Python Package Organization (python/DNDSR/)
  • Test Organization
  • CMake Build Targets
• Style Guide
  • C++
  • Python
• Documentation Authoring Guide
  • Architecture overview
  • How content flows through both systems
  • Adding a new documentation page
  • Doxygen sidebar tree (main.dox)
  • Sphinx toctree stubs (docs/sphinx/)
  • Cross-referencing between pages
  • The doxygen_compat.py extension
  • Build system targets
  • Checklist for adding a page
• Python Geom Module - Mesh Reader Guide
  • Overview
  • Setup
  • Core Classes
  • Mesh Reading Workflow
  • Order Elevation (O1 → O2)
  • Mesh Bisection (h-refinement)
  • Periodic Meshes
  • Boundary Mesh Extraction
  • Wall Distance Computation
  • CUDA Device Offloading
  • VTK Output
  • Querying Mesh State
  • References
• Array Usage Guide
  • When to Use Which Array Type
  • Creating and Filling a Basic Array
  • Distributing Data with ParArray
  • Ghost Communication with ArrayTransformer
  • ArrayPair: the Typical Pattern
  • ArrayDof: Solver State Arrays
  • Python Array Interface
• Serialization Usage Guide
  • The Problem
  • Writing a Checkpoint
  • Reading a Checkpoint (Same Rank Count)
  • Reading on a Different Rank Count (Redistribution)
  • Cross-Solver Restart
  • Low-Level Array Serialization
• Geometry + CFV Usage Guide
  • When to Use Which Layer
  • Part 1: Mesh Building
  • Part 2: Mesh Topology – Arrays and Access Patterns
  • Part 3: Element Types and Node Coordinates
  • Part 4: Raw Quadrature (Without CFV)
  • Part 5: FiniteVolume – Geometric Integration Support
  • Part 6: VariationalReconstruction – High-Order Machinery
  • Part 7: Writing a PDE Solver on Top of CFV
  • Part 8: The Full Solver Loop
  • Part 9: Minimum Python Example
• Example Playground
  • Building Examples
  • Available Examples