Skip to content

Feature/derived fields api #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shaia merged 6 commits into from
Jan 2, 2026
Merged

Feature/derived fields api #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f33bee0
feat: Add derived fields and statistics API (Phase 3)
shaia Jan 1, 2026
693a7f8
Merge origin/master: combine Phase 3 and Phase 5 features
shaia Jan 1, 2026
9140859
fix: Memory leak in compute_flow_statistics - DECREF PyFloat objects
shaia Jan 2, 2026
551ca02
style: Move pytest import to module level in test_derived_fields.py
shaia Jan 2, 2026
133cb05
fix: Add PyDict_SetItemString error checking in derived fields API
shaia Jan 2, 2026
39a2e31
style: Remove misleading section comments from import block
shaia Jan 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 24 additions & 19 deletions MIGRATION_PLAN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,27 +338,32 @@ cpu_features_t cfd_get_cpu_features(void);

**Actual effort:** 1 day

### Phase 3: Add Derived Fields & Statistics (Important)
### Phase 3: Add Derived Fields & Statistics (Important) ✅ COMPLETED

**Priority:** P1 - Useful for post-processing

**Status:** Completed on 2026-01-01

**Tasks:**

- [ ] **3.1 Create DerivedFields class**
- Wrapper for `derived_fields` struct
- Properties for velocity_magnitude array
- Properties for field statistics
- [x] **3.1 Implement field statistics function**
- `calculate_field_stats(data)` - Compute min, max, avg, sum for a field
- Returns dict with 'min', 'max', 'avg', 'sum' keys

- [x] **3.2 Implement velocity magnitude computation**
- `compute_velocity_magnitude(u, v, nx, ny)` - Compute sqrt(u^2 + v^2)
- Returns list of velocity magnitudes

- [ ] **3.2 Implement statistics functions**
- `compute_velocity_magnitude(field)`
- `compute_statistics(field)`
- Return `FieldStats` named tuple
- [x] **3.3 Implement comprehensive flow statistics**
- `compute_flow_statistics(u, v, p, nx, ny)` - Statistics for all flow components
- Returns dict with 'u', 'v', 'p', 'velocity_magnitude' stats

- [ ] **3.3 Add to simulation workflow**
- Automatic derived field computation after step
- Access via `sim.derived_fields`
- [x] **3.4 Add tests**
- Created `tests/test_derived_fields.py` with comprehensive tests
- Tests for all three functions with edge cases
- Proper error handling tests (empty lists, wrong types, size mismatches)

**Estimated effort:** 1-2 days
**Actual effort:** < 1 day

### Phase 4: Add Error Handling API (Important)

Expand Down Expand Up @@ -541,13 +546,13 @@ find_library(CFD_LIBRARY cfd_library) # Unified library name
| Phase 1: Breaking Changes | ~~2-3 days~~ ✅ 1 day | ~~2-3 days~~ 1 day |
| Phase 2: Boundary Conditions | ~~3-4 days~~ ✅ 1 day | ~~5-7 days~~ 2 days |
| Phase 2.5: CI/Build System (v0.1.6) | ✅ 1 day | 3 days |
| Phase 3: Derived Fields | 1-2 days | 4-5 days |
| Phase 4: Error Handling | 1 day | 5-6 days |
| Phase 5: Backend Availability (v0.1.6) | ✅ 0.5 days | 3.5 days |
| Phase 6: CPU Features | 1 day | 4.5 days |
| Phase 7: Docs & Tests | 2 days | 6.5 days |
| Phase 3: Derived Fields | ~~1-2 days~~ ✅ < 1 day | 3.5 days |
| Phase 4: Error Handling | 1 day | 4.5 days |
| Phase 5: Backend Availability (v0.1.6) | ✅ 0.5 days | 4 days |
| Phase 6: CPU Features | 1 day | 5 days |
| Phase 7: Docs & Tests | 2 days | 7 days |

Comment on lines +551 to 554
Copy link

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The cumulative timeline is confusing because phases were completed out of order (Phase 5 before Phase 3 and 4). Consider either: (1) reordering the table to show completion order with actual cumulative times, or (2) adding a note that explains the cumulative column shows estimated sequential totals, not actual completion timeline. The "4 days" for Phase 5 cumulative appears to represent total completed work rather than sequential cumulative, which is inconsistent with other rows.

