xref: /petsc/src/mat/tests/ex228.c (revision 9566063d113dddea24716c546802770db7481bc0)
1c4762a1bSJed Brown static char help[] = "Test duplication/destruction of FFTW vecs \n\n";
2c4762a1bSJed Brown 
3c4762a1bSJed Brown /*
4c4762a1bSJed Brown  Compiling the code:
5c4762a1bSJed Brown    This code uses the FFTW interface.
6c4762a1bSJed Brown    Use one of the options below to configure:
7c4762a1bSJed Brown    --with-fftw-dir=/.... or --download-fftw
8c4762a1bSJed Brown  Usage:
9c4762a1bSJed Brown    mpiexec -np <np> ./ex228
10c4762a1bSJed Brown */
11c4762a1bSJed Brown 
12c4762a1bSJed Brown #include <petscmat.h>
13c4762a1bSJed Brown int main(int argc,char **args)
14c4762a1bSJed Brown {
15c4762a1bSJed Brown   Mat            A;         /* FFT Matrix */
16c4762a1bSJed Brown   Vec            x,y,z;     /* Work vectors */
17c4762a1bSJed Brown   Vec            x1,y1,z1;  /* Duplicate vectors */
18c4762a1bSJed Brown   PetscInt       i,k;       /* for iterating over dimensions */
19c4762a1bSJed Brown   PetscRandom    rdm;       /* for creating random input */
20c4762a1bSJed Brown   PetscScalar    a;         /* used to scale output */
21c4762a1bSJed Brown   PetscReal      enorm;     /* norm for sanity check */
22c4762a1bSJed Brown   PetscInt       n=10,N=1;  /* FFT dimension params */
23c4762a1bSJed Brown   PetscInt       DIM,dim[5];/* FFT params */
24c4762a1bSJed Brown 
25*9566063dSJacob Faibussowitsch   PetscCall(PetscInitialize(&argc,&args,(char*)0,help));
26*9566063dSJacob Faibussowitsch   PetscCall(PetscOptionsGetInt(NULL,NULL,"-n",&n,NULL));
27c4762a1bSJed Brown 
28c4762a1bSJed Brown   /* To create random input vector */
29*9566063dSJacob Faibussowitsch   PetscCall(PetscRandomCreate(PETSC_COMM_SELF, &rdm));
30*9566063dSJacob Faibussowitsch   PetscCall(PetscRandomSetFromOptions(rdm));
31c4762a1bSJed Brown 
32c4762a1bSJed Brown   /* Iterate over dimensions, use PETSc-FFTW interface */
33c4762a1bSJed Brown   for (i=1; i<5; i++) {
34c4762a1bSJed Brown     DIM = i;
35c4762a1bSJed Brown     N = 1;
36c4762a1bSJed Brown     for (k=0; k<i; k++){dim[k] = n; N*=n;}
37c4762a1bSJed Brown 
38*9566063dSJacob Faibussowitsch     PetscCall(PetscPrintf(PETSC_COMM_WORLD, "\n %" PetscInt_FMT " dimensions: FFTW on vector of size %" PetscInt_FMT " \n",DIM,N));
39c4762a1bSJed Brown 
40c4762a1bSJed Brown     /* create FFTW object */
41*9566063dSJacob Faibussowitsch     PetscCall(MatCreateFFT(PETSC_COMM_SELF,DIM,dim,MATFFTW,&A));
42c4762a1bSJed Brown     /* create vectors of length N */
43*9566063dSJacob Faibussowitsch     PetscCall(MatCreateVecsFFTW(A,&x,&y,&z));
44c4762a1bSJed Brown 
45*9566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject) x, "Real space vector"));
46*9566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject) y, "Frequency space vector"));
47*9566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject) z, "Reconstructed vector"));
48c4762a1bSJed Brown 
49c4762a1bSJed Brown     /* Test vector duplication*/
50*9566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(x,&x1));
51*9566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(y,&y1));
52*9566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(z,&z1));
53c4762a1bSJed Brown 
54c4762a1bSJed Brown     /* Set values of space vector x, copy to duplicate */
55*9566063dSJacob Faibussowitsch     PetscCall(VecSetRandom(x,rdm));
56*9566063dSJacob Faibussowitsch     PetscCall(VecCopy(x,x1));
57c4762a1bSJed Brown 
58c4762a1bSJed Brown     /* Apply FFTW_FORWARD and FFTW_BACKWARD */
59*9566063dSJacob Faibussowitsch     PetscCall(MatMult(A,x,y));
60*9566063dSJacob Faibussowitsch     PetscCall(MatMultTranspose(A,y,z));
61c4762a1bSJed Brown 
62c4762a1bSJed Brown     /* Apply FFTW_FORWARD and FFTW_BACKWARD for duplicate vecs */
63*9566063dSJacob Faibussowitsch     PetscCall(MatMult(A,x1,y1));
64*9566063dSJacob Faibussowitsch     PetscCall(MatMultTranspose(A,y1,z1));
65c4762a1bSJed Brown 
66c4762a1bSJed Brown     /* Compare x and z1. FFTW computes an unnormalized DFT, thus z1 = N*x */
67c4762a1bSJed Brown     a    = 1.0/(PetscReal)N;
68*9566063dSJacob Faibussowitsch     PetscCall(VecScale(z1,a));
69*9566063dSJacob Faibussowitsch     PetscCall(VecAXPY(z1,-1.0,x));
70*9566063dSJacob Faibussowitsch     PetscCall(VecNorm(z1,NORM_1,&enorm));
71*9566063dSJacob Faibussowitsch     if (enorm > 1.e-9) PetscCall(PetscPrintf(PETSC_COMM_WORLD,"  Error norm of |x - z1| %g\n",enorm));
72c4762a1bSJed Brown 
73c4762a1bSJed Brown     /* free spaces */
74*9566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&x1));
75*9566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&y1));
76*9566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&z1));
77*9566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&x));
78*9566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&y));
79*9566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&z));
80*9566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&A));
81c4762a1bSJed Brown   }
82c4762a1bSJed Brown 
83*9566063dSJacob Faibussowitsch   PetscCall(PetscRandomDestroy(&rdm));
84*9566063dSJacob Faibussowitsch   PetscCall(PetscFinalize());
85b122ec5aSJacob Faibussowitsch   return 0;
86c4762a1bSJed Brown }
87c4762a1bSJed Brown 
88c4762a1bSJed Brown /*TEST
89c4762a1bSJed Brown 
90c4762a1bSJed Brown     build:
91c4762a1bSJed Brown       requires: fftw complex
92c4762a1bSJed Brown 
93c4762a1bSJed Brown     test:
94c4762a1bSJed Brown       suffix: 2
95c4762a1bSJed Brown       nsize : 4
96c4762a1bSJed Brown       args: -mat_fftw_plannerflags FFTW_ESTIMATE -n 16
97c4762a1bSJed Brown 
98c4762a1bSJed Brown     test:
99c4762a1bSJed Brown       suffix: 3
100c4762a1bSJed Brown       nsize : 2
101c4762a1bSJed Brown       args: -mat_fftw_plannerflags FFTW_MEASURE -n 12
102c4762a1bSJed Brown 
103c4762a1bSJed Brown     test:
104c4762a1bSJed Brown       suffix: 4
105c4762a1bSJed Brown       nsize : 2
106c4762a1bSJed Brown       args: -mat_fftw_plannerflags FFTW_PATIENT -n 10
107c4762a1bSJed Brown 
108c4762a1bSJed Brown     test:
109c4762a1bSJed Brown       suffix: 5
110c4762a1bSJed Brown       nsize : 1
111c4762a1bSJed Brown       args: -mat_fftw_plannerflags FFTW_EXHAUSTIVE -n 5
112c4762a1bSJed Brown 
113c4762a1bSJed Brown TEST*/
114