History

Ye Luo 49022feaaa Prevent Fortran compiler options being propagated to C compiler in FFTXLIB.		2024-09-23 23:31:19 -05:00
..
examples	Obscure line present in all examples replaced with a much simpler one.	2022-09-03 11:53:33 +02:00
src	Prevent Fortran compiler options being propagated to C compiler in	2024-09-23 23:31:19 -05:00
tests	Move gen_test_params.py under tests/	2021-12-22 10:54:03 -06:00
CMakeLists.txt	clean FFTXlib/CMakeLists.txt and restore pseudopotentials	2022-06-29 10:08:42 +02:00
Makefile	Restore pure makefile build.	2021-12-21 19:01:32 -06:00
README.md	Restore pure makefile build.	2021-12-21 19:01:32 -06:00

README.md

FFTXlib

Implements real space grid parallelization of FFT and task groups.

Testing and Benchmarking

This library also provides a testing and timing code to asses the performance of your FFT, estimate the scalability and the optimal parameters for your simulation.

To compile the test program, once you have properly configure QE within a parallel environment, go inside the directory FFTXlib and type:

make TEST

Then you can run your FFT tests using command like:

mpirun -np 4 ./fft_test.x -ecutwfc 80 -alat 20  -nbnd 128 -ntg 4

Command line arguments:

-ecutwfc  Plane wave energy cut off
-alat     Lattice parameter (for hard coded lattice structure)
-nbnd     Number of bands (fft cycles)
-ntg      Number of task groups
-av1  x y z    First lattice vector, in atomic units. N.B.: when using -av1, -alat is ignored!
-av2  x y z    Second lattice vector, in atomic units. N.B.: when using -av2, -alat is ignored!
-av3  x y z    Third lattice vector, in atomic units. N.B.: when using -av3, -alat is ignored!
-kmax kx ky kz    Reciprocal lattice vector inside the BZ with maximum norm. Used to calculate max(|G+K|). (2pi/a)^2 units.

A python script to extract the parameters from an output file of pw.x is also available. Example usage:

$ python gen_test_params.py a_pw_output
To analize performances run with:
mpirun -np X ./fft_test.x -ntg Y -ecutwfc 36.7500 -ecutrho 147.0000 -av1 36.6048 0.0 0.0 -av2 -18.3024 31.70067192 0.0 -av3 0.0 0.0 18.3024 -nbnd 400 -gamma .true.

Replace X and Y with appropriate values for your simualtion.

Files

Compile time parameters:

fft_param.f90

Descriptor types:

stick_base.f90
fft_types.f90
fft_smallbox_type.f90

Parallel execution routines:

fft_interfaces.f90 fft_fwinv.f90
  fft_parallel.f90
    scatter_mod.f90
      tg_gather.f90
  fft_interpolate.f90
  fft_smallbox.f90

Low level library wrappers:

fft_scalar.f90
fft_scalar.DFTI.f90
fft_scalar.ESSL.f90
fft_scalar.FFTW.f90 fftw_interfaces.f90
  fft_stick.c fftw.c fftw_dp.c fftw_sp.c fftw_dp.h fftw.h fftw_sp.h konst.h
fft_scalar.FFTW3.f90
fft_scalar.SX6.f90

Misc. helper routines:

fft_ggen.f90
fft_error.f90
fft_helper_subroutines.f90
fft_support.f90

Tests:

test.f90