Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/FourierFlows/FourierFlows.jl
Tools for building fast, hackable, pseudospectral partial differential equation solvers on periodic domains
https://github.com/FourierFlows/FourierFlows.jl
cfd fluid-dy fourier julia partial-differential-equations periodic-domains pseudospectral-methods spectral-methods
Last synced: 18 days ago
JSON representation
Tools for building fast, hackable, pseudospectral partial differential equation solvers on periodic domains
- Host: GitHub
- URL: https://github.com/FourierFlows/FourierFlows.jl
- Owner: FourierFlows
- License: mit
- Created: 2017-07-01T18:57:53.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T00:59:07.000Z (21 days ago)
- Last Synced: 2024-10-23T06:11:06.334Z (21 days ago)
- Topics: cfd, fluid-dy, fourier, julia, partial-differential-equations, periodic-domains, pseudospectral-methods, spectral-methods
- Language: Julia
- Homepage: https://bit.ly/FourierFlows
- Size: 5.05 MB
- Stars: 207
- Watchers: 10
- Forks: 29
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-fluid-dynamics - FourierFlows/FourierFlows.jl - Tools for building fast, hackable, pseudospectral partial differential equation solvers on periodic domains.  (Computational Fluid Dynamics / Spectral Methods)
README
# FourierFlows.jl
## Overview
This software provides tools for partial differential equations on periodic domains using
Fourier-based pseudospectral methods. A central intent of the software's design is also to
provide a framework for writing new, fast solvers for new physical problems. The code is
written in [Julia](https://julialang.org/).
For more details refer to the [documentation](https://fourierflows.github.io/FourierFlowsDocumentation/stable/).
## Installation
To install, use Julia's built-in package manager to add the package and also to instantiate/build all the required dependencies
```julia
julia> using Pkg
julia> Pkg.add("FourierFlows")
julia> Pkg.instantiate()
```
The most recent version of FourierFlows.jl requires Julia v1.6 (the current long-term-release) or later.
## Usage
See the documentation for tutorials on (i) how [construct grids](https://fourierflows.github.io/FourierFlowsDocumentation/stable/grids/) and use Fourier transform to compute derivatives and (ii) how to [set up a PDE](https://fourierflows.github.io/FourierFlowsDocumentation/stable/problem/), time-step it forward, and visualize the output, (iii) how to [add diagnostics](https://fourierflows.github.io/FourierFlowsDocumentation/stable/diagnostics/), and (iv) how to [write and read output](https://fourierflows.github.io/FourierFlowsDocumentation/stable/output/) from disk.
## Scalability
For now, FourierFlows.jl is restricted to run on either a single CPU or single GPU. Multi-threading
can enhance performance for the Fourier transforms. By default, FourierFlows.jl will use the
maximum number of threads available on your machine. You can set the number of threads used by
FourierFlows.jl by setting the environment variable, e.g.,
```
$ export JULIA_NUM_THREADS=4
```
For more information on multi-threading users are directed to the [Julia Documentation](https://docs.julialang.org/en/v1/manual/multi-threading/).
If your machine has more than one GPU available, then functionality within CUDA.jl package
enables the user to choose the GPU device that FourierFlows.jl should use. The user is referred
to the [CUDA.jl Documentation](https://juliagpu.github.io/CUDA.jl/stable/lib/driver/#Device-Management);
in particular, [`CUDA.devices`](https://juliagpu.github.io/CUDA.jl/stable/lib/driver/#CUDA.devices)
and [`CUDA.CuDevice`](https://juliagpu.github.io/CUDA.jl/stable/lib/driver/#CUDA.CuDevice).
## Example(s)
A demonstration for how to code up and solve the linear shallow water equations is found
in the [Examples](literated/OneDShallowWaterGeostrophicAdjustment/) section of the documentation.
For more examples of `FourierFlows.jl` in action, see the child packages
[`GeophysicalFlows.jl`](https://github.com/FourierFlows/GeophysicalFlows.jl)
or [`PassiveTracerFlows.jl`](https://github.com/FourierFlows/PassiveTracerFlows.jl).
## Getting help
Interested in using FourierFlows.jl or trying to figure out how to use it? Please feel free
to ask us questions and get in touch! The [documentation](https://fourierflows.github.io/FourierFlowsDocumentation/stable)
is always the best place to start. Check out the [examples](https://github.com/FourierFlows/FourierFlows.jl/tree/master/examples) and [open an issue](https://github.com/FourierFlows/FourierFlows.jl/issues/new)
or [start a discussion](https://github.com/FourierFlows/FourierFlows.jl/discussions/new)
if you have any questions, comments, suggestions, etc.
## Developers
FourierFlows.jl started during the on Atmospheric and Oceanic Fluid Dynamics Meeting 2017 by
[Greg Wagner](https://glwagner.github.io) and [Navid Constantinou](https://www.navidconstantinou.com).
Since then [various people have contributed](https://github.com/FourierFlows/FourierFlows.jl/graphs/contributors).
## Citing
This software is citable via [zenodo](https://zenodo.org). Please cite as:
> Gregory L. Wagner, Navid C. Constantinou, and contributors. (2023). FourierFlows/FourierFlows.jl: FourierFlows v0.10.5 (Version v0.10.5). Zenodo. [http://doi.org/10.5281/zenodo.1161724](http://doi.org/10.5281/zenodo.1161724)
## Contributing
We are excited to get more people involved in contributing to the development of FourierFlows.jl!
We welcome any contribution, no matter how big or small! It's always great to have new people
look at the code with fresh eyes: you will see errors that other developers have missed.
Let us know by [open an issue](https://github.com/FourierFlows/FourierFlows.jl/issues/new)
or [start a discussion](https://github.com/FourierFlows/FourierFlows.jl/discussions/new)
if you'd like to work on a new feature or implement a new module, if you're new to open-source
and want to find a cool little project or issue to work on that fits your interests! We're more
than happy to help along the way.
For more information, check out our [contributor's guide](https://github.com/FourierFlows/FourierFlows.jl/blob/master/CONTRIBUTING.md).