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

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
• Tutorial: Your First Simulation (Flat Channel)
• Tutorial: Using a File-Based Grid (Search Robustness)
• Configuration Reference: Case YAML
• Configuration Reference: Solver YAML
• Configuration Reference: Monitor YAML
• Configuration Reference: Postprocessor YAML
• Grid Generator Guide: generators/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 Artifact Lifecycle Contract
• Storage Management 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
• Capability Status Vocabulary — status words, the known-defect disclosure rule, and evidence facets
• Page Type Contract — the four page types, what each owes the reader, and what each must refuse
• Documentation Extension Framework — capability, family, and subsystem contracts, lifecycle gates, and concern modules
• Example Catalog — every shipped example, what it demonstrates, and its evidence kind
• Capability Evidence Matrix — capability-by-evidence view for assessing result credibility
• Troubleshooting by Symptom — symptom-driven diagnosis, cheapest checks first
• Glossary — PICurv terms, CFD terms used precisely, and renamed spellings
• Scientific Writing Handoff — what the foundational method pages owe, and the scaffolding already in place
• Case Design Guide — building a case from scratch, in the order the decisions constrain each other
• Invariant Contracts — guarantees the system maintains, and which are enforced versus merely tracked

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: generators/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 Artifact Lifecycle Contract
• Storage Management Guide

3. Numerical Methods and Models

• Methods and Models Overview
• CurvIB Method Overview
• Fractional-Step (Projection) Method
• Dual-Time Picard Jameson RK 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
• Newton–Krylov Momentum Solver — matrix-free Newton–Krylov momentum solver.
• Analytical Solution Modes

4. Runtime and Source Architecture

• Code Architecture
• Grid, Cell, and Variable Architecture Guide
• C Runtime Execution Map
• Field Identity and Layout Catalog — typed Eulerian and persistent particle field contracts
• Future Architecture Specifications — proposed-architecture status and dependency index
• Field Statistics — window semantics, weighting, checkpoint state, derived quantities, and extension points
• LES Turbulence Closure — subgrid closure formulation, the Germano-Lilly procedure, averaging, limiting, and diagnostics
• Field Statistics Planned Extensions — spatial targets, further products, histories, and their dependency order
• Function Identity and Observability Specification — deferred logging/profiling identity optimization
• API Documentation Status

5. Operations and Quality

• Cluster Run Guide (Slurm)
• Sweep and Study Guide
• Storage Management 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