software/Nstrophy
1
Fork 0
Code Issues Pull Requests Releases Activity

nthreads in README

Browse Source
This commit is contained in:
Ian Jauslin 2023-06-14 14:20:07 -04:00
parent 7ab59aca48
commit 6066309fa3
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -13,7 +13,7 @@ which will place a binary at `build/nstrophy`.
The syntax for the execution of Nstrophy is The syntax for the execution of Nstrophy is
```bash ```bash
./build/nstrophy [-p parameters] [-s savefile] [-u u_outfile] <command> ./build/nstrophy [-p parameters] [-s savefile] [-u u_outfile] [-t nthreads] <command>
``` ```
* `parameters` is a list of parameters for the computation, see * `parameters` is a list of parameters for the computation, see
[Parameters](#parameters) [Parameters](#parameters)
@ -26,6 +26,8 @@ The syntax for the execution of Nstrophy is
* `u_outfile` is a file to which the final u is written in plain text format, * `u_outfile` is a file to which the final u is written in plain text format,
which can be used as an initial condition for a future computation. which can be used as an initial condition for a future computation.
* `nthreads` is the number of threads used to compute Fast Fourier Transforms.
Nstrophy is written in C. The Makefile uses the GNU C Compiler. Nstrophy is written in C. The Makefile uses the GNU C Compiler.
Nstrophy depends on `fftw`: [https://fftw.org] Nstrophy depends on `fftw`: [https://fftw.org]