facebookresearch / fmmax

Fourier modal method with Jax
MIT License
95 stars 9 forks source link

Vector fields docs #89

Open smartalecH opened 7 months ago

smartalecH commented 7 months ago

Would be good to add a simple page in the docs that describe how fmmax computes vector fields. The paper describes this to some detail, but even since then, fmmax has changed it's approach.

Some interesting details include...

We can start will a "brain dump" (it doesn't have to sound like a paper). But documenting this will help us keep things consistent.

smartalecH commented 7 months ago

Here's some good info:

https://github.com/facebookresearch/fmmax/blob/c6cd855fceb26fda5234ec704d1ea0cd0cbff6c9/src/fmmax/vector.py#L113-L130