src/gromacs/fft/tests/fft.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Tests utilities for fft calculations.
  38  *
  39  * \author Roland Schulz <roland@utk.edu>
  40  * \ingroup module_fft
  41  */
  42 #include <vector>
  43
  44 #include <gtest/gtest.h>
  45
  46 #include "gromacs/fft/fft.h"
  47 #include "gromacs/fft/parallel_3dfft.h"
  48 #include "gromacs/utility/stringutil.h"
  49 #include "testutils/refdata.h"
  50
  51 namespace
  52 {
  53
  54 //! Input data for FFT tests.
  55 const real inputdata[] = { //print ",\n".join([",".join(["%4s"%(random.randint(-99,99)/10.,) for i in range(25)]) for j in range(20)])
  56     -3.5, 6.3, 1.2, 0.3, 1.1, -5.7, 5.8, -1.9, -6.3, -1.4, 7.4, 2.4, -9.9, -7.2, 5.4, 6.1, -1.9, -7.6, 1.4, -3.5, 0.7, 5.6, -4.2, -1.1, -4.4,
  57     -6.3, -7.2, 4.6, -3.0, -0.9, 7.2, 2.5, -3.6, 6.1, -3.2, -2.1, 6.5, -0.4, -9.0, 2.3, 8.4, 4.0, -5.2, -9.0, 4.7, -3.7, -2.0, -9.5, -3.9, -3.6,
  58     7.1, 0.8, -0.6, 5.2, -9.3, -4.5, 5.9, 2.2, -5.8, 5.0, 1.2, -0.1, 2.2, 0.2, -7.7, 1.9, -8.4, 4.4, 2.3, -2.9, 6.7, 2.7, 5.8, -3.6, 8.9,
  59     8.9, 4.3, 9.1, 9.3, -8.7, 4.1, 9.6, -6.2, 6.6, -9.3, 8.2, 4.5, 6.2, 9.4, -8.0, -6.8, -3.3, 7.2, 1.7, 0.6, -4.9, 9.8, 1.3, 3.2, -0.2,
  60     9.9, 4.4, -9.9, -7.2, 4.4, 4.7, 7.2, -0.3, 0.3, -2.1, 8.4, -2.1, -6.1, 4.1, -5.9, -2.2, -3.8, 5.2, -8.2, -7.8, -8.8, 6.7, -9.5, -4.2, 0.8,
  61     8.3, 5.2, -9.0, 8.7, 9.8, -9.9, -7.8, -8.3, 9.0, -2.8, -9.2, -9.6, 8.4, 2.5, 6.0, -0.4, 1.3, -0.5, 9.1, -9.5, -0.8, 1.9, -6.2, 4.3, -3.8,
  62     8.6, -1.9, -2.1, -0.4, -7.1, -3.7, 9.1, -6.4, -0.6, 2.5, 8.0, -5.2, -9.8, -4.3, 4.5, 1.7, 9.3, 9.2, 1.0, 5.3, -4.5, 6.4, -6.6, 3.1, -6.8,
  63     2.1, 2.0, 7.3, 8.6, 5.0, 5.2, 0.4, -7.1, 4.5, -9.2, -9.1, 0.2, -6.3, -1.1, -9.6, 7.4, -3.7, -5.5, 2.6, -3.5, -0.7, 9.0, 9.8, -8.0, 3.6,
  64     3.0, -2.2, -2.8, 0.8, 9.0, 2.8, 7.7, -0.7, -5.0, -1.8, -2.3, -0.4, -6.2, -9.1, -9.2, 0.5, 5.7, -3.9, 2.1, 0.6, 0.4, 9.1, 7.4, 7.1, -2.5,
  65     7.3, 7.8, -4.3, 6.3, -0.8, -3.8, -1.5, 6.6, 2.3, 3.9, -4.6, 5.8, -7.4, 5.9, 2.8, 4.7, 3.9, -5.4, 9.1, -1.6, -1.9, -4.2, -2.6, 0.6, -5.1,
  66     1.8, 5.2, 4.0, -6.2, 6.5, -9.1, 0.5, 2.1, 7.1, -8.6, 7.6, -9.7, -4.6, -5.7, 6.1, -1.8, -7.3, 9.4, 8.0, -2.6, -1.8, 5.7, 9.3, -7.9, 7.4,
  67     6.3, 2.0, 9.6, -4.5, -6.2, 6.1, 2.3, 0.8, 5.9, -2.8, -3.5, -1.5, 6.0, -4.9, 3.5, 7.7, -4.2, -9.7, 2.4, 8.1, 5.9, 3.4, -7.5, 7.5, 2.6,
  68     4.7, 2.7, 2.2, 2.6, 6.2, 7.5, 0.2, -6.4, -2.8, -0.5, -0.3, 0.4, 1.2, 3.5, -4.0, -0.5, 9.3, -7.2, 8.5, -5.5, -1.7, -5.3, 0.3, 3.9, -3.6,
  69     -3.6, 4.7, -8.1, 1.4, 4.0, 1.3, -4.3, -8.8, -7.3, 6.3, -7.5, -9.0, 9.1, 4.5, -1.9, 1.9, 9.9, -1.7, -9.1, -5.1, 8.5, -9.3, 2.1, -5.8, -3.6,
  70     -0.8, -0.9, -3.3, -2.7, 7.0, -7.2, -5.0, 7.4, -1.4, 0.0, -4.5, -9.7, 0.7, -1.0, -9.1, -5.3, 4.3, 3.4, -6.6, 9.8, -1.1, 8.9, 5.0, 2.9, 0.2,
  71     -2.9, 0.8, 6.7, -0.6, 0.6, 4.1, 5.3, -1.7, -0.3, 4.2, 3.7, -8.3, 4.0, 1.3, 6.3, 0.2, 1.3, -1.1, -3.5, 2.8, -7.7, 6.2, -4.9, -9.9, 9.6,
  72     3.0, -9.2, -8.0, -3.9, 7.9, -6.1, 6.0, 5.9, 9.6, 1.2, 6.2, 3.6, 2.1, 5.8, 9.2, -8.8, 8.8, -3.3, -9.2, 4.6, 1.8, 4.6, 2.9, -2.7, 4.2,
  73     7.3, -0.4, 7.7, -7.0, 2.1, 0.3, 3.7, 3.3, -8.6, 9.8, 3.6, 3.1, 6.5, -2.4, 7.8, 7.5, 8.4, -2.8, -6.3, -5.1, -2.7, 9.3, -0.8, -9.2, 7.9,
  74     8.9, 3.4, 0.1, -5.3, -6.8, 4.9, 4.3, -0.7, -2.2, -3.2, -7.5, -2.3, 0.0, 8.1, -9.2, -2.3, -5.7, 2.1, 2.6, 2.0, 0.3, -8.0, -2.0, -7.9, 6.6,
  75     8.4, 4.0, -6.2, -6.9, -7.2, 7.7, -5.0, 5.3, 1.9, -5.3, -7.5, 8.8, 8.3, 9.0, 8.1, 3.2, 1.2, -5.4, -0.2, 2.1, -5.2, 9.5, 5.9, 5.6, -7.8,
  76 };
  77
  78
  79 class BaseFFTTest : public ::testing::Test
  80 {
  81     public:
  82         BaseFFTTest() : checker_(data_.rootChecker())
  83         {
  84         }
  85         ~BaseFFTTest()
  86         {
  87             gmx_fft_cleanup();
  88         }
  89         gmx::test::TestReferenceData    data_;
  90         gmx::test::TestReferenceChecker checker_;
  91         std::vector<real>               in_, out_;
  92 };
  93
  94 class FFTTest : public BaseFFTTest
  95 {
  96     public:
  97         FFTTest() : fft_(NULL)
  98         {
  99         }
 100         ~FFTTest()
 101         {
 102             if (fft_)
 103             {
 104                 gmx_fft_destroy(fft_);
 105             }
 106         }
 107         gmx_fft_t fft_;
 108 };
 109
 110 class ManyFFTTest : public BaseFFTTest
 111 {
 112     public:
 113         ManyFFTTest() : fft_(NULL)
 114         {
 115         }
 116         ~ManyFFTTest()
 117         {
 118             if (fft_)
 119             {
 120                 gmx_many_fft_destroy(fft_);
 121             }
 122         }
 123         gmx_fft_t fft_;
 124 };
 125
 126
 127 //TODO: Add tests for aligned/not-aligned input/output memory
 128
 129 class FFTTest1D : public FFTTest, public ::testing::WithParamInterface<int>
 130 {
 131
 132 };
 133
 134 class FFFTest3D : public BaseFFTTest
 135 {
 136     public:
 137         FFFTest3D() : fft_(NULL)
 138         {
 139         }
 140         ~FFFTest3D()
 141         {
 142             if (fft_)
 143             {
 144                 gmx_parallel_3dfft_destroy(fft_);
 145             }
 146         }
 147         gmx_parallel_3dfft_t fft_;
 148 };
 149
 150
 151 TEST_P(FFTTest1D, Complex)
 152 {
 153     const int nx = GetParam();
 154     ASSERT_LE(nx*2, static_cast<int>(sizeof(inputdata)/sizeof(real)));
 155
 156     in_  = std::vector<real>(inputdata, inputdata+nx*2);
 157     out_ = std::vector<real>(nx*2);
 158     real* in  = &in_[0];
 159     real* out = &out_[0];
 160
 161     gmx_fft_init_1d(&fft_, nx, 0);
 162
 163     gmx_fft_1d(fft_, GMX_FFT_FORWARD, in, out);
 164     checker_.checkSequenceArray(nx*2, out, "forward");
 165     gmx_fft_1d(fft_, GMX_FFT_BACKWARD, in, out);
 166     checker_.checkSequenceArray(nx*2, out, "backward");
 167 }
 168
 169 TEST_P(FFTTest1D, Real)
 170 {
 171     const int rx = GetParam();
 172     const int cx = (rx/2+1);
 173     ASSERT_LE(cx*2, static_cast<int>(sizeof(inputdata)/sizeof(real)));
 174
 175     in_  = std::vector<real>(inputdata, inputdata+cx*2);
 176     out_ = std::vector<real>(cx*2);
 177     real* in  = &in_[0];
 178     real* out = &out_[0];
 179
 180     gmx_fft_init_1d_real(&fft_, rx, 0);
 181
 182     gmx_fft_1d_real(fft_, GMX_FFT_REAL_TO_COMPLEX, in, out);
 183     checker_.checkSequenceArray(cx*2, out, "forward");
 184     gmx_fft_1d_real(fft_, GMX_FFT_COMPLEX_TO_REAL, in, out);
 185     checker_.checkSequenceArray(rx, out, "backward");
 186 }
 187
 188 INSTANTIATE_TEST_CASE_P(7_8_25_36_60,
 189                         FFTTest1D, ::testing::Values(7, 8, 25, 36, 60));
 190
 191
 192 TEST_F(ManyFFTTest, Complex1DLength48Multi5Test)
 193 {
 194     const int nx = 48;
 195     const int N  = 5;
 196
 197     in_  = std::vector<real>(inputdata, inputdata+nx*2*N);
 198     out_ = std::vector<real>(nx*2*N);
 199     real* in  = &in_[0];
 200     real* out = &out_[0];
 201
 202     gmx_fft_init_many_1d(&fft_, nx, N, 0);
 203
 204     gmx_fft_many_1d(fft_, GMX_FFT_FORWARD, in, out);
 205     checker_.checkSequenceArray(nx*2*N, out, "forward");
 206     gmx_fft_many_1d(fft_, GMX_FFT_BACKWARD, in, out);
 207     checker_.checkSequenceArray(nx*2*N, out, "backward");
 208 }
 209
 210 TEST_F(ManyFFTTest, Real1DLength48Multi5Test)
 211 {
 212     const int rx = 48;
 213     const int cx = (rx/2+1);
 214     const int N  = 5;
 215
 216     in_  = std::vector<real>(inputdata, inputdata+cx*2*N);
 217     out_ = std::vector<real>(cx*2*N);
 218     real* in  = &in_[0];
 219     real* out = &out_[0];
 220
 221     gmx_fft_init_many_1d_real(&fft_, rx, N, 0);
 222
 223     gmx_fft_many_1d_real(fft_, GMX_FFT_REAL_TO_COMPLEX, in, out);
 224     checker_.checkSequenceArray(cx*2*N, out, "forward");
 225     gmx_fft_many_1d_real(fft_, GMX_FFT_COMPLEX_TO_REAL, in, out);
 226     checker_.checkSequenceArray(rx*N, out, "backward");
 227 }
 228
 229 TEST_F(FFTTest, Real2DLength18_15Test)
 230 {
 231     const int rx = 18;
 232     const int cx = (rx/2+1);
 233     const int ny = 15;
 234
 235     in_  = std::vector<real>(inputdata, inputdata+cx*2*ny);
 236     out_ = std::vector<real>(cx*2*ny);
 237     real* in  = &in_[0];
 238     real* out = &out_[0];
 239
 240     gmx_fft_init_2d_real(&fft_, rx, ny, 0);
 241
 242     gmx_fft_2d_real(fft_, GMX_FFT_REAL_TO_COMPLEX, in, out);
 243     checker_.checkSequenceArray(cx*2*ny, out, "forward");
 244 //    known to be wrong for gmx_fft_mkl. And not used.
 245 //    gmx_fft_2d_real(_fft,GMX_FFT_COMPLEX_TO_REAL,in,out);
 246 //    _checker.checkSequenceArray(rx*ny, out, "backward");
 247 }
 248
 249 //TODO: test with threads and more than 1 MPI ranks
 250 TEST_F(FFFTest3D, Real5_6_9)
 251 {
 252     int        ndata[] = {5, 6, 9};
 253     MPI_Comm   comm[]  = {MPI_COMM_NULL, MPI_COMM_NULL};
 254     real     * rdata;
 255     t_complex* cdata;
 256     ivec       local_ndata, offset, rsize, csize, complex_order;
 257
 258     gmx_parallel_3dfft_init(&fft_, ndata, &rdata, &cdata,
 259                             comm, TRUE, 1);
 260
 261     gmx_parallel_3dfft_real_limits(fft_, local_ndata, offset, rsize);
 262     gmx_parallel_3dfft_complex_limits(fft_, complex_order,
 263                                       local_ndata, offset, csize);
 264     checker_.checkVector(rsize, "rsize");
 265     checker_.checkVector(csize, "csize");
 266     int size = csize[0]*csize[1]*csize[2];
 267
 268     memcpy(rdata, inputdata, size*sizeof(t_complex));
 269     gmx_parallel_3dfft_execute(fft_, GMX_FFT_REAL_TO_COMPLEX, 0, NULL);
 270     //TODO use std::complex and add checkComplex for it
 271     checker_.checkSequenceArray(size*2,
 272                                 reinterpret_cast<real*>(cdata), "forward");
 273
 274     memcpy(cdata, inputdata, size*sizeof(t_complex));
 275     gmx_parallel_3dfft_execute(fft_, GMX_FFT_COMPLEX_TO_REAL, 0, NULL);
 276     for (int i = 0; i < ndata[0]*ndata[1]; i++) //check sequence but skip unused data
 277     {
 278         checker_.checkSequenceArray(ndata[2], rdata+i*rsize[2],
 279                                     gmx::formatString("backward %d", i).c_str());
 280     }
 281 }
 282
 283 } // namespace