LORENE
FFT991/circhebp.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 char circhebp_C[] = "$Header: /cvsroot/Lorene/C++/Source/Non_class_members/Coef/FFT991/circhebp.C,v 1.4 2014/10/15 12:48:21 j_novak Exp $" ;
24 
25 
26 /*
27  * Transformation de Tchebyshev inverse (cas rare) sur le troisieme indice
28  * (indice correspondant a r) d'un tableau 3-D decrivant une fonction paire.
29  * Utilise la routine FFT Fortran FFT991
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 r est nr = deg[2] et doit etre de la forme
36  * nr = 2^p 3^q 5^r + 1
37  * int* dimc : tableau du nombre d'elements de cf dans chacune des trois
38  * dimensions.
39  * On doit avoir dimc[2] >= deg[2] = nr.
40  * NB: pour dimc[0] = 1 (un seul point en phi), la transformation
41  * est bien effectuee.
42  * pour dimc[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 != dimc[0]-1 (cf. commentaires sur borne_phi).
45  *
46  * double* cf : tableau des coefficients c_i de la fonction definis
47  * comme suit (a theta et phi fixes)
48  *
49  * f(x) = som_{i=0}^{nr-1} c_i T_{2i}(x) ,
50  *
51  * ou T_{2i}(x) designe le polynome de Tchebyshev de degre 2i.
52  * Les coefficients c_i (0 <= i <= nr-1) doivent etre stokes
53  * dans le tableau cf comme suit
54  * c_i = cf[ dimc[1]*dimc[2] * j + dimc[2] * k + i ]
55  * ou j et k sont les indices correspondant a phi et theta
56  * respectivement.
57  * L'espace memoire correspondant a ce pointeur doit etre
58  * dimc[0]*dimc[1]*dimc[2] et doit etre alloue avant l'appel a
59  * la routine.
60  *
61  * int* dimf : tableau du nombre d'elements de ff dans chacune des trois
62  * dimensions.
63  * On doit avoir dimf[2] >= deg[2] = nr.
64  *
65  * Sortie:
66  * -------
67  * double* ff : tableau des valeurs de la fonction aux nr points de
68  * de collocation
69  *
70  * x_i = sin( pi/2 i/(nr-1) ) 0 <= i <= nr-1
71  *
72  * Les valeurs de la fonction sont stokees dans le
73  * tableau ff comme suit
74  * f( x_i ) = ff[ dimf[1]*dimf[2] * j + dimf[2] * k + i ]
75  * ou j et k sont les indices correspondant a phi et theta
76  * respectivement.
77  * L'espace memoire correspondant a ce pointeur doit etre
78  * dimf[0]*dimf[1]*dimf[2] et doit avoir ete alloue avant
79  * l'appel a la routine.
80  *
81  * NB: Si le pointeur cf est egal a ff, la routine ne travaille que sur un
82  * seul tableau, qui constitue une entree/sortie.
83  */
84 
85 /*
86  * $Id: circhebp.C,v 1.4 2014/10/15 12:48:21 j_novak Exp $
87  * $Log: circhebp.C,v $
88  * Revision 1.4 2014/10/15 12:48:21 j_novak
89  * Corrected namespace declaration.
90  *
91  * Revision 1.3 2014/10/13 08:53:16 j_novak
92  * Lorene classes and functions now belong to the namespace Lorene.
93  *
94  * Revision 1.2 2014/10/06 15:18:46 j_novak
95  * Modified #include directives to use c++ syntax.
96  *
97  * Revision 1.1 2004/12/21 17:06:01 j_novak
98  * Added all files for using fftw3.
99  *
100  * Revision 1.4 2003/01/31 10:31:23 e_gourgoulhon
101  * Suppressed the directive #include <malloc.h> for malloc is defined
102  * in <stdlib.h>
103  *
104  * Revision 1.3 2002/10/16 14:36:53 j_novak
105  * Reorganization of #include instructions of standard C++, in order to
106  * use experimental version 3 of gcc.
107  *
108  * Revision 1.2 2002/09/09 13:00:40 e_gourgoulhon
109  * Modification of declaration of Fortran 77 prototypes for
110  * a better portability (in particular on IBM AIX systems):
111  * All Fortran subroutine names are now written F77_* and are
112  * defined in the new file C++/Include/proto_f77.h.
113  *
114  * Revision 1.1.1.1 2001/11/20 15:19:29 e_gourgoulhon
115  * LORENE
116  *
117  * Revision 2.0 1999/02/22 15:43:29 hyc
118  * *** empty log message ***
119  *
120  *
121  * $Header: /cvsroot/Lorene/C++/Source/Non_class_members/Coef/FFT991/circhebp.C,v 1.4 2014/10/15 12:48:21 j_novak Exp $
122  *
123  */
124 
125 // headers du C
126 #include <cassert>
127 #include <cstdlib>
128 
129 #include "headcpp.h"
130 
131 // Prototypes of F77 subroutines
132 #include "proto_f77.h"
133 
134 // Prototypage des sous-routines utilisees:
135 namespace Lorene {
136 int* facto_ini(int ) ;
137 double* trigo_ini(int ) ;
138 double* cheb_ini(const int) ;
139 //*****************************************************************************
140 
141 void circhebp(const int* deg, const int* dimc, double* cf,
142  const int* dimf, double* ff)
143 
144 {
145 
146 int i, j, k ;
147 
148 // Dimensions des tableaux ff et cf :
149  int n1f = dimf[0] ;
150  int n2f = dimf[1] ;
151  int n3f = dimf[2] ;
152  int n1c = dimc[0] ;
153  int n2c = dimc[1] ;
154  int n3c = dimc[2] ;
155 
156 // Nombres de degres de liberte en r :
157  int nr = deg[2] ;
158 
159 // Tests de dimension:
160  if (nr > n3c) {
161  cout << "circhebp: nr > n3c : nr = " << nr << " , n3c = "
162  << n3c << endl ;
163  abort () ;
164  exit(-1) ;
165  }
166  if (nr > n3f) {
167  cout << "circhebp: nr > n3f : nr = " << nr << " , n3f = "
168  << n3f << endl ;
169  abort () ;
170  exit(-1) ;
171  }
172  if (n1c > n1f) {
173  cout << "circhebp: n1c > n1f : n1c = " << n1c << " , n1f = "
174  << n1f << endl ;
175  abort () ;
176  exit(-1) ;
177  }
178  if (n2c > n2f) {
179  cout << "circhebp: n2c > n2f : n2c = " << n2c << " , n2f = "
180  << n2f << endl ;
181  abort () ;
182  exit(-1) ;
183  }
184 
185 // Nombre de points pour la FFT:
186  int nm1 = nr - 1;
187  int nm1s2 = nm1 / 2;
188 
189 // Recherche des tables pour la FFT:
190  int* facto = facto_ini(nm1) ;
191  double* trigo = trigo_ini(nm1) ;
192 
193 // Recherche de la table des sin(psi) :
194  double* sinp = cheb_ini(nr);
195 
196  // tableau de travail t1 et g
197  // (la dimension nm1+2 = nr+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 theta
208 
209  int n2n3f = n2f * n3f ;
210  int n2n3c = n2c * n3c ;
211 
212 /*
213  * Borne de la boucle sur phi:
214  * si n1c = 1, on effectue la boucle une fois seulement.
215  * si n1c > 1, on va jusqu'a j = n1c-2 en sautant j = 1 (les coefficients
216  * j=n1c-1 et j=0 ne sont pas consideres car nuls).
217  */
218  int borne_phi = ( n1c > 1 ) ? n1c-1 : 1 ;
219 
220  for (j=0; j< borne_phi; j++) {
221 
222  if (j==1) continue ; // on ne traite pas le terme en sin(0 phi)
223 
224  for (k=0; k<n2c; k++) {
225 
226  int i0 = n2n3c * j + n3c * k ; // indice de depart
227  double* cf0 = cf + i0 ; // tableau des donnees a transformer
228 
229  i0 = n2n3f * j + n3f * k ; // indice de depart
230  double* ff0 = ff + i0 ; // tableau resultat
231 
232 /*
233  * NB: dans les commentaires qui suivent, psi designe la variable de [0, pi]
234  * reliee a x par x = cos(psi/2) et F(psi) = f(x(psi)).
235  */
236 
237 // Calcul des coefficients de Fourier de la fonction
238 // G(psi) = F+(psi) + F_(psi) sin(psi)
239 // en fonction des coefficients de Tchebyshev de f:
240 
241 // Coefficients impairs de G
242 //--------------------------
243 
244  double c1 = cf0[1] ;
245 
246  double som = 0;
247  ff0[1] = 0 ;
248  for ( i = 3; i < nr; i += 2 ) {
249  ff0[i] = cf0[i] - c1 ;
250  som += ff0[i] ;
251  }
252 
253 // Valeur en psi=0 de la partie antisymetrique de F, F_ :
254  double fmoins0 = nm1s2 * c1 + som ;
255 
256 // Coef. impairs de G
257 // NB: le facteur 0.25 est du a la normalisation de fft991; si fft991
258 // donnait exactement les coef. des sinus, ce facteur serait -0.5.
259  g[1] = 0 ;
260  for ( i = 3; i < nr; i += 2 ) {
261  g[i] = 0.25 * ( ff0[i] - ff0[i-2] ) ;
262  }
263  g[nr] = 0 ;
264 
265 
266 // Coefficients pairs de G
267 //------------------------
268 // Ces coefficients sont egaux aux coefficients pairs du developpement de
269 // f.
270 // NB: le facteur 0.5 est du a la normalisation de fft991; si fft991
271 // donnait exactement les coef. des cosinus, ce facteur serait 1.
272 
273  g[0] = cf0[0] ;
274  for (i=2; i<nm1; i += 2 ) g[i] = 0.5 * cf0[i] ;
275  g[nm1] = cf0[nm1] ;
276 
277 // Transformation de Fourier inverse de G
278 //---------------------------------------
279 
280 // FFT inverse
281  F77_fft991( g, t1, trigo, facto, &inc, &jump, &nm1, &lot, &isign) ;
282 
283 // Valeurs de f deduites de celles de G
284 //-------------------------------------
285 
286  for ( i = 1; i < nm1s2 ; i++ ) {
287 // ... indice (dans le tableau g) du pt symetrique de psi par rapport a pi/2:
288  int isym = nm1 - i ;
289 // ... indice (dans le tableau ff0) du point x correspondant a psi
290  int ix = nm1 - i ;
291 // ... indice (dans le tableau ff0) du point x correspondant a sym(psi)
292  int ixsym = nm1 - isym ;
293 
294  double fp = .5 * ( g[i] + g[isym] ) ;
295  double fm = .5 * ( g[i] - g[isym] ) / sinp[i] ;
296 
297  ff0[ix] = fp + fm ;
298  ff0[ixsym] = fp - fm ;
299  }
300 
301 //... cas particuliers:
302  ff0[0] = g[0] - fmoins0 ;
303  ff0[nm1] = g[0] + fmoins0 ;
304  ff0[nm1s2] = g[nm1s2] ;
305 
306  } // fin de la boucle sur theta
307  } // fin de la boucle sur phi
308 
309  // Menage
310  free (t1) ;
311  free (g) ;
312 
313 }
314 }
Lorene prototypes.
Definition: app_hor.h:64