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