Suggested change
| Phase 5: Backend Availability (v0.1.6) | ✅ 0.5 days | 4 days |
| Phase 6: CPU Features | 1 day | 5 days |
| Phase 7: Docs & Tests | 2 days | 7 days |
| Phase 5: Backend Availability (v0.1.6) | ✅ 0.5 days | 4 days (completed work to date) |
| Phase 6: CPU Features | 1 day | 5 days |
| Phase 7: Docs & Tests | 2 days | 7 days |
_Note: The **Cumulative** column shows a sequential estimate assuming phases are done in numeric order. Phase 5 was completed earlier than Phases 3 and 4, so its "4 days (completed work to date)" value reflects total work finished so far rather than an additional sequential day._

Copilot uses AI. Check for mistakes.
**Total estimated effort:** ~~9-10 days~~ 6.5 days (3.5 days completed)
**Total estimated effort:** ~~9-10 days~~ ~7 days (4 days completed)

---

Expand Down
9 changes: 9 additions & 0 deletions cfd_python/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@
- bc_apply_outlet_scalar(field, nx, ny, edge): Zero-gradient outlet
- bc_apply_outlet_velocity(u, v, nx, ny, edge): Zero-gradient outlet

Derived fields and statistics:
- calculate_field_stats(data): Compute min, max, avg, sum for a field
- compute_velocity_magnitude(u, v, nx, ny): Compute sqrt(u^2 + v^2)
- compute_flow_statistics(u, v, p, nx, ny): Statistics for all flow components

Solver backend availability (v0.1.6):
Backends:
- BACKEND_SCALAR: Basic scalar CPU implementation
Expand Down Expand Up @@ -147,6 +152,10 @@
"bc_apply_inlet_parabolic",
"bc_apply_outlet_scalar",
"bc_apply_outlet_velocity",
# Derived fields API (Phase 3)
"calculate_field_stats",
"compute_velocity_magnitude",
"compute_flow_statistics",
# Solver backend constants (v0.1.6)
"BACKEND_SCALAR",
"BACKEND_SIMD",
Expand Down
15 changes: 7 additions & 8 deletions cfd_python/_loader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,14 @@ def load_extension():
from .cfd_python import (
BACKEND_CUDA,
BACKEND_OMP,
# Solver backend constants (v0.1.6)
BACKEND_SCALAR,
BACKEND_SIMD,
# Boundary condition backends
BC_BACKEND_AUTO,
BC_BACKEND_CUDA,
BC_BACKEND_OMP,
BC_BACKEND_SCALAR,
BC_BACKEND_SIMD,
BC_EDGE_BOTTOM,
# Boundary edges
BC_EDGE_LEFT,
BC_EDGE_RIGHT,
BC_EDGE_TOP,
Expand All @@ -54,7 +51,6 @@ def load_extension():
BC_TYPE_NEUMANN,
BC_TYPE_NOSLIP,
BC_TYPE_OUTLET,
# Boundary condition types
BC_TYPE_PERIODIC,
CFD_ERROR,
CFD_ERROR_DIVERGED,
Expand All @@ -63,7 +59,6 @@ def load_extension():
CFD_ERROR_MAX_ITER,
CFD_ERROR_NOMEM,
CFD_ERROR_UNSUPPORTED,
# Error handling API
CFD_SUCCESS,
OUTPUT_CSV_CENTERLINE,
OUTPUT_CSV_STATISTICS,
Expand All @@ -72,7 +67,6 @@ def load_extension():
OUTPUT_VELOCITY,
OUTPUT_VELOCITY_MAGNITUDE,
backend_get_name,
# Solver backend availability functions (v0.1.6)
backend_is_available,
bc_apply_dirichlet,
bc_apply_inlet_parabolic,
Expand All @@ -83,12 +77,13 @@ def load_extension():
bc_apply_scalar,
bc_apply_velocity,
bc_backend_available,
# Boundary condition functions
bc_get_backend,
bc_get_backend_name,
bc_set_backend,
calculate_field_stats,
clear_error,
# Core functions
compute_flow_statistics,
compute_velocity_magnitude,
create_grid,
get_available_backends,
get_default_solver_params,
Expand Down Expand Up @@ -174,6 +169,10 @@ def load_extension():
"bc_apply_inlet_parabolic": bc_apply_inlet_parabolic,
"bc_apply_outlet_scalar": bc_apply_outlet_scalar,
"bc_apply_outlet_velocity": bc_apply_outlet_velocity,
# Derived fields API (Phase 3)
"calculate_field_stats": calculate_field_stats,
"compute_velocity_magnitude": compute_velocity_magnitude,
"compute_flow_statistics": compute_flow_statistics,
# Solver backend constants (v0.1.6)
"BACKEND_SCALAR": BACKEND_SCALAR,
"BACKEND_SIMD": BACKEND_SIMD,
Expand Down
Loading
Loading