LORENE
FFT991/citcossinci.C
1 /*
2  * Copyright (c) 1999-2001 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 inverse cos((2*l+1)*theta) ou sin(2*l*theta) (suivant la
27  * parite de l'indice m en phi) sur le deuxieme indice (theta)
28  * d'un tableau 3-D representant une fonction antisymetrique par rapport
29  * au plan z=0.
30  * Utilise la routine FFT Fortran FFT991
31  *
32  * Entree:
33  * -------
34  * int* deg : tableau du nombre effectif de degres de liberte dans chacune
35  * des 3 dimensions: le nombre de points de collocation
36  * en theta est nt = deg[1] et doit etre de la forme
37  * nt = 2^p 3^q 5^r + 1
38  * int* dimc : tableau du nombre d'elements de cf dans chacune des trois
39  * dimensions.
40  * On doit avoir dimc[1] >= deg[1] = nt.
41  *
42  * double* cf : tableau des coefficients c_l de la fonction definis
43  * comme suit (a r et phi fixes)
44  *
45  * pour m pair:
46  * f(theta) = som_{l=0}^{nt-2} c_l cos( (2 l+1) theta ) .
47  * pour m impair:
48  * f(theta) = som_{l=0}^{nt-2} c_l sin( 2 l theta ) .
49  *
50  * L'espace memoire correspondant a ce
51  * pointeur doit etre dimc[0]*dimc[1]*dimc[2] et doit
52  * avoir ete alloue avant l'appel a la routine.
53  * Le coefficient c_l (0 <= l <= nt-1) doit etre stoke dans
54  * le tableau cf comme suit
55  * c_l = cf[ dimc[1]*dimc[2] * j + k + dimc[2] * l ]
56  * ou j et k sont les indices correspondant a
57  * phi et r respectivement.
58  *
59  * int* dimf : tableau du nombre d'elements de ff dans chacune des trois
60  * dimensions.
61  * On doit avoir dimf[1] >= deg[1] = nt.
62  *
63  * Sortie:
64  * -------
65  * double* ff : tableau des valeurs de la fonction aux nt points de
66  * de collocation
67  *
68  * theta_l = pi/2 l/(nt-1) 0 <= l <= nt-1
69  *
70  * L'espace memoire correspondant a ce
71  * pointeur doit etre dimf[0]*dimf[1]*dimf[2] et doit
72  * avoir ete alloue avant l'appel a la routine.
73  * Les valeurs de la fonction sont stokees
74  * dans le tableau ff comme suit
75  * f( theta_l ) = ff[ dimf[1]*dimf[2] * j + k + dimf[2] * l ]
76  * ou j et k sont les indices correspondant a
77  * phi et r respectivement.
78  *
79  * NB: Si le pointeur cf est egal a ff, la routine ne travaille que sur un
80  * seul tableau, qui constitue une entree/sortie.
81  *
82  */
83 
84 /*
85  * $Id: citcossinci.C,v 1.5 2016/12/05 16:18:04 j_novak Exp $
86  * $Log: citcossinci.C,v $
87  * Revision 1.5 2016/12/05 16:18:04 j_novak
88  * Suppression of some global variables (file names, loch, ...) to prevent redefinitions
89  *
90  * Revision 1.4 2014/10/15 12:48:22 j_novak
91  * Corrected namespace declaration.
92  *
93  * Revision 1.3 2014/10/13 08:53:17 j_novak
94  * Lorene classes and functions now belong to the namespace Lorene.
95  *
96  * Revision 1.2 2014/10/06 15:18:46 j_novak
97  * Modified #include directives to use c++ syntax.
98  *
99  * Revision 1.1 2004/12/21 17:06:01 j_novak
100  * Added all files for using fftw3.
101  *
102  * Revision 1.4 2003/01/31 10:31:23 e_gourgoulhon
103  * Suppressed the directive #include <malloc.h> for malloc is defined
104  * in <stdlib.h>
105  *
106  * Revision 1.3 2002/10/16 14:36:53 j_novak
107  * Reorganization of #include instructions of standard C++, in order to
108  * use experimental version 3 of gcc.
109  *
110  * Revision 1.2 2002/09/09 13:00:40 e_gourgoulhon
111  * Modification of declaration of Fortran 77 prototypes for
112  * a better portability (in particular on IBM AIX systems):
113  * All Fortran subroutine names are now written F77_* and are
114  * defined in the new file C++/Include/proto_f77.h.
115  *
116  * Revision 1.1.1.1 2001/11/20 15:19:28 e_gourgoulhon
117  * LORENE
118  *
119  * Revision 2.0 1999/02/22 15:42:35 hyc
120  * *** empty log message ***
121  *
122  *
123  * $Header: /cvsroot/Lorene/C++/Source/Non_class_members/Coef/FFT991/citcossinci.C,v 1.5 2016/12/05 16:18:04 j_novak Exp $
124  *
125  */
126 
127 // headers du C
128 #include <cstdlib>
129 #include <cassert>
130 
131 // Prototypes of F77 subroutines
132 #include "headcpp.h"
133 #include "proto_f77.h"
134 
135 // Prototypage des sous-routines utilisees:
136 namespace Lorene {
137 int* facto_ini(int ) ;
138 double* trigo_ini(int ) ;
139 double* cheb_ini(const int) ;
140 double* chebimp_ini(const int ) ;
141 //*****************************************************************************
142 
143 void citcossinci(const int* deg, const int* dimc, double* cf, const int* dimf,
144  double* ff)
145 {
146 
147 int i, j, k ;
148 
149 // Dimensions des tableaux ff et cf :
150  int n1f = dimf[0] ;
151  int n2f = dimf[1] ;
152  int n3f = dimf[2] ;
153  int n1c = dimc[0] ;
154  int n2c = dimc[1] ;
155  int n3c = dimc[2] ;
156 
157 // Nombres de degres de liberte en theta :
158  int nt = deg[1] ;
159 
160 // Tests de dimension:
161  if (nt > n2f) {
162  cout << "citcossinci: nt > n2f : nt = " << nt << " , n2f = "
163  << n2f << endl ;
164  abort () ;
165  }
166  if (nt > n2c) {
167  cout << "citcossinci: nt > n2c : nt = " << nt << " , n2c = "
168  << n2c << endl ;
169  abort () ;
170  }
171  if (n1c > n1f) {
172  cout << "citcossinci: n1c > n1f : n1c = " << n1c << " , n1f = "
173  << n1f << endl ;
174  abort () ;
175  }
176  if (n3c > n3f) {
177  cout << "citcossinci: n3c > n3f : n3c = " << n3c << " , n3f = "
178  << n3f << endl ;
179  abort () ;
180  }
181 
182 // Nombre de points pour la FFT:
183  int nm1 = nt - 1;
184  int nm1s2 = nm1 / 2;
185 
186 // Recherche des tables pour la FFT:
187  int* facto = facto_ini(nm1) ;
188  double* trigo = trigo_ini(nm1) ;
189 
190 // Recherche de la table des sin(psi) :
191  double* sinp = cheb_ini(nt);
192 
193 // Recherche de la table des points de collocations x_k = cos(theta_{nt-1-k}):
194  double* x = chebimp_ini(nt) ;
195 
196  // tableau de travail t1 et g
197  // (la dimension nm1+2 = nt+1 est exigee par la routine fft991)
198  double* g = (double*)( malloc( (nm1+2)*sizeof(double) ) ) ;
199  double* t1 = (double*)( malloc( (nm1+2)*sizeof(double) ) ) ;
200 
201 // Parametres pour la routine FFT991
202  int jump = 1 ;
203  int inc = 1 ;
204  int lot = 1 ;
205  int isign = 1 ;
206 
207 // boucle sur phi et r (les boucles vont resp. de 0 a dimf[0]-1
208 // et 0 a dimf[2])
209 
210  int n2n3f = n2f * n3f ;
211  int n2n3c = n2c * n3c ;
212 
213 //=======================================================================
214 // Cas m pair
215 //=======================================================================
216 
217  j = 0 ;
218 
219  while (j<n1f-1) { //le dernier coef en phi n'est pas considere
220  // (car nul)
221 
222 //-----------------------------------------------------------------------
223 // partie cos(m phi) avec m pair : transformation cos((2 l+1) theta) inverse
224 //-----------------------------------------------------------------------
225 
226  for (k=0; k<n3c; k++) {
227 
228  int i0 = n2n3c * j + k ; // indice de depart
229  double* cf0 = cf + i0 ; // tableau des donnees a transformer
230 
231  i0 = n2n3f * j + k ; // indice de depart
232  double* ff0 = ff + i0 ; // tableau resultat
233 
234 // Calcul des coefficients du developpement en T_{2i}(x) de la fonction
235 // h(x) := x f(x) (x=cos(theta)) a partir des coefficients de f
236 // (resultat stoke dans le tableau t1 :
237  t1[0] = .5 * cf0[0] ;
238  for (i=1; i<nm1; i++) t1[i] = .5 * ( cf0[n3c*i] + cf0[n3c*(i-1)] ) ;
239  t1[nm1] = .5 * cf0[n3c*(nt-2)] ;
240 
241 /*
242  * NB: dans les commentaires qui suivent, psi designe la variable de [0, pi]
243  * reliee a theta par psi = 2 theta et F(psi) = f(theta(psi)).
244  */
245 
246 // Calcul des coefficients de Fourier de la fonction
247 // G(psi) = F+(psi) + F_(psi) sin(psi)
248 // en fonction des coefficients en cos(2l theta) de f:
249 
250 // Coefficients impairs de G
251 //--------------------------
252 
253  double c1 = t1[1] ;
254 
255  double som = 0;
256  ff0[n3f] = 0 ;
257  for ( i = 3; i < nt; i += 2 ) {
258  ff0[ n3f*i ] = t1[i] - c1 ;
259  som += ff0[ n3f*i ] ;
260  }
261 
262 // Valeur en psi=0 de la partie antisymetrique de F, F_ :
263  double fmoins0 = nm1s2 * c1 + som ;
264 
265 // Coef. impairs de G
266 // NB: le facteur 0.25 est du a la normalisation de fft991; si fft991
267 // donnait exactement les coef. des sinus, ce facteur serait -0.5.
268  g[1] = 0 ;
269  for ( i = 3; i < nt; i += 2 ) {
270  g[i] = 0.25 * ( ff0[ n3f*i ] - ff0[ n3f*(i-2) ] ) ;
271  }
272  g[nt] = 0 ;
273 
274 
275 // Coefficients pairs de G
276 //------------------------
277 // Ces coefficients sont egaux aux coefficients pairs du developpement de
278 // f.
279 // NB: le facteur 0.5 est du a la normalisation de fft991; si fft991
280 // donnait exactement les coef. des cosinus, ce facteur serait 1.
281 
282  g[0] = t1[0] ;
283  for (i=2; i<nm1; i += 2 ) g[i] = 0.5 * t1[i] ;
284  g[nm1] = t1[nm1] ;
285 
286 // Transformation de Fourier inverse de G
287 //---------------------------------------
288 
289 // FFT inverse
290  F77_fft991( g, t1, trigo, facto, &inc, &jump, &nm1, &lot, &isign) ;
291 
292 // Valeurs de f deduites de celles de G
293 //-------------------------------------
294 
295  for ( i = 1; i < nm1s2 ; i++ ) {
296 // ... indice du pt symetrique de psi par rapport a pi/2:
297  int isym = nm1 - i ;
298 
299  double fp = 0.5 * ( g[i] + g[isym] ) ;
300  double fm = 0.5 * ( g[i] - g[isym] ) / sinp[i] ;
301  ff0[ n3f*i ] = ( fp + fm ) / x[isym] ;
302  ff0[ n3f*isym ] = ( fp - fm ) / x[i] ;
303  }
304 
305 //... cas particuliers:
306  ff0[0] = g[0] + fmoins0 ;
307  ff0[ n3f*nm1 ] = 0 ;
308  ff0[ n3f*nm1s2 ] = g[nm1s2] / x[nm1s2] ;
309 
310 
311  } // fin de la boucle sur r
312 
313 //-----------------------------------------------------------------------
314 // partie sin(m phi) avec m pair : transformation cos((2 l+1) theta) inverse
315 //-----------------------------------------------------------------------
316 
317  j++ ;
318 
319  if ( (j != 1) && (j != n1f-1 ) ) {
320 // on effectue le calcul seulement dans les cas ou les coef en phi ne sont
321 // pas nuls
322 
323  for (k=0; k<n3c; k++) {
324 
325  int i0 = n2n3c * j + k ; // indice de depart
326  double* cf0 = cf + i0 ; // tableau des donnees a transformer
327 
328  i0 = n2n3f * j + k ; // indice de depart
329  double* ff0 = ff + i0 ; // tableau resultat
330 
331 // Calcul des coefficients du developpement en T_{2i}(x) de la fonction
332 // h(x) := x f(x) (x=cos(theta)) a partir des coefficients de f
333 // (resultat stoke dans le tableau t1 :
334  t1[0] = .5 * cf0[0] ;
335  for (i=1; i<nm1; i++) t1[i] = .5 * ( cf0[n3c*i] + cf0[n3c*(i-1)] ) ;
336  t1[nm1] = .5 * cf0[n3c*(nt-2)] ;
337 
338 /*
339  * NB: dans les commentaires qui suivent, psi designe la variable de [0, pi]
340  * reliee a theta par psi = 2 theta et F(psi) = f(theta(psi)).
341  */
342 
343 // Calcul des coefficients de Fourier de la fonction
344 // G(psi) = F+(psi) + F_(psi) sin(psi)
345 // en fonction des coefficients en cos(2l theta) de f:
346 
347 // Coefficients impairs de G
348 //--------------------------
349 
350  double c1 = t1[1] ;
351 
352  double som = 0;
353  ff0[n3f] = 0 ;
354  for ( i = 3; i < nt; i += 2 ) {
355  ff0[ n3f*i ] = t1[i] - c1 ;
356  som += ff0[ n3f*i ] ;
357  }
358 
359 // Valeur en psi=0 de la partie antisymetrique de F, F_ :
360  double fmoins0 = nm1s2 * c1 + som ;
361 
362 // Coef. impairs de G
363 // NB: le facteur 0.25 est du a la normalisation de fft991; si fft991
364 // donnait exactement les coef. des sinus, ce facteur serait -0.5.
365  g[1] = 0 ;
366  for ( i = 3; i < nt; i += 2 ) {
367  g[i] = 0.25 * ( ff0[ n3f*i ] - ff0[ n3f*(i-2) ] ) ;
368  }
369  g[nt] = 0 ;
370 
371 
372 // Coefficients pairs de G
373 //------------------------
374 // Ces coefficients sont egaux aux coefficients pairs du developpement de
375 // f.
376 // NB: le facteur 0.5 est du a la normalisation de fft991; si fft991
377 // donnait exactement les coef. des cosinus, ce facteur serait 1.
378 
379  g[0] = t1[0] ;
380  for (i=2; i<nm1; i += 2 ) g[i] = 0.5 * t1[i] ;
381  g[nm1] = t1[nm1] ;
382 
383 // Transformation de Fourier inverse de G
384 //---------------------------------------
385 
386 // FFT inverse
387  F77_fft991( g, t1, trigo, facto, &inc, &jump, &nm1, &lot, &isign) ;
388 
389 // Valeurs de f deduites de celles de G
390 //-------------------------------------
391 
392  for ( i = 1; i < nm1s2 ; i++ ) {
393 // ... indice du pt symetrique de psi par rapport a pi/2:
394  int isym = nm1 - i ;
395 
396  double fp = 0.5 * ( g[i] + g[isym] ) ;
397  double fm = 0.5 * ( g[i] - g[isym] ) / sinp[i] ;
398  ff0[ n3f*i ] = ( fp + fm ) / x[isym] ;
399  ff0[ n3f*isym ] = ( fp - fm ) / x[i] ;
400  }
401 
402 //... cas particuliers:
403  ff0[0] = g[0] + fmoins0 ;
404  ff0[ n3f*nm1 ] = 0 ;
405  ff0[ n3f*nm1s2 ] = g[nm1s2] / x[nm1s2] ;
406 
407 
408  } // fin de la boucle sur r
409 
410  } // fin du cas ou le calcul etait necessaire (i.e. ou les
411  // coef en phi n'etaient pas nuls)
412 
413 // On passe au cas m pair suivant:
414  j+=3 ;
415 
416  } // fin de la boucle sur les cas m pair
417 
418 //##
419  if (n1f<=3) { // cas m=0 seulement (symetrie axiale)
420  free (t1) ;
421  free (g) ;
422  return ;
423  }
424 
425 //=======================================================================
426 // Cas m impair
427 //=======================================================================
428 
429  j = 2 ;
430 
431  while (j<n1f-1) { //le dernier coef en phi n'est pas considere
432  // (car nul)
433 
434 //--------------------------------------------------------------------------
435 // partie cos(m phi) avec m impair : transformation sin((2 l) theta) inv.
436 //--------------------------------------------------------------------------
437 
438  for (k=0; k<n3c; k++) {
439 
440  int i0 = n2n3c * j + k ; // indice de depart
441  double* cf0 = cf + i0 ; // tableau des donnees a transformer
442 
443  i0 = n2n3f * j + k ; // indice de depart
444  double* ff0 = ff + i0 ; // tableau resultat
445 
446 
447 /*
448  * NB: dans les commentaires qui suivent, psi designe la variable de [0, pi]
449  * reliee a theta par psi = 2 theta et F(psi) = f(theta(psi)).
450  */
451 
452 
453 // Calcul des coefficients de Fourier de la fonction
454 // G(psi) = F+(psi) + F_(psi) sin(psi)
455 // en fonction des coefficients en sin(2l theta) de f:
456 
457 // Coefficients en sinus de G
458 //---------------------------
459 // Ces coefficients sont egaux aux coefficients pairs du developmt. en
460 // sin(2l theta) de f (le facteur -.5 vient de la normalisation
461 // de fft991: si fft991 donnait reellement les coefficients en sinus,
462 // il faudrait le remplacer par un +1) :
463 
464  g[1] = 0. ;
465  for (i=2; i<nm1; i += 2 ) g[i+1] = - .5 * cf0[n3c*i] ;
466  g[nt] = 0. ;
467 
468 
469 // Coefficients en cosinus de G
470 //-----------------------------
471 // Ces coefficients se deduisent des coefficients impairs du developmt.
472 // en sin(2l theta) de f (le facteur +.25 vient de la normalisation
473 // de fft991: si fft991 donnait reellement les coefficients en cosinus,
474 // il faudrait le remplacer par un +.5)
475 
476  g[0] = .5 * cf0[n3c] ;
477  for ( i = 3; i < nt; i += 2 ) {
478  g[i-1] = .25 * ( cf0[ n3c*i ] - cf0[ n3c*(i-2) ] ) ;
479  }
480  g[nm1] = - .5 * cf0[ n3c*(nt-2) ] ;
481 
482 
483 // Transformation de Fourier inverse de G
484 //---------------------------------------
485 
486 // FFT inverse
487  F77_fft991( g, t1, trigo, facto, &inc, &jump, &nm1, &lot, &isign) ;
488 
489 // Valeurs de f deduites de celles de G
490 //-------------------------------------
491 
492  for ( i = 1; i < nm1s2 ; i++ ) {
493 // ... indice du pt symetrique de psi par rapport a pi/2:
494  int isym = nm1 - i ;
495 
496  double fp = 0.5 * ( g[i] + g[isym] ) / sinp[i] ;
497  double fm = 0.5 * ( g[i] - g[isym] ) ;
498  ff0[ n3f*i ] = fp + fm ;
499  ff0[ n3f*isym ] = fp - fm ;
500  }
501 
502 //... cas particuliers:
503  ff0[0] = 0. ;
504  ff0[ n3f*nm1 ] = -2. * g[0] ;
505  ff0[ n3f*nm1s2 ] = g[nm1s2] ;
506 
507 
508  } // fin de la boucle sur r
509 
510 
511 //--------------------------------------------------------------------------
512 // partie sin(m phi) avec m impair : transformation sin( (2 l) theta) inv.
513 //--------------------------------------------------------------------------
514 
515  j++ ;
516 
517  if ( j != n1f-1 ) {
518 // on effectue le calcul seulement dans les cas ou les coef en phi ne sont
519 // pas nuls
520 
521  for (k=0; k<n3c; k++) {
522 
523  int i0 = n2n3c * j + k ; // indice de depart
524  double* cf0 = cf + i0 ; // tableau des donnees a transformer
525 
526  i0 = n2n3f * j + k ; // indice de depart
527  double* ff0 = ff + i0 ; // tableau resultat
528 
529 
530 /*
531  * NB: dans les commentaires qui suivent, psi designe la variable de [0, pi]
532  * reliee a theta par psi = 2 theta et F(psi) = f(theta(psi)).
533  */
534 
535 
536 // Calcul des coefficients de Fourier de la fonction
537 // G(psi) = F+(psi) + F_(psi) sin(psi)
538 // en fonction des coefficients en sin(2l theta) de f:
539 
540 // Coefficients en sinus de G
541 //---------------------------
542 // Ces coefficients sont egaux aux coefficients pairs du developmt. en
543 // sin(2l theta) de f (le facteur -.5 vient de la normalisation
544 // de fft991: si fft991 donnait reellement les coefficients en sinus,
545 // il faudrait le remplacer par un +1) :
546 
547  g[1] = 0. ;
548  for (i=2; i<nm1; i += 2 ) g[i+1] = - .5 * cf0[n3c*i] ;
549  g[nt] = 0. ;
550 
551 
552 // Coefficients en cosinus de G
553 //-----------------------------
554 // Ces coefficients se deduisent des coefficients impairs du developmt.
555 // en sin(2l theta) de f (le facteur +.25 vient de la normalisation
556 // de fft991: si fft991 donnait reellement les coefficients en cosinus,
557 // il faudrait le remplacer par un +.5)
558 
559  g[0] = .5 * cf0[n3c] ;
560  for ( i = 3; i < nt; i += 2 ) {
561  g[i-1] = .25 * ( cf0[ n3c*i ] - cf0[ n3c*(i-2) ] ) ;
562  }
563  g[nm1] = - .5 * cf0[ n3c*(nt-2) ] ;
564 
565 
566 // Transformation de Fourier inverse de G
567 //---------------------------------------
568 
569 // FFT inverse
570  F77_fft991( g, t1, trigo, facto, &inc, &jump, &nm1, &lot, &isign) ;
571 
572 // Valeurs de f deduites de celles de G
573 //-------------------------------------
574 
575  for ( i = 1; i < nm1s2 ; i++ ) {
576 // ... indice du pt symetrique de psi par rapport a pi/2:
577  int isym = nm1 - i ;
578 
579  double fp = 0.5 * ( g[i] + g[isym] ) / sinp[i] ;
580  double fm = 0.5 * ( g[i] - g[isym] ) ;
581  ff0[ n3f*i ] = fp + fm ;
582  ff0[ n3f*isym ] = fp - fm ;
583  }
584 
585 //... cas particuliers:
586  ff0[0] = 0. ;
587  ff0[ n3f*nm1 ] = -2. * g[0] ;
588  ff0[ n3f*nm1s2 ] = g[nm1s2] ;
589 
590 
591  } // fin de la boucle sur r
592 
593 
594  } // fin du cas ou le calcul etait necessaire (i.e. ou les
595  // coef en phi n'etaient pas nuls)
596 
597 // On passe au cas m impair suivant:
598  j+=3 ;
599 
600  } // fin de la boucle sur les cas m impair
601 
602  // Menage
603  free (t1) ;
604  free (g) ;
605 
606 }
607 }
Lorene
Lorene prototypes.
Definition: app_hor.h:67