LORENE
FFTW3/cftcos.C
1 /*
2  * Copyright (c) 1999-2002 Eric Gourgoulhon
3  * Copyright (c) 2002 Jerome Novak
4  *
5  * This file is part of LORENE.
6  *
7  * LORENE is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * LORENE is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with LORENE; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20  *
21  */
22 
23 /*
24  * Transformation en cos(l*theta) sur le deuxieme indice (theta)
25  * d'un tableau 3-D representant une fonction quelconque (theta
26  * varie entre 0 et pi).Utilise la bibliotheque fftw.
27  *
28  * Entree:
29  * -------
30  * int* deg : tableau du nombre effectif de degres de liberte dans chacune
31  * des 3 dimensions: le nombre de points de collocation
32  * en theta est nt = deg[1] et doit etre de la forme
33  * nt = 2*p + 1
34  * int* dimf : tableau du nombre d'elements de ff dans chacune des trois
35  * dimensions.
36  * On doit avoir dimf[1] >= deg[1] = nt.
37  * NB: pour dimf[0] = 1 (un seul point en phi), la transformation
38  * est bien effectuee.
39  * pour dimf[0] > 1 (plus d'un point en phi), la
40  * transformation n'est effectuee que pour les indices (en phi)
41  * j != 1 et j != dimf[0]-1 (cf. commentaires sur borne_phi).
42  *
43  * double* ff : tableau des valeurs de la fonction aux nt points de
44  * de collocation
45  *
46  * theta_l = pi l/(nt-1) 0 <= l <= nt-1
47  *
48  * L'espace memoire correspondant a ce
49  * pointeur doit etre dimf[0]*dimf[1]*dimf[2] et doit
50  * etre alloue avant l'appel a la routine.
51  * Les valeurs de la fonction doivent etre stokees
52  * dans le tableau ff comme suit
53  * f( theta_l ) = ff[ dimf[1]*dimf[2] * j + k + dimf[2] * l ]
54  * ou j et k sont les indices correspondant a
55  * phi et r respectivement.
56  *
57  * int* dimc : tableau du nombre d'elements de cc dans chacune des trois
58  * dimensions.
59  * On doit avoir dimc[1] >= deg[1] = nt.
60  * Sortie:
61  * -------
62  * double* cf : tableau des coefficients c_l de la fonction definis
63  * comme suit (a r et phi fixes)
64  *
65  * f(theta) = som_{l=0}^{nt-1} c_l cos( l theta ) .
66  *
67  * L'espace memoire correspondant a ce
68  * pointeur doit etre dimc[0]*dimc[1]*dimc[2] et doit
69  * etre alloue avant l'appel a la routine.
70  * Le coefficient c_l (0 <= l <= nt-1) est stoke dans
71  * le tableau cf comme suit
72  * c_l = cf[ dimc[1]*dimc[2] * j + k + dimc[2] * l ]
73  * ou j et k sont les indices correspondant a
74  * phi et r respectivement.
75  *
76  * NB: Si le pointeur ff est egal a cf, la routine ne travaille que sur un
77  * seul tableau, qui constitue une entree/sortie.
78  *
79  */
80 
81 char cftcos_C[] = "$Header: /cvsroot/Lorene/C++/Source/Non_class_members/Coef/FFTW3/cftcos.C,v 1.3 2014/10/13 08:53:18 j_novak Exp $" ;
82 
83 /*
84  * $Id: cftcos.C,v 1.3 2014/10/13 08:53:18 j_novak Exp $
85  * $Log: cftcos.C,v $
86  * Revision 1.3 2014/10/13 08:53:18 j_novak
87  * Lorene classes and functions now belong to the namespace Lorene.
88  *
89  * Revision 1.2 2014/10/06 15:18:48 j_novak
90  * Modified #include directives to use c++ syntax.
91  *
92  * Revision 1.1 2004/12/21 17:06:02 j_novak
93  * Added all files for using fftw3.
94  *
95  * Revision 1.3 2004/10/04 13:42:36 j_novak
96  * Using new and delete instead of malloc.
97  *
98  * Revision 1.2 2003/01/31 10:31:23 e_gourgoulhon
99  * Suppressed the directive #include <malloc.h> for malloc is defined
100  * in <stdlib.h>
101  *
102  * Revision 1.1 2002/11/12 17:43:53 j_novak
103  * Added transformatin functions for T_COS basis.
104  *
105  *
106  * $Header: /cvsroot/Lorene/C++/Source/Non_class_members/Coef/FFTW3/cftcos.C,v 1.3 2014/10/13 08:53:18 j_novak Exp $
107  *
108  */
109 
110 // headers du C
111 #include <cstdlib>
112 #include <fftw3.h>
113 
114 //Lorene prototypes
115 #include "tbl.h"
116 
117 // Prototypage des sous-routines utilisees:
118 namespace Lorene {
119 fftw_plan prepare_fft(int, Tbl*&) ;
120 double* cheb_ini(const int) ;
121 
122 //*****************************************************************************
123 
124 void cftcos(const int* deg, const int* dimf, double* ff, const int* dimc,
125  double* cf)
126 {
127 
128 int i, j, k ;
129 
130 // Dimensions des tableaux ff et cf :
131  int n1f = dimf[0] ;
132  int n2f = dimf[1] ;
133  int n3f = dimf[2] ;
134  int n1c = dimc[0] ;
135  int n2c = dimc[1] ;
136  int n3c = dimc[2] ;
137 
138 // Nombre de degres de liberte en theta :
139  int nt = deg[1] ;
140 
141 // Tests de dimension:
142  if (nt > n2f) {
143  cout << "cftcos: nt > n2f : nt = " << nt << " , n2f = "
144  << n2f << endl ;
145  abort () ;
146  exit(-1) ;
147  }
148  if (nt > n2c) {
149  cout << "cftcos: nt > n2c : nt = " << nt << " , n2c = "
150  << n2c << endl ;
151  abort () ;
152  exit(-1) ;
153  }
154  if (n1f > n1c) {
155  cout << "cftcos: n1f > n1c : n1f = " << n1f << " , n1c = "
156  << n1c << endl ;
157  abort () ;
158  exit(-1) ;
159  }
160  if (n3f > n3c) {
161  cout << "cftcos: n3f > n3c : n3f = " << n3f << " , n3c = "
162  << n3c << endl ;
163  abort () ;
164  exit(-1) ;
165  }
166 
167 // Nombre de points pour la FFT:
168  int nm1 = nt - 1;
169  int nm1s2 = nm1 / 2;
170 
171 // Recherche des tables pour la FFT:
172  Tbl* pg = 0x0 ;
173  fftw_plan p = prepare_fft(nm1, pg) ;
174  Tbl& g = *pg ;
175 
176 // Recherche de la table des sin(psi) :
177  double* sinp = cheb_ini(nt);
178 
179 // boucle sur phi et r (les boucles vont resp. de 0 a max(dimf[0]-2,0) et
180 // 0 a dimf[2]-1 )
181 
182  int n2n3f = n2f * n3f ;
183  int n2n3c = n2c * n3c ;
184 
185 /*
186  * Borne de la boucle sur phi:
187  * si n1f = 1, on effectue la boucle une fois seulement.
188  * si n1f > 1, on va jusqu'a j = n1f-2 en sautant j = 1 (les coefficients
189  * j=n1f-1 et j=0 ne sont pas consideres car nuls).
190  */
191  int borne_phi = ( n1f > 1 ) ? n1f-1 : 1 ;
192 
193  for (j=0; j< borne_phi; j++) {
194 
195  if (j==1) continue ; // on ne traite pas le terme en sin(0 phi)
196 
197  for (k=0; k<n3f; k++) {
198 
199  int i0 = n2n3f * j + k ; // indice de depart
200  double* ff0 = ff + i0 ; // tableau des donnees a transformer
201 
202  i0 = n2n3c * j + k ; // indice de depart
203  double* cf0 = cf + i0 ; // tableau resultat
204 
205 /*
206  * NB: dans les commentaires qui suivent, psi designe theta dans [0, pi]
207  */
208 
209 // Valeur en psi=0 de la partie antisymetrique de F, F_ :
210  double fmoins0 = 0.5 * ( ff0[0] - ff0[ n3f*nm1 ] );
211 
212 // Fonction G(psi) = F+(psi) + F_(psi) sin(psi)
213 //---------------------------------------------
214  for ( i = 1; i < nm1s2 ; i++ ) {
215 // ... indice (dans le tableau g) du pt symetrique de psi par rapport a pi/2:
216  int isym = nm1 - i ;
217 // ... indice (dans le tableau ff0) du point theta correspondant a psi
218  int ix = n3f * i ;
219 // ... indice (dans le tableau ff0) du point theta correspondant a sym(psi)
220  int ixsym = n3f * isym ;
221 // ... F+(psi)
222  double fp = 0.5 * ( ff0[ix] + ff0[ixsym] ) ;
223 // ... F_(psi) sin(psi)
224  double fms = 0.5 * ( ff0[ix] - ff0[ixsym] ) * sinp[i] ;
225  g.set(i) = fp + fms ;
226  g.set(isym) = fp - fms ;
227  }
228 //... cas particuliers:
229  g.set(0) = 0.5 * ( ff0[0] + ff0[ n3f*nm1 ] );
230  g.set(nm1s2) = ff0[ n3f*nm1s2 ];
231 
232 // Developpement de G en series de Fourier par une FFT
233 //----------------------------------------------------
234 
235  fftw_execute(p) ;
236 
237 // Coefficients pairs du developmt. cos(l theta) de f
238 //----------------------------------------------------
239 // Ces coefficients sont egaux aux coefficients en cosinus du developpement
240 // de G en series de Fourier (le facteur 2/nm1 vient de la normalisation
241 // de fftw) :
242 
243  double fac = 2./double(nm1) ;
244  cf0[0] = g(0) / double(nm1) ;
245  for (i=2; i<nm1; i += 2 ) cf0[n3c*i] = fac*g(i/2) ;
246  cf0[n3c*nm1] = g(nm1s2) / double(nm1) ;
247 
248 // Coefficients impairs du developmt. en cos(l theta) de f
249 //---------------------------------------------------------
250 // 1. Coef. c'_k (recurrence amorcee a partir de zero):
251 // Le 4/nm1 en facteur de g[i] est du a la normalisation de fftw
252 // (si fftw donnait reellement les coef. en sinus, il faudrait le
253 // remplacer par un -2.)
254  fac *= 2. ;
255  cf0[n3c] = 0 ;
256  double som = 0;
257  for ( i = 3; i < nt; i += 2 ) {
258  cf0[n3c*i] = cf0[n3c*(i-2)] + fac * g(nm1 - i/2) ;
259  som += cf0[n3c*i] ;
260  }
261 
262 // 2. Calcul de c_1 :
263  double c1 = ( fmoins0 - som ) / nm1s2 ;
264 
265 // 3. Coef. c_k avec k impair:
266  cf0[n3c] = c1 ;
267  for ( i = 3; i < nt; i += 2 ) cf0[n3c*i] += c1 ;
268 
269 
270  } // fin de la boucle sur r
271  } // fin de la boucle sur phi
272 
273 }
274 }
275 
Lorene
Lorene prototypes.
Definition: app_hor.h:64