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