Skip to content

Commit 7276b44

Browse files
authored
Update README.md
1 parent a5843fc commit 7276b44

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
11
# Torch CFD
22

3-
This is a native PyTorch port of Google's Computational Fluid Dynamics package in Jax. The main changes are documented in the `README.md` under the [`torch_cfd` directory](torch_cfd/README.md). The biggest change is many routines that rely on the functional programming of Jax have been rewritten to be a more PyTorch-friendly tensor-in to tensor-out style.
3+
This is a native PyTorch port of [Google's Computational Fluid Dynamics package in Jax](https://github.com/google/jax-cfd). The main changes are documented in the `README.md` under the [`torch_cfd` directory](torch_cfd/README.md). The biggest change is many routines that rely on the functional programming of Jax have been rewritten to be a more PyTorch-friendly tensor-in to tensor-out style.
44

55
## Installation
66

77
```bash
88
pip install torch-cfd
99
```
1010

11+
## Contributions
12+
PR welcome. Current the port only includes:
13+
- Pseudospectral methods for vorticity which use anti-aliasing filtering techniques for non-linear terms to maintain stability.
14+
- Temporal discretization: Currently only RK4 temporal discretization, using explicit time-stepping for advection and either implicit or explicit time-stepping for diffusion.
15+
- Boundary conditions: only periodic boundary conditions.
16+
1117
## Examples
1218
- Demos of different simulation setups:
13-
- [2D simulation with a psuedo-spectral solver](example_Kolmogrov2d_rk4_cn_forced_turbulence.ipynb)
19+
- [2D simulation with a psuedo-spectral solver](example_Kolmogrov2d_rk4_cn_forced_turbulence.ipynb)

0 commit comments

Comments
 (0)