Developer Portal

Table of Contents

• 1. Architecture and Contracts
• 2. Numerical Methods and Models
• 4. Suggested Contributor Read Path
• 5. Expected Outcomes

This section is for maintainers and contributors changing solver behavior, YAML contracts, or workflow logic. It emphasizes architecture boundaries, method-level reasoning, and safe extension points.

1. Architecture and Contracts

• Code Architecture: module boundaries and runtime ownership model.
• Configuration Contract (YAML -> Generated Artifacts -> Runtime): YAML -> generated artifact -> runtime contract.
• Developer Ingestion Map: where specific YAML keys enter C/Python paths.
• Configuration Extension Playbook: adding new keys/features safely.
• Workflow Extensibility Guide: extending orchestration beyond current run/sweep modes.
• C Runtime Execution Map: startup/timestep execution trace across C modules.

2. Numerical Methods and Models

• Methods and Models Overview: entry map across all numerical method pages.
• CurvIB Method Overview through IEM Mixing and Statistical Averaging: flow solve, pressure solve, coupling, and mixing/statistics internals.
• Momentum Solver Implementations: runtime-dispatched momentum solver implementations.
• Analytical Solution Modes and Initial Condition Modes: initialization and analytical-mode behavior.
• Boundary Conditions Guide: BC handler mapping from YAML to C handler objects.
• Particle Initialization and Restart Guide: seeding and restart/migration behavior.
• Particle Model and Coupling Overview: particle lifecycle and projection coupling.

5. Drift Prevention

• API Documentation Status: current API documentation coverage and gaps.
• Grid, Cell, and Variable Architecture Guide: data-structure contracts in grid/cell storage.
• Maintenance Backlog and Low-Priority Fixes: low-priority but known technical-debt items.
• Documentation Map: alternate categorized entry path.

4. Suggested Contributor Read Path

1. Code Architecture
2. Configuration Contract (YAML -> Generated Artifacts -> Runtime)
3. Developer Ingestion Map
4. C Runtime Execution Map
5. Methods and Models Overview
6. Configuration Extension Playbook

5. Expected Outcomes

After working through this section, you should be able to:

• trace a new YAML key from schema to runtime consumer,
• identify the right C module for a numerical feature change,
• update docs/tests/validation alongside code changes,
• preserve compatibility and diagnostics while extending behavior.