Skip to content

Sync README and docs index with current solver set and repo URLs #204

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

Open
shaia wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Sync README and docs index with current solver set and repo URLs #204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ CMakeUserPresets.json
build/**/*
build-ninja/
build-cuda/
build-avx2/
.cache/
build_release/
build_noomp/
Expand Down
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A production-grade computational fluid dynamics (CFD) library in C for solving 2
## Features

- 🚀 **Multiple Backends**: CPU (scalar), SIMD (AVX2/NEON), OpenMP, CUDA
- 🔧 **Pluggable Solvers**: Explicit Euler, RK2 (Heun), Projection Method (Chorin's algorithm)
- 🔧 **Pluggable Solvers**: Explicit Euler, RK2 (Heun), RK4 (classical), Projection Method (Chorin's algorithm)
- 📊 **Linear Solvers**: Jacobi, SOR, Red-Black SOR, CG/PCG, BiCGSTAB, GMRES(m), geometric multigrid (V/W/F cycles, also as CG preconditioner and projection pressure solver via `params.pressure_solver`)
- 🌡️ **Heat Transfer**: Energy equation (advection–diffusion) + Boussinesq buoyancy + thermal BCs
- 🌀 **Turbulence (RANS)**: Standard k-ε and Spalart-Allmaras with log-law wall functions; validated vs turbulent channel flow at Re_τ = 395
Expand Down Expand Up @@ -191,6 +191,8 @@ Turbulence is limited to 2D uniform grids in this release.
- **[Solvers](docs/reference/solvers.md)** - Numerical methods and performance
- **[Examples](docs/guides/examples.md)** - Example programs guide
- **[Validation](docs/validation/)** - Benchmark results
- **[Contributing](CONTRIBUTING.md)** - How to contribute
- **[Code of Conduct](CODE_OF_CONDUCT.md)** - Community guidelines

## Examples

Expand Down Expand Up @@ -252,7 +254,7 @@ ctest --test-dir build -C Debug --output-on-failure
ctest --test-dir build -C Debug -R "Validation" --output-on-failure
```

60+ tests covering:
100+ tests covering:

- Unit tests for core functionality
- Solver accuracy and convergence
Expand Down
11 changes: 5 additions & 6 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ Welcome to the CFD Framework documentation. This page provides a comprehensive g

### Numerical Methods

- [Solver Families](reference/solvers.md#solver-families) - Euler vs Projection
- [Linear Solvers](reference/solvers.md#linear-solvers-poisson-equation) - Jacobi, SOR, CG, BiCGSTAB
- [Solver Families](reference/solvers.md#solver-families) - Euler, RK2/RK4, Projection
- [Linear Solvers](reference/solvers.md#linear-solvers-poisson-equation) - Jacobi, SOR, Red-Black SOR, CG/PCG, BiCGSTAB, GMRES(m), geometric multigrid
- [Boundary Conditions](reference/solvers.md#boundary-conditions) - Dirichlet, Neumann, periodic
- [Convergence Theory](reference/solvers.md#linear-solver-performance-comparison)

Expand Down Expand Up @@ -224,13 +224,12 @@ See [Architecture Guide](architecture/architecture.md) for:
Current documentation corresponds to:
- **Version:** 0.3.x
- **Status:** Pre-release (approaching v1.0)
- **Last Updated:** 2026-06-23
- **Last Updated:** 2026-07-25

## Getting Help

- **Issues:** [GitHub Issues](https://github.com/yourusername/cfd/issues)
- **Discussions:** [GitHub Discussions](https://github.com/yourusername/cfd/discussions)
- **Email:** your.email@example.com
- **Issues:** [GitHub Issues](https://github.com/shaia/CFD/issues)
- **Discussions:** [GitHub Discussions](https://github.com/shaia/CFD/discussions)

## Document Index

Expand Down
Loading