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