HOWTO

--------------------------------------------------------------
This HOWTO lists the basic function set needed to get started.
--------------------------------------------------------------

SETUP AND CLEAN:
----------------
nb3d_init_topo(..) [optional]
nb3dfft_setup(..)
get_dims(..)
....
nb3dfft_clean(..)

BLOCKING FUNCTIONS:
-------------------
forward 3D-FFT transformations:
  ftran_r2c(in,out)
  ftran_r2c_ffc(in,out)

backward 3D-FFT transformations:
  btran_c2r(in,out)
  btran_c2r_ffc(in,out)

global transforms in real space:
  gtran_x2y(in,out)
  gtran_y2x(in,out)

  gtran_y2z(in,out)
  gtran_z2y(in,out)

  gtran_x2zji(in,out)
  gtran_zji2x(in,out)

NON-BLOCKING-FUNCTIONS:
-----------------------
example for overlap of 3x forward FFTs (more examples in nb3dfft_nbc_ftran_funcsets.F90)
  nb3dfft_nbc_ftran_r2c_3x(in1, out1, sndbuf1, rcvbuf1,
                           in2, out2, sndbuf2, rcvbuf2,
                           in3, out3, sndbuf3, rcvbuf3,
                           t_all, t_comp, t_test, t_waiting)

example for overlap of 3x backward FFTs (more examples in nb3dfft_nbc_btran_funcsets.F90)
  nb3dfft_nbc_btran_r2c_3x(in1, out1, sndbuf1, rcvbuf1,
                           in2, out2, sndbuf2, rcvbuf2,
                           in3, out3, sndbuf3, rcvbuf3,
                           t_all, t_comp, t_test, t_waiting)

example for overlap of global transforms (more examples in nb3dfft_nbc_gtran_funcsets.F90)
  nb3dfft_nbc_gtran_x2y_3x(in1, out1, sndbuf1, rcvbuf1,
                           in2, out2, sndbuf2, rcvbuf2,
                           in3, out3, sndbuf3, rcvbuf3,
                           t_all, t_comp, t_test, t_waiting)

example for mixing of different transposes in one call (more examples in nb3dfft_nbc.F90)
  nb3dfft_nbc_btran_r2c_3x(in1, out1, sndbuf1, rcvbuf1,
                           in2, out2, sndbuf2, rcvbuf2,
                           in3, out3, sndbuf3, rcvbuf3,
                           t_all, t_comp, t_test, t_waiting)