Documentation Map

Table of Contents

• 1. Simulation Lifecycle
  • 1.1 Design and Setup
  • 1.2 Run and Monitor
  • 1.3 Debug and Validate
• 2. Configuration and Artifacts
  • 2.1 YAML Contracts and Ingestion
  • 2.2 Runtime and Artifacts
• 3. Numerical Methods and Models
• 4. Runtime and Source Architecture
• 5. Operations and Quality
• 6. Repository and Documentation Navigation
• 7. Generated Reference Views
  • CFD Reader Guidance and Practical Use
    • What To Extract Before Changing A Case
    • Practical CFD Troubleshooting Pattern

This is the primary structural entry point for PICurv documentation. Use this page instead of the raw generated page dump.

1. Simulation Lifecycle

1.1 Design and Setup

• Installation Guide
• Tutorial: Your First Simulation (Flat Channel)
• Tutorial: Using a File-Based Grid (Bent Channel)
• Configuration Reference: Case YAML
• Configuration Reference: Solver YAML
• Configuration Reference: Monitor YAML
• Configuration Reference: Postprocessor YAML
• Grid Generator Guide: scripts/grid.gen
• Boundary Conditions Guide
• Particle Initialization and Restart Guide

1.2 Run and Monitor

• The Conductor Script: picurv
• Workflow Recipes and Config Cookbook
• Anatomy of a Simulation
• Run Lifecycle Guide
• Search Robustness Metrics Reference
• Cluster Run Guide (Slurm)
• Sweep and Study Guide
• Tutorial: A Guide to Visualizing Your Results

1.3 Debug and Validate

• Common Fatal Errors and Fixes
• Testing and Validation Guide
• Capabilities Summary

2. Configuration and Artifacts

2.1 YAML Contracts and Ingestion

• Configuration Contract (YAML -> Generated Artifacts -> Runtime)
• Developer Ingestion Map
• Configuration Extension Playbook
• Workflow Extensibility Guide
• Grid Generator Guide: scripts/grid.gen
• Workflow Recipes and Config Cookbook

2.2 Runtime and Artifacts

• Initial Condition Modes
• Particle Model and Coupling Overview
• Particle Initialization and Restart Guide
• Run Lifecycle Guide

3. Numerical Methods and Models

• Methods and Models Overview
• CurvIB Method Overview
• Fractional-Step (Projection) Method
• Dual-Time Picard RK4 Momentum Solver
• Pressure-Poisson, GMRES, and Multigrid
• Walking Search for Particle Location
• Trilinear Interpolation and Particle-Grid Projection
• Search Robustness Metrics Reference
• IEM Mixing and Statistical Averaging
• Momentum Solver Implementations
• Analytical Solution Modes

4. Runtime and Source Architecture

• Code Architecture
• Grid, Cell, and Variable Architecture Guide
• C Runtime Execution Map
• API Documentation Status

5. Operations and Quality

• Cluster Run Guide (Slurm)
• Sweep and Study Guide
• Common Fatal Errors and Fixes
• Testing and Validation Guide
• Maintenance Backlog and Low-Priority Fixes

6. Repository and Documentation Navigation

• Repository Navigation and Directory Guides
• Changelog

7. Generated Reference Views

This section is for maintainers who need code-symbol navigation views instead of prose guides.

• File List by type (headers/sources/scripts): files_structured.html
• Data Structures by solver module: annotated_structured.html
• Raw Doxygen indices (unstructured): files.html, annotated.html, globals.html

CFD Reader Guidance and Practical Use

This page describes Documentation Map within the PICurv workflow. For CFD users, the most reliable reading strategy is to map the page content to a concrete run decision: what is configured, what runtime stage it influences, and which diagnostics should confirm expected behavior.

Treat this page as both a conceptual reference and a runbook. If you are debugging, pair the method/procedure described here with monitor output, generated runtime artifacts under runs/<run_id>/config, and the associated solver/post logs so numerical intent and implementation behavior stay aligned.

What To Extract Before Changing A Case

• Identify which YAML role or runtime stage this page governs.
• List the primary control knobs (tolerances, cadence, paths, selectors, or mode flags).
• Record expected success indicators (convergence trend, artifact presence, or stable derived metrics).
• Record failure signals that require rollback or parameter isolation.

Practical CFD Troubleshooting Pattern

1. Reproduce the issue on a tiny case or narrow timestep window.
2. Change one control at a time and keep all other roles/configs fixed.
3. Validate generated artifacts and logs after each change before scaling up.
4. If behavior remains inconsistent, compare against a known-good baseline example and re-check grid/BC consistency.