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