src/gromacs/mdlib/fft5d.h

   1 /* -*- mode: c; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; c-file-style: "stroustrup"; -*-
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2012, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  *
  31  * And Hey:
  32  * Groningen Machine for Chemical Simulation
  33  */
  34
  35 #ifndef FFT5D_H_
  36 #define FFT5D_H_
  37
  38 #ifdef HAVE_CONFIG_H
  39 #include <config.h>
  40 #endif
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 #ifdef NOGMX
  47 /*#define GMX_MPI*/
  48 /*#define GMX_FFT_FFTW3*/
  49 FILE* debug;
  50 #endif
  51
  52 #include <types/commrec.h>
  53 #include "gmxcomplex.h"
  54 #include "gmx_fft.h"
  55
  56 #ifndef GMX_MPI
  57 double MPI_Wtime();
  58 #endif
  59
  60 /*currently only special optimization for FFTE*/
  61 #ifdef GMX_FFT_FFTW3
  62 #include <fftw3.h>
  63 #endif
  64
  65 #ifndef GMX_DOUBLE
  66 #define FFTW(x) fftwf_ ## x
  67 #else
  68 #define FFTW(x) fftw_ ## x
  69 #endif
  70
  71 #ifdef NOGMX
  72 struct fft5d_time_t {
  73     double fft, local, mpi1, mpi2;
  74 };
  75 typedef struct fft5d_time_t *fft5d_time;
  76 #else
  77 #include "gmx_wallcycle.h"
  78 typedef gmx_wallcycle_t fft5d_time;
  79 #endif
  80
  81 typedef enum fft5d_flags_t {
  82     FFT5D_ORDER_YZ    = 1,
  83     FFT5D_BACKWARD    = 2,
  84     FFT5D_REALCOMPLEX = 4,
  85     FFT5D_DEBUG       = 8,
  86     FFT5D_NOMEASURE   = 16,
  87     FFT5D_INPLACE     = 32,
  88     FFT5D_NOMALLOC    = 64
  89 } fft5d_flags;
  90
  91 struct fft5d_plan_t {
  92     t_complex *lin;
  93     t_complex *lout, *lout2, *lout3;
  94     gmx_fft_t* p1d[3]; /*1D plans*/
  95 #ifdef GMX_FFT_FFTW3
  96     FFTW(plan) p2d;    /*2D plan: used for 1D decomposition if FFT supports transposed output*/
  97     FFTW(plan) p3d;    /*3D plan: used for 0D decomposition if FFT supports transposed output*/
  98     FFTW(plan) mpip[2];
  99 #endif
 100     MPI_Comm cart[2];
 101
 102     int      N[3], M[3], K[3];                        /*local length in transposed coordinate system (if not divisisable max)*/
 103     int      pN[3], pM[3], pK[3];                     /*local length - not max but length for this processor*/
 104     int      oM[3], oK[3];                            /*offset for current processor*/
 105     int     *iNin[3], *oNin[3], *iNout[3], *oNout[3]; /*size for each processor (if divisisable=max) for out(=split)
 106                                                          and in (=join) and offsets in transposed coordinate system*/
 107     int      C[3], rC[3];                             /*global length (of the one global axes) */
 108     /* C!=rC for real<->complex. then C=rC/2 but with potential padding*/
 109     int      P[2];                                    /*size of processor grid*/
 110 /*  int fftorder;*/
 111 /*  int direction;*/
 112 /*  int realcomplex;*/
 113     int flags;
 114     /*int N0,N1,M0,M1,K0,K1;*/
 115     int NG, MG, KG;
 116     /*int P[2];*/
 117     int coor[2];
 118     int nthreads;
 119 };
 120
 121 typedef struct fft5d_plan_t *fft5d_plan;
 122
 123 void fft5d_execute(fft5d_plan plan, int thread, fft5d_time times);
 124 fft5d_plan fft5d_plan_3d(int N, int M, int K, MPI_Comm comm[2], int flags, t_complex**lin, t_complex**lin2, t_complex**lout2, t_complex**lout3, int nthreads);
 125 void fft5d_local_size(fft5d_plan plan, int* N1, int* M0, int* K0, int* K1, int** coor);
 126 void fft5d_destroy(fft5d_plan plan);
 127 fft5d_plan fft5d_plan_3d_cart(int N, int M, int K, MPI_Comm comm, int P0, int flags, t_complex** lin, t_complex** lin2, t_complex** lout2, t_complex** lout3, int nthreads);
 128 void fft5d_compare_data(const t_complex* lin, const t_complex* in, fft5d_plan plan, int bothLocal, int normarlize);
 129
 130 #ifdef __cplusplus
 131 }
 132 #endif
 133 #endif /*FFTLIB_H_*